com.highqsoft.interfaces.fwk

Interface FwkAppearanceInterface

All Superinterfaces:

FwkInterface, java.io.Serializable

All Known Subinterfaces:

P2DAxisInterface, P2DChannelInterface, P2DComponentInterface, P2DImageInterface, P2DLayoutInterface, P2DLegendInterface, P2DMarkerInterface, P2DPlotInterface, P2DRainViewInterface, P2DShapeInterface, P2DTextInterface

All Known Implementing Classes:

FwkAppearance, P2DAxis, P2DChannel, P2DComponent, P2DImage, P2DLayout, P2DLegend, P2DMarker, P2DPlot, P2DRainView, P2DShape, P2DText, P2DTopLayout

public interface FwkAppearanceInterface
extends FwkInterface

The FwkAppearanceInterface defines the basic functionality of an appearance object.

Since:

$Date: 2017/04/06 13:29:08 $

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

Graphics2D

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.BasicStroke	DASH_STROKE The DASH stroke.
static java.awt.BasicStroke	DOT_DASH_STROKE The DOT DASH stroke.
static java.awt.BasicStroke	DOT_DOT_DASH_STROKE The DOT DOT DASH stroke.
static java.awt.BasicStroke	DOT_STROKE The DOT stroke.
static java.awt.BasicStroke	LINE_STROKE The line stroke.

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(java.awt.Graphics2D g) Configurate the graphical context with the settings of the appearance.
java.awt.Color	getBackgroundColor() Gets the background color for the Graphics2D context.
java.awt.Shape	getClip() Gets the clipping shape.
java.awt.Color	getColor() Gets this graphics context's current color to the specified color.
float[]	getDashArray() Returns the array representing the lengths of the dash segments.
float	getDashPhase() Returns the current dash phase.
int	getEndCap() Returns the end cap style.
java.awt.Shape	getFill() Gets the filling shape.
java.awt.Font	getFont() Gets this graphics context's font to the specified font.
int	getLineJoin() Returns the line join style.
float	getLineWidth() Returns the line width.
float	getMiterLimit() Returns the limit of miter joins.
java.awt.Stroke	getStroke() Gets the Stroke for the Graphics2D context.
java.awt.geom.AffineTransform	getTransform() Retruns the transform of the appearance.
java.awt.geom.Point2D	getTranslation() Get the translation vector.
float	getTransparency() Get the transparency of the current color (range 0 .. 1.0).
boolean	getVisible() Get the visibility.
boolean	isVisible() Returns a boolean whether the object is visible.
java.awt.BasicStroke	scaleStroke(java.awt.geom.AffineTransform at) Scale the line with.
java.awt.BasicStroke	scaleStroke(java.awt.geom.AffineTransform at, float lw) Scale the line with.
void	setBackgroundColor(java.awt.Color color) Sets the background color for the Graphics2D context.
void	setClip(double x, double y, double width, double height) Sets the current clip to the rectangle specified by the given coordinates.
void	setClip(java.awt.Shape clip) Sets the current clipping area to an arbitrary clip shape.
void	setColor(java.awt.Color c) Sets this graphics context's current color to the specified color.
void	setDashArray(float[] arr) Sets the array representing the lengths of the dash segments.
void	setDashPhase(float phase) Sets the current dash phase.
void	setEndCap(int cap) Retrieves the end cap style.
void	setFill(java.awt.Shape s) Fills the interior of a Shape using the settings of the Graphics2D context.
void	setFont(java.awt.Font font) Sets this graphics context's font to the specified font.
void	setLineJoin(int join) Retrieves the line join style.
void	setLineWidth(float w) Sets the line width of the stroke.
void	setMiterLimit(float limit) Retrieves the limit of miter joins.
void	setScale(double sx, double sy) Sets the possibly non-uniform scale component of the current transform.
void	setStroke(java.awt.Stroke s) Sets the Stroke for the Graphics2D context.
void	setTransform(java.awt.geom.AffineTransform t) Sets the transform of the appearance.
void	setTranslation(double x, double y) Concatenates the current Graphics2D Transform with a translation transform.
void	setTransparency(float t) Set the transparency.
void	setVisible(boolean flag) Set the visibility.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Field Detail

LINE_STROKE

static final java.awt.BasicStroke LINE_STROKE

The line stroke.

DOT_STROKE

static final java.awt.BasicStroke DOT_STROKE

The DOT stroke.

DASH_STROKE

static final java.awt.BasicStroke DASH_STROKE

The DASH stroke.

DOT_DASH_STROKE

static final java.awt.BasicStroke DOT_DASH_STROKE

The DOT DASH stroke.

DOT_DOT_DASH_STROKE

static final java.awt.BasicStroke DOT_DOT_DASH_STROKE

The DOT DOT DASH stroke.

Method Detail

setColor

void setColor(java.awt.Color c)

Sets this graphics context's current color to the specified color.

Parameters:

c - the color.

See Also:

Color

getColor

java.awt.Color getColor()

Gets this graphics context's current color to the specified color.

Returns:

the color.

See Also:

Color

setTransparency

void setTransparency(float t)

Set the transparency. This method makes sense if the color is already set only. If the value is lower equal than 1 the method assumes that the transparency is specified in the range 0 .. 1.0. If the value is greater than 1 the method assumes the the transparency is specified in the range 1 .. 255.

Parameters:

t - The transparency.

