com.highqsoft.p2d

Class P2DFrame

java.lang.Object

com.highqsoft.p2d.P2DFrame

All Implemented Interfaces:

FwkInterface, P2DFrameInterface, java.io.Serializable

public class P2DFrame
extends java.lang.Object
implements P2DFrameInterface

The P2DFrame object is the frame for all plot components. It is able to handle mouse events for moving and resizing.

Since:

$Date: 2017/04/06 13:30:07 $

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	armedHandle
static float	handleSize The handle size in pixel.
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
P2DFrame() The constructor.
P2DFrame(java.awt.Color c) Constructor that receives the color of the frame.
P2DFrame(FwkAppearanceInterface ap) Constructor that receives the appearance of the frame.
P2DFrame(P2DFrameInterface source) A constructor receiving another frame.

Method Summary

Methods

Modifier and Type	Method and Description
void	allHandles() Order all handles.
FwkAppearanceInterface	getAppearance() Get the appearance of the frame.
int	getArmedHandle() Returns the last calculated the armed handle.
int	getArmedHandle(java.awt.geom.Point2D ap) Calculate the armed handle for the given point.
P2DBoundingBoxInterface	getBoundingBox() Retrieve the bounding box the component.
java.awt.Color	getColor() Gets the background 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.
boolean	getHandle(int index) Retrieves the handle at the specified position.
boolean	getHandlesVisible() Returns a boolean whether the handles are visible.
int	getLineJoin() Returns the line join style.
boolean	getLinesVisible() Returns a boolean whether the handles are visible.
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.
float	getTransparency() Gets the transparency of the background.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	getVisible() Get the frame visibility.
boolean	hasHandles() Returns a boolean whether the frame has handles.
void	hideHandles() Hide all the handles.
void	hideLines() Hide the lines.
boolean	isVisible() Get the visibility.
void	noHandles() Order no handles.
void	paint(java.awt.Graphics2D g) Paint the frame.
void	release() Release the object.
void	resetArmedHandle() Reset the active handle.
void	setAppearance(FwkAppearanceInterface appearance) Set the appearance of the frame.
void	setArmedHandle(int index) Sets the armed handle.
void	setBoundingBox(P2DBoundingBoxInterface bb) Set the the bounding box of the component.
void	setColor(java.awt.Color color) Sets the background 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	setHandle(int index, boolean flag) Set the handle at the specified position.
void	setHandlesVisible(boolean flag) Set the handle visibility.
void	setLineJoin(int join) Retrieves the line join style.
void	setLinesVisible(boolean flag) Set the line visiblility.
void	setLineWidth(float w) Sets the line width of the stroke.
void	setMiterLimit(float limit) Retrieves the limit of miter joins.
void	setStroke(java.awt.Stroke s) Sets the Stroke for the Graphics2D context.
void	setTransparency(float transparency) Sets the transparency of the background.
void	setVisible(boolean flag) Set the frame visibility.
void	showHandles() Show all handles.
void	showLines() Show lines.
void	updateGeometry() Update the geometry.

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

handleSize

public static final float handleSize

The handle size in pixel.

See Also:

Constant Field Values

armedHandle

protected int armedHandle

Constructor Detail

P2DFrame

public P2DFrame()

The constructor.

P2DFrame

public P2DFrame(java.awt.Color c)

Constructor that receives the color of the frame.

Parameters:

c - The color of the background.

P2DFrame

public P2DFrame(FwkAppearanceInterface ap)

Constructor that receives the appearance of the frame.

Parameters:

ap - The appearance of the background.

P2DFrame

public P2DFrame(P2DFrameInterface source)

A constructor receiving another frame. The constructor will copy all the setting except the appearance.

Parameters:

source - the source frame.

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

paint

public void paint(java.awt.Graphics2D g)

Paint the frame.

Specified by:

paint in interface P2DFrameInterface

Parameters:

g - The graphical context.

updateGeometry

public void updateGeometry()

Update the geometry.

Specified by:

updateGeometry in interface P2DFrameInterface

getAppearance

public FwkAppearanceInterface getAppearance()

Get the appearance of the frame.

Specified by:

getAppearance in interface P2DFrameInterface

Returns:

The appearance of the frame.

setAppearance

public void setAppearance(FwkAppearanceInterface appearance)

Set the appearance of the frame.

Specified by:

setAppearance in interface P2DFrameInterface

Parameters:

appearance - The appearance of the frame.

isVisible

public boolean isVisible()

Get the visibility.

Specified by:

isVisible in interface P2DFrameInterface

Returns:

true if the object should be visible.

setVisible

public void setVisible(boolean flag)

Set the frame visibility.

Specified by:

setVisible in interface P2DFrameInterface

Parameters:

flag - true if the frame should be visible.

getVisible

public boolean getVisible()

Get the frame visibility.

Specified by:

getVisible in interface P2DFrameInterface

Returns:

true if the frame should be visible.

getBoundingBox

public P2DBoundingBoxInterface getBoundingBox()

Retrieve the bounding box the component. The component must be alive to get a meaningful value.

Specified by:

getBoundingBox in interface P2DFrameInterface

Returns:

The bounding box.

setBoundingBox

public void setBoundingBox(P2DBoundingBoxInterface bb)

Set the the bounding box of the component.

Specified by:

setBoundingBox in interface P2DFrameInterface

Parameters:

bb - The new bounding box of the component.

hasHandles

public boolean hasHandles()

Returns a boolean whether the frame has handles.

Specified by:

hasHandles in interface P2DFrameInterface

Returns:

true if the frame has handles.

noHandles

public void noHandles()

Order no handles.

Specified by:

noHandles in interface P2DFrameInterface

allHandles

public void allHandles()

Order all handles.

Specified by:

allHandles in interface P2DFrameInterface

