com.highqsoft.fwk

Class FwkAppearance

java.lang.Object

com.highqsoft.fwk.FwkAppearance

All Implemented Interfaces:

FwkAppearanceInterface, FwkInterface, java.io.Serializable

public class FwkAppearance
extends java.lang.Object
implements FwkAppearanceInterface

The FwkAppearance is an implementation of the FwkAppearanceInterface.

Since:

$Date: 2017/04/06 13:28:57 $

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

See Also:

Graphics2D, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	DEFAULT_BACKGROUNDCOLOR
static java.awt.Color	DEFAULT_COLOR
static boolean	JDK1_3_TRANSPARENCY_BUG
static java.awt.BasicStroke[]	STROKES The default stroke array.
static java.lang.String	version

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkAppearanceInterface

DASH_STROKE, DOT_DASH_STROKE, DOT_DOT_DASH_STROKE, DOT_STROKE, LINE_STROKE

Constructor Summary

Constructors

Constructor and Description
FwkAppearance() Creast an appearance.
FwkAppearance(java.awt.Color c) The constructor that receives the color of the appearance.

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).
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	getVisible() Get the visibility.
boolean	isVisible() Returns a boolean whether the object is visible.
void	release() Release the object.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

STROKES

public static final java.awt.BasicStroke[] STROKES

The default stroke array.

JDK1_3_TRANSPARENCY_BUG

public static boolean JDK1_3_TRANSPARENCY_BUG

DEFAULT_COLOR

public static java.awt.Color DEFAULT_COLOR

DEFAULT_BACKGROUNDCOLOR

public static java.awt.Color DEFAULT_BACKGROUNDCOLOR

Constructor Detail

FwkAppearance

public FwkAppearance()

Creast an appearance.

FwkAppearance

public FwkAppearance(java.awt.Color c)

The constructor that receives the color of the appearance.

Parameters:

c - The color of the appearance.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

setColor

public void setColor(java.awt.Color c)

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

Specified by:

setColor in interface FwkAppearanceInterface

Parameters:

c - the color.

See Also:

Color

getColor

public java.awt.Color getColor()

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

Specified by:

getColor in interface FwkAppearanceInterface

Returns:

the color.

See Also:

Color

setTransparency

public 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.

Specified by:

setTransparency in interface FwkAppearanceInterface

Parameters:

t - The transparency.

getTransparency

public float getTransparency()

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

Specified by:

getTransparency in interface FwkAppearanceInterface

Returns:

The transparency.

setFont

public void setFont(java.awt.Font font)

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

Specified by:

setFont in interface FwkAppearanceInterface

Parameters:

font - The font.

See Also:

Font

getFont

public java.awt.Font getFont()

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

Specified by:

getFont in interface FwkAppearanceInterface

Returns:

The font.

See Also:

Font

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Sets the background color for the Graphics2D context.

Specified by:

setBackgroundColor in interface FwkAppearanceInterface

Parameters:

color - The color of the background

See Also:

Graphics2D

getBackgroundColor

public java.awt.Color getBackgroundColor()

Gets the background color for the Graphics2D context.

Specified by:

getBackgroundColor in interface FwkAppearanceInterface

Returns:

The color of the background

See Also:

Graphics2D

setStroke

public void setStroke(java.awt.Stroke s)

Sets the Stroke for the Graphics2D context. The line width will be unchanged.

Specified by:

setStroke in interface FwkAppearanceInterface

Parameters:

s - The Stroke style.

See Also:

Stroke

getStroke

public java.awt.Stroke getStroke()

Gets the Stroke for the Graphics2D context.

Specified by:

getStroke in interface FwkAppearanceInterface

Returns:

The Stroke style.

See Also:

Stroke

setLineWidth

public void setLineWidth(float w)

Sets the line width of the stroke.

Specified by:

setLineWidth in interface FwkAppearanceInterface

Parameters:

w - The line width.

See Also:

BasicStroke

getLineWidth

public float getLineWidth()

Returns the line width.

Specified by:

getLineWidth in interface FwkAppearanceInterface

Returns:

The line width.

See Also:

BasicStroke

setDashArray

public void setDashArray(float[] arr)

Sets the array representing the lengths of the dash segments.

Specified by:

setDashArray in interface FwkAppearanceInterface

Parameters:

arr - The segment array.

See Also:

BasicStroke

getDashArray

public float[] getDashArray()

Returns the array representing the lengths of the dash segments.

Specified by:

getDashArray in interface FwkAppearanceInterface

Returns:

The segment array.

See Also:

BasicStroke