getTransparency

float getTransparency()

Get the transparency of the current color (range 0 .. 1.0). If no color is available the method returns 0.

Returns:

The transparency.

setFont

void setFont(java.awt.Font font)

Sets this graphics context's font to the specified font.

Parameters:

font - The font.

See Also:

Font

getFont

java.awt.Font getFont()

Gets this graphics context's font to the specified font.

Returns:

The font.

See Also:

Font

setBackgroundColor

void setBackgroundColor(java.awt.Color color)

Sets the background color for the Graphics2D context.

Parameters:

color - The color of the background

See Also:

Graphics2D

getBackgroundColor

java.awt.Color getBackgroundColor()

Gets the background color for the Graphics2D context.

Returns:

The color of the background

See Also:

Graphics2D

setStroke

void setStroke(java.awt.Stroke s)

Sets the Stroke for the Graphics2D context.

Parameters:

s - The Stroke style.

See Also:

Stroke

getStroke

java.awt.Stroke getStroke()

Gets the Stroke for the Graphics2D context.

Returns:

The Stroke style.

See Also:

Stroke

setFill

void setFill(java.awt.Shape s)

Fills the interior of a Shape using the settings of the Graphics2D context.

Parameters:

s - the filling shape.

See Also:

Shape

getFill

java.awt.Shape getFill()

Gets the filling shape.

Returns:

the filling shape.

See Also:

Shape

setTransform

void setTransform(java.awt.geom.AffineTransform t)

Sets the transform of the appearance.

Parameters:

t - the affine transformation.

See Also:

java.awt.AffineTransform

getTransform

java.awt.geom.AffineTransform getTransform()

Retruns the transform of the appearance.

Returns:

the affine transformation.

See Also:

java.awt.AffineTransform

setTranslation

void setTranslation(double x,
                  double y)

Concatenates the current Graphics2D Transform with a translation transform. Subsequent rendering is translated by the specified distance relative to the previous position.

Parameters:

x - Translation in x

y - Translation in y

See Also:

Graphics2D

getTranslation

java.awt.geom.Point2D getTranslation()

Get the translation vector.

Returns:

the translation vector.

See Also:

setTranlation(double, double)

setScale

void setScale(double sx,
            double sy)

Sets the possibly non-uniform scale component of the current transform. Any existing scale is first factored out of the existing transform before the new scale is applied.

Parameters:

sx - scale value in x.

sy - scale value in y.

setClip

void setClip(double x,
           double y,
           double width,
           double height)

Sets the current clip to the rectangle specified by the given coordinates.

Parameters:

x, - y, width, heigth The bounding box.

setClip

void setClip(java.awt.Shape clip)

Sets the current clipping area to an arbitrary clip shape.

Parameters:

clip - The clipping shape.

See Also:

Shape

getClip

java.awt.Shape getClip()

Gets the clipping shape.

Returns:

The shape.

See Also:

Shape

configure

void configure(java.awt.Graphics2D g)

Configurate the graphical context with the settings of the appearance.

Parameters:

g - The Graphical context.

isVisible

boolean isVisible()

Returns a boolean whether the object is visible.

Returns:

true if the object is visible.

setVisible

void setVisible(boolean flag)

Set the visibility.

Parameters:

flag - true if the object should be visible.

getVisible

boolean getVisible()

Get the visibility.

Returns:

true if the object should be visible.

setLineWidth

void setLineWidth(float w)

Sets the line width of the stroke.

Parameters:

w - The line width.

See Also:

BasicStroke

getLineWidth

float getLineWidth()

Returns the line width.

Returns:

The line width.

See Also:

BasicStroke

setDashArray

void setDashArray(float[] arr)

Sets the array representing the lengths of the dash segments.

Parameters:

arr - The segment array.

See Also:

BasicStroke

getDashArray

float[] getDashArray()

Returns the array representing the lengths of the dash segments.

Returns:

The segment array.

See Also:

BasicStroke

setDashPhase

void setDashPhase(float phase)

Sets the current dash phase.

Parameters:

phase - the dash phase.

See Also:

BasicStroke

getDashPhase

float getDashPhase()

Returns the current dash phase.

Returns:

the dash phase.

See Also:

BasicStroke

setEndCap

void setEndCap(int cap)

Retrieves the end cap style.

See Also:

BasicStroke

getEndCap

int getEndCap()

Returns the end cap style.

Returns:

The end cap style.

See Also:

BasicStroke

setLineJoin

void setLineJoin(int join)

Retrieves the line join style.

Parameters:

join - the line join style.

See Also:

BasicStroke

getLineJoin

int getLineJoin()

Returns the line join style.

Returns:

the line join style.

See Also:

BasicStroke

setMiterLimit

void setMiterLimit(float limit)

Retrieves the limit of miter joins.

Parameters:

limit - the limit.

See Also:

BasicStroke

getMiterLimit

float getMiterLimit()

Returns the limit of miter joins.

Returns:

the limit.

See Also:

BasicStroke

scaleStroke

java.awt.BasicStroke scaleStroke(java.awt.geom.AffineTransform at)

Scale the line with.

Parameters:

at - the transformation to scale the stroke.

scaleStroke

java.awt.BasicStroke scaleStroke(java.awt.geom.AffineTransform at,
                               float lw)

Scale the line with.

Parameters:

at - the transformation to scale the stroke.

lw - The line width to be scaled.