com.highqsoft.interfaces.p2d

Interface P2DFrameInterface

All Superinterfaces:

FwkInterface, java.io.Serializable

All Known Implementing Classes:

P2DFrame

public interface P2DFrameInterface
extends FwkInterface

The P2DFrameInterface defines the methods of a frame object used by P2DComponents. A frame object must extends the javax.media.j3d.Node object.

Since:

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

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

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 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.
boolean	getVisible() Returns a boolean whether the component is visble.
boolean	hasHandles() Returns a boolean whether the frame has handles.
void	hideHandles() Hide all the handles.
void	hideLines() Hide the lines.
boolean	isVisible() Returns a boolean whether the component is visble.
void	noHandles() Order no handles.
void	paint(java.awt.Graphics2D g) Paint the frame.
void	resetArmedHandle() Reset the active handle.
void	setAppearance(FwkAppearanceInterface appearance) Get 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) Sets the visibility of the component.
void	showHandles() Show all handles.
void	showLines() Show lines.
void	updateGeometry() Update the geometry.

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

getVersion, release

Method Detail

paint

void paint(java.awt.Graphics2D g)

Paint the frame.

Parameters:

g - The graphics context.

updateGeometry

void updateGeometry()

Update the geometry.

getAppearance

FwkAppearanceInterface getAppearance()

Get the appearance of the frame.

Returns:

The appearance of the frame.

setAppearance

void setAppearance(FwkAppearanceInterface appearance)

Get the appearance of the frame.

getBoundingBox

P2DBoundingBoxInterface getBoundingBox()

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

Returns:

The bounding box.

setBoundingBox

void setBoundingBox(P2DBoundingBoxInterface bb)

Set the the bounding box of the component.

Parameters:

bb - The new bounding box of the component.

hasHandles

boolean hasHandles()

Returns a boolean whether the frame has handles.

Returns:

true if the frame has handles.

setHandle

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

Parameters:

index - The index of the handles to be set.

flag - true if the flag should be enabled.

See Also:

getHandle(int)

getHandle

boolean getHandle(int index)

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

Parameters:

index - The index of the handles to be set.

Returns:

true if the flag is enabled.

See Also:

setHandle(int, boolean)

setHandlesVisible

void setHandlesVisible(boolean flag)

Set the handle visibility.

Parameters:

flag - true if the handle should be visible.

hideHandles

void hideHandles()

Hide all the handles.

showHandles

void showHandles()

Show all handles.

getHandlesVisible

boolean getHandlesVisible()

Returns a boolean whether the handles are visible.

Returns:

true id the handles are visble.

setLinesVisible

void setLinesVisible(boolean flag)

Set the line visiblility.

Parameters:

flag - true if the frame lines are visible.

hideLines

void hideLines()

Hide the lines.

showLines

void showLines()

Show lines.

getLinesVisible

boolean getLinesVisible()

Returns a boolean whether the handles are visible.

Returns:

true if the lines are visible.

setColor

void setColor(java.awt.Color color)

Sets the background color.

See Also:

P2DShape

getColor

java.awt.Color getColor()

Gets the background color.

Returns:

The color of the lines.

setTransparency

void setTransparency(float transparency)

Sets the transparency of the background.

Parameters:

transparency - The new transparency value.

getTransparency

float getTransparency()

Gets the transparency of the background.

Returns:

The current transparency value.

isVisible

boolean isVisible()

Returns a boolean whether the component is visble.

Returns:

A boolean that indicates the visiblity of the component.

getVisible

boolean getVisible()

Returns a boolean whether the component is visble.

Returns:

A boolean that indicates the visiblity of the component.

setVisible

void setVisible(boolean flag)

Sets the visibility of the component.

Parameters:

flag - The flag that indicates the visiblity of the component.

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

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

getArmedHandle

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

Calculate the armed handle for the given point.

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.

getArmedHandle

int getArmedHandle()

Returns the armed handle.

Returns:

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

setArmedHandle

void setArmedHandle(int index)

Sets the armed handle.

Parameters:

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

resetArmedHandle

void resetArmedHandle()

Reset the active handle.

noHandles

void noHandles()

Order no handles.

allHandles

void allHandles()

Order all handles.