setDashPhase

public void setDashPhase(float phase)

Sets the current dash phase.

Specified by:

setDashPhase in interface FwkAppearanceInterface

Parameters:

phase - the dash phase.

See Also:

BasicStroke

getDashPhase

public float getDashPhase()

Returns the current dash phase.

Specified by:

getDashPhase in interface FwkAppearanceInterface

Returns:

the dash phase.

See Also:

BasicStroke

setEndCap

public void setEndCap(int cap)

Retrieves the end cap style.

Specified by:

setEndCap in interface FwkAppearanceInterface

See Also:

BasicStroke

getEndCap

public int getEndCap()

Returns the end cap style.

Specified by:

getEndCap in interface FwkAppearanceInterface

Returns:

The end cap style.

See Also:

BasicStroke

setLineJoin

public void setLineJoin(int join)

Retrieves the line join style.

Specified by:

setLineJoin in interface FwkAppearanceInterface

Parameters:

join - the line join style.

See Also:

BasicStroke

getLineJoin

public int getLineJoin()

Returns the line join style.

Specified by:

getLineJoin in interface FwkAppearanceInterface

Returns:

the line join style.

See Also:

BasicStroke

setMiterLimit

public void setMiterLimit(float limit)

Retrieves the limit of miter joins.

Specified by:

setMiterLimit in interface FwkAppearanceInterface

Parameters:

limit - the limit.

See Also:

BasicStroke

getMiterLimit

public float getMiterLimit()

Returns the limit of miter joins.

Specified by:

getMiterLimit in interface FwkAppearanceInterface

Returns:

the limit.

See Also:

BasicStroke

setFill

public void setFill(java.awt.Shape s)

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

Specified by:

setFill in interface FwkAppearanceInterface

Parameters:

s - the filling shape.

See Also:

Shape

getFill

public java.awt.Shape getFill()

Gets the filling shape.

Specified by:

getFill in interface FwkAppearanceInterface

Returns:

the filling shape.

See Also:

Shape

setTransform

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

Sets the transform of the appearance.

Specified by:

setTransform in interface FwkAppearanceInterface

Parameters:

t - the affine transformation.

See Also:

java.awt.AffineTransform

getTransform

public java.awt.geom.AffineTransform getTransform()

Retruns the transform of the appearance.

Specified by:

getTransform in interface FwkAppearanceInterface

Returns:

the affine transformation.

See Also:

java.awt.AffineTransform

setTranslation

public 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.

Specified by:

setTranslation in interface FwkAppearanceInterface

Parameters:

x - Translation in x

y - Translation in y

See Also:

Graphics2D

getTranslation

public java.awt.geom.Point2D getTranslation()

Get the translation vector.

Specified by:

getTranslation in interface FwkAppearanceInterface

Returns:

the translation vector.

See Also:

setTranlation(double, double)

setScale

public 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.

Specified by:

setScale in interface FwkAppearanceInterface

Parameters:

sx - scale value in x.

sy - scale value in y.

setClip

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

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

Specified by:

setClip in interface FwkAppearanceInterface

Parameters:

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

setClip

public void setClip(java.awt.Shape clip)

Sets the current clipping area to an arbitrary clip shape.

Specified by:

setClip in interface FwkAppearanceInterface

Parameters:

clip - The clipping shape.

See Also:

Shape

getClip

public java.awt.Shape getClip()

Gets the clipping shape.

Specified by:

getClip in interface FwkAppearanceInterface

Returns:

The shape.

See Also:

Shape

configure

public void configure(java.awt.Graphics2D g)

Configurate the graphical context with the settings of the appearance.

Specified by:

configure in interface FwkAppearanceInterface

Parameters:

g - The Graphical context.

isVisible

public boolean isVisible()

Returns a boolean whether the object is visible.

Specified by:

isVisible in interface FwkAppearanceInterface

Returns:

true if the object is visible.

setVisible

public void setVisible(boolean flag)

Set the visibility.

Specified by:

setVisible in interface FwkAppearanceInterface

Parameters:

flag - true if the object should be visible.

getVisible

public boolean getVisible()

Get the visibility.

Specified by:

getVisible in interface FwkAppearanceInterface

Returns:

true if the object should be visible.

scaleStroke

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

Scale the line with.

Specified by:

scaleStroke in interface FwkAppearanceInterface

Parameters:

at - the transformation to scale the stroke.

lw - The line width to be scaled.

scaleStroke

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

Scale the line with.

Specified by:

scaleStroke in interface FwkAppearanceInterface

Parameters:

at - the transformation to scale the stroke.