setHandle

public void setHandle(int index,
             boolean flag)

Set the handle at the specified position. The index is used for handle array as follows:
0 - 1 - 2
3 - 4 - 5
6 - 7 - 8

Specified by:

setHandle in interface P2DFrameInterface

Parameters:

index - The index of the handles to be set.

flag - true if the flag should be enabled.

See Also:

P2DFrameInterface.getHandle(int)

getHandle

public boolean getHandle(int index)

Retrieves the handle at the specified position. If the hadles are hidden this method return always false. The index is used for handle array as follows:
0 - 1 - 2
3 - 4 - 5
6 - 7 - 8

Specified by:

getHandle in interface P2DFrameInterface

Parameters:

index - The index of the handles to be set.

Returns:

true if the flag is enabled.

See Also:

setHandle(int, boolean)

setHandlesVisible

public void setHandlesVisible(boolean flag)

Set the handle visibility.

Specified by:

setHandlesVisible in interface P2DFrameInterface

Parameters:

flag - true if the handle should be visible.

hideHandles

public void hideHandles()

Hide all the handles.

Specified by:

hideHandles in interface P2DFrameInterface

showHandles

public void showHandles()

Show all handles.

Specified by:

showHandles in interface P2DFrameInterface

getHandlesVisible

public boolean getHandlesVisible()

Returns a boolean whether the handles are visible.

Specified by:

getHandlesVisible in interface P2DFrameInterface

Returns:

true id the handles are visble.

setLinesVisible

public void setLinesVisible(boolean flag)

Set the line visiblility.

Specified by:

setLinesVisible in interface P2DFrameInterface

Parameters:

flag - true if the frame lines are visible.

hideLines

public void hideLines()

Hide the lines.

Specified by:

hideLines in interface P2DFrameInterface

showLines

public void showLines()

Show lines.

Specified by:

showLines in interface P2DFrameInterface

getLinesVisible

public boolean getLinesVisible()

Returns a boolean whether the handles are visible.

Specified by:

getLinesVisible in interface P2DFrameInterface

Returns:

true if the lines are visible.

setColor

public void setColor(java.awt.Color color)

Sets the background color.

Specified by:

setColor in interface P2DFrameInterface

See Also:

P2DShape

getColor

public java.awt.Color getColor()

Gets the background color.

Specified by:

getColor in interface P2DFrameInterface

Returns:

The color of the lines.

See Also:

com.highqsoft.P2D.P2DShape

setTransparency

public void setTransparency(float transparency)

Sets the transparency of the background.

Specified by:

setTransparency in interface P2DFrameInterface

Parameters:

transparency - The new transparency value.

getTransparency

public float getTransparency()

Gets the transparency of the background.

Specified by:

getTransparency in interface P2DFrameInterface

Returns:

The current transparency value.

setLineWidth

public void setLineWidth(float w)

Sets the line width of the stroke.

Specified by:

setLineWidth in interface P2DFrameInterface

Parameters:

w - The line width.

See Also:

BasicStroke

getLineWidth

public float getLineWidth()

Returns the line width.

Specified by:

getLineWidth in interface P2DFrameInterface

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 P2DFrameInterface

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 P2DFrameInterface

Returns:

The segment array.

See Also:

BasicStroke

setDashPhase

public void setDashPhase(float phase)

Sets the current dash phase.

Specified by:

setDashPhase in interface P2DFrameInterface

Parameters:

phase - the dash phase.

See Also:

BasicStroke

getDashPhase

public float getDashPhase()

Returns the current dash phase.

Specified by:

getDashPhase in interface P2DFrameInterface

Returns:

the dash phase.

See Also:

BasicStroke

setEndCap

public void setEndCap(int cap)

Retrieves the end cap style.

Specified by:

setEndCap in interface P2DFrameInterface

See Also:

BasicStroke

getEndCap

public int getEndCap()

Returns the end cap style.

Specified by:

getEndCap in interface P2DFrameInterface

Returns:

The end cap style.

See Also:

BasicStroke

setLineJoin

public void setLineJoin(int join)

Retrieves the line join style.

Specified by:

setLineJoin in interface P2DFrameInterface

Parameters:

join - the line join style.

See Also:

BasicStroke

getLineJoin

public int getLineJoin()

Returns the line join style.

Specified by:

getLineJoin in interface P2DFrameInterface

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 P2DFrameInterface

Parameters:

limit - the limit.

See Also:

BasicStroke

getMiterLimit

public float getMiterLimit()

Returns the limit of miter joins.

Specified by:

getMiterLimit in interface P2DFrameInterface

Returns:

the limit.

See Also:

BasicStroke

setStroke

public void setStroke(java.awt.Stroke s)

Sets the Stroke for the Graphics2D context.

Specified by:

setStroke in interface P2DFrameInterface

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 P2DFrameInterface

Returns:

The Stroke style.

See Also:

Stroke

getArmedHandle

public int getArmedHandle()

Returns the last calculated the armed handle.

Specified by:

getArmedHandle in interface P2DFrameInterface

Returns:

The index of the active handle. It returns -1, if no handle could be activated.

getArmedHandle

public int getArmedHandle(java.awt.geom.Point2D ap)

Calculate the armed handle for the given point.

Specified by:

getArmedHandle in interface P2DFrameInterface

Parameters:

p - The point for that the active handle should be calculated.

Returns:

The index of the active handle. It returns -1, if no handle could be activated.

resetArmedHandle

public void resetArmedHandle()

Reset the active handle.

Specified by:

resetArmedHandle in interface P2DFrameInterface

setArmedHandle

public void setArmedHandle(int index)

Sets the armed handle.

Specified by:

setArmedHandle in interface P2DFrameInterface

Parameters:

index - The index of the active handle. It returns -1, if no handle could be activated.