com.highqsoft.interfaces.p2d

Interface P2DComponentModelInterface

All Superinterfaces:

FwkInstructionInterface, FwkInterface, FwkPresentationInterface, java.io.Serializable

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface P2DComponentModelInterface
extends FwkInstructionInterface

The P2DComponentModelInterface defines the 3D-plot component object behaviour.

Since:

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

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

Method Summary

Methods

Modifier and Type	Method and Description
void	addDialogPane(FwkDialogPaneInterface pane, java.lang.String ident) Add a spezial dialog pane with the given identifier.
boolean	boundsAcceptable(java.awt.geom.Point2D lower, java.awt.geom.Point2D upper) Checks the given bounds to be acceptable bounds.
boolean	containsAllChildren(P2DBoundingBoxInterface box) Contains all children.
boolean	containsAllChildren(java.awt.geom.Point2D lower, java.awt.geom.Point2D upper) Contains all children.
boolean	frameHasHandles() Inquire whether the frame has handles.
boolean	getActive(P2DContainerInterface container) Get the active flag.
int	getActiveHandle() Get the index of the active handle.
FwkAppearanceInterface	getAppearance() Retrieves the appearance of the view.
P2DBackgroundInterface	getBackground() Get the component's background.
java.awt.Color	getBackgroundColor() Gets the background color.
float	getBackgroundTransparency() Gets the transparency of the background.
boolean	getBackgroundVisible() Inquire whether the background is visible.
P2DBoundingBoxInterface	getBoundingBox() Retrieve the bounding box the component.
P2DComponentInterface	getChild(double x, double y) Return the component that is armed from the given point.
P2DComponentInterface	getChild(java.awt.geom.Point2D p) Return the component that is armed from the given point.
java.util.HashMap	getContainerMap() Returns the container map.
boolean	getDecorated() Get the boolean fo rthe decoration.
FwkDialogPaneInterface	getDialogPane(java.lang.String ident) Retrieves a spezial dialog pane for the given identifier.
java.util.HashMap	getDialogPanes() Retrieves the property dialog panes.
FwkDialogPaneValueInterface	getDialogPaneValue(java.lang.String ident) Retrieves a spezial dialog pane value for the given identifier.
java.util.HashMap	getDialogPaneValues() Retrieves the property dialog pane values.
P2DFrameInterface	getFrame() Get the frame of the component.
java.awt.Color	getFrameColor() Gets the frame color.
boolean	getFrameHandlesVisible() Inquire whether the frame handles are visible.
boolean	getFrameLinesVisible() Inquire whether the frame lines are visible.
float	getFrameTransparency() Gets the transparency of the frame.
boolean	getFrameVisible() Inquire whether the frame is visible.
double	getHeight() Retrieves the height of the box.
boolean	getRatioFix() Get the current ratio flag.
java.awt.geom.AffineTransform	getTransform(P2DContainerInterface container) Restores the transformation that belongs to the given toplevel container.
double	getWidth() Retrieves the width of the box.
boolean	hasActiveChild(P2DContainerInterface container) Returns a boolean whether the component has an active child in the next level.
boolean	isInside(P2DComponentInterface child, P2DBoundingBoxInterface box) Check the specified box in child coodinates.
boolean	isInside(P2DComponentInterface child, java.awt.geom.Point2D p) Check the point specified in child coodinates.
void	registerContainer(P2DContainerInterface container, java.awt.Graphics2D g) Register the given container context.
void	removeDialogPane(java.lang.String ident) remove a spezial dialog pane with the given identifier.
void	resetActiveHandle() Reset the active handle.
void	revalidate(boolean recursive) Request a newly calculation of the component.
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	setActive(P2DContainerInterface container, boolean flag) Activate the component.
void	setActiveHandle(int index) Sets the armed handle.
void	setAppearance(FwkAppearanceInterface ap) Sets the appreance of the component.
void	setBackgroundColor(java.awt.Color color) Sets the background color.
void	setBackgroundTransparency(float transparency) Sets the transparency of the background.
void	setBackgroundVisible(boolean flag) Hide or show the background.
void	setBoundingBox(P2DBoundingBoxInterface bb) Set the the bounding box of the component.
void	setContainerMap(java.util.HashMap map) Sets the container map.
void	setDecorated(boolean flag) Set the boolean fo rthe decoration.
void	setDialogPaneValues(java.util.HashMap values) Sets the property dialog pane values for the component.
void	setFrameColor(java.awt.Color color) Sets the frame color.
void	setFrameHandlesVisible(boolean flag) Hide or show the frame handles.
void	setFrameLinesVisible(boolean flag) Hide or show the frame lines.
void	setFrameTransparency(float transparency) Sets the transparency of the frame.
void	setFrameVisible(boolean flag) Hide or show the whole frame object.
void	setRatioFix(boolean flag) Fix/Release the ratio of the current value.
void	setTransform(P2DContainerInterface container, java.awt.geom.AffineTransform trans) Sets the affine transformation of the component.
java.awt.geom.Point2D	transformPoint(P2DContainerInterface container, java.awt.geom.Point2D p) Transform the point
java.awt.geom.Point2D	transformPoint(java.awt.geom.Point2D p) Transform the point
void	unregisterContainer(P2DContainerInterface container) Unregister the given canvas.

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

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

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

getPresentationString, getPresentationString

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

getVersion, release

Method Detail

setRatioFix

void setRatioFix(boolean flag)

Fix/Release the ratio of the current value.

Parameters:

flag - if true the ratio will be freezed.

getRatioFix

boolean getRatioFix()

Get the current ratio flag.

Returns:

true if the ratio is freezed.

See Also:

setRatioFix(boolean)

setDecorated

void setDecorated(boolean flag)

Set the boolean fo rthe decoration.

Parameters:

flag - true if the component should be decorated.

getDecorated

boolean getDecorated()

Get the boolean fo rthe decoration.

Returns:

true if the component is decorated.

revalidate

void revalidate(boolean recursive)

Request a newly calculation of the component.

setAppearance

void setAppearance(FwkAppearanceInterface ap)

Sets the appreance of the component.

Parameters:

ap - The appearance.

getAppearance

FwkAppearanceInterface getAppearance()

Retrieves the appearance of the view.

Returns:

The appearance of the component.

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.

getWidth

double getWidth()

Retrieves the width of the box.

Returns:

The width

getHeight

double getHeight()

Retrieves the height of the box.

Returns:

The height

unregisterContainer

void unregisterContainer(P2DContainerInterface container)

Unregister the given canvas.

Parameters:

container - The toplevel container.

registerContainer

void registerContainer(P2DContainerInterface container,
                     java.awt.Graphics2D g)

Register the given container context.

Parameters:

container - The toplevel container.

g - The graphical context of the container.

transformPoint

java.awt.geom.Point2D transformPoint(java.awt.geom.Point2D p)

Transform the point

Parameters:

p - The point to transformed.

transformPoint

java.awt.geom.Point2D transformPoint(P2DContainerInterface container,
                                   java.awt.geom.Point2D p)

Transform the point

Parameters:

container - the toplevel container.

p - The point to transformed.

getTransform

java.awt.geom.AffineTransform getTransform(P2DContainerInterface container)

Restores the transformation that belongs to the given toplevel container. If no transformation was found the method returns null.

Parameters:

container - The toplevel container,

Returns:

The transformation.

setTransform

void setTransform(P2DContainerInterface container,
                java.awt.geom.AffineTransform trans)

Sets the affine transformation of the component.

Parameters:

container - The toplevel container.

trans - The transformation.

getBackgroundVisible

boolean getBackgroundVisible()

Inquire whether the background is visible.

Returns:

The visibility flag of the shape.

See Also:

setVisible

setBackgroundVisible

void setBackgroundVisible(boolean flag)

Hide or show the background.

Parameters:

flag - The visibility flag. True means visible.

setBackgroundColor

void setBackgroundColor(java.awt.Color color)

Sets the background color.

Parameters:

color - The new background color.

See Also:

javax.media.j3d.ColoringAttributes, Color

getBackgroundColor

java.awt.Color getBackgroundColor()

Gets the background color.

Returns:

The current background color.

See Also:

javax.media.j3d.ColoringAttributes, Color

setBackgroundTransparency

void setBackgroundTransparency(float transparency)

Sets the transparency of the background.

Parameters:

transparency - The new background transparency value.

See Also:

javax.media.j3d.TransparencyAttributes

getBackgroundTransparency

float getBackgroundTransparency()

Gets the transparency of the background.

Returns:

The actual background transparency value.

See Also:

javax.media.j3d.TransparencyAttributes

getFrame

P2DFrameInterface getFrame()

Get the frame of the component.

setFrameVisible

void setFrameVisible(boolean flag)

Hide or show the whole frame object.

Parameters:

flag - The visibility flag. True means visible.

getFrameVisible

boolean getFrameVisible()

Inquire whether the frame is visible.

Returns:

The current visibility flag.

setFrameLinesVisible

void setFrameLinesVisible(boolean flag)

Hide or show the frame lines.

Parameters:

flag - The visibility flag. True means visible.

getFrameLinesVisible

boolean getFrameLinesVisible()

Inquire whether the frame lines are visible.

Returns:

The current visibility flag.

setFrameHandlesVisible

void setFrameHandlesVisible(boolean flag)

Hide or show the frame handles.

Parameters:

flag - The visibility flag. True means visible.

getFrameHandlesVisible

boolean getFrameHandlesVisible()

Inquire whether the frame handles are visible.

Returns:

The current visibility flag.

frameHasHandles

boolean frameHasHandles()

Inquire whether the frame has handles.

Returns:

true if the frame has handles.

setFrameColor

void setFrameColor(java.awt.Color color)

Sets the frame color.

See Also:

javax.media.j3d.ColoringAttributes, Color

getFrameColor

java.awt.Color getFrameColor()

Gets the frame color.

See Also:

javax.media.j3d.ColoringAttributes, Color

setFrameTransparency

void setFrameTransparency(float transparency)

Sets the transparency of the frame.

See Also:

javax.media.j3d.TransparencyAttributes

getFrameTransparency

float getFrameTransparency()

Gets the transparency of the frame.

See Also:

javax.media.j3d.TransparencyAttributes

setActive

void setActive(P2DContainerInterface container,
             boolean flag)

Activate the component.

Parameters:

flag - true if the component should be activated.

getActive

boolean getActive(P2DContainerInterface container)

Get the active flag.

Returns:

true if component is active.

hasActiveChild

boolean hasActiveChild(P2DContainerInterface container)

Returns a boolean whether the component has an active child in the next level.

Returns:

true if component has an active child in the next level.

isInside

boolean isInside(P2DComponentInterface child,
               java.awt.geom.Point2D p)

Check the point specified in child coodinates.

Parameters:

child - The child

p - The point in child coordinate system.

Returns:

true if the point is inside the boundingbox.

isInside

boolean isInside(P2DComponentInterface child,
               P2DBoundingBoxInterface box)

Check the specified box in child coodinates.

Parameters:

child - The child

box - The boundingbox in child coordinate system.

Returns:

true if the box is inside the boundingbox.

containsAllChildren

boolean containsAllChildren(java.awt.geom.Point2D lower,
                          java.awt.geom.Point2D upper)

Contains all children.

Parameters:

lower, - upper points defining the boundingbox that is to be checked wether it contains all the children.

Returns:

true if the box contains all children.

containsAllChildren

boolean containsAllChildren(P2DBoundingBoxInterface box)

Contains all children.

Parameters:

box - The boundingbox that is to be checked wether it contains all the children.

Returns:

true if the box contains all children.

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.

getChild

P2DComponentInterface getChild(double x,
                             double y)

Return the component that is armed from the given point.

Parameters:

x,y - The point coordinates.

getChild

P2DComponentInterface getChild(java.awt.geom.Point2D p)

Return the component that is armed from the given point.

Parameters:

p - The point.

resetActiveHandle

void resetActiveHandle()

Reset the active handle.

getActiveHandle

int getActiveHandle()

Get the index of the active handle.

Returns:

the index of the active handle or -1 if none.

setActiveHandle

void setActiveHandle(int index)

Sets the armed handle.

Parameters:

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

getContainerMap

java.util.HashMap getContainerMap()

Returns the container map.

Returns:

the container map.

setContainerMap

void setContainerMap(java.util.HashMap map)

Sets the container map.

Parameters:

map - the new container map.

getBackground

P2DBackgroundInterface getBackground()

Get the component's background.

Returns:

The background.

getDialogPanes

java.util.HashMap getDialogPanes()

Retrieves the property dialog panes.

Parameters:

component - The component

Returns:

panes The hashtable with ident/pane pairs..

getDialogPane

FwkDialogPaneInterface getDialogPane(java.lang.String ident)

Retrieves a spezial dialog pane for the given identifier.

Parameters:

component - The component

ident - The identifier string of the requested pane.

Returns:

The dialog pane or null if unknown.

addDialogPane

void addDialogPane(FwkDialogPaneInterface pane,
                 java.lang.String ident)

Add a spezial dialog pane with the given identifier.

Parameters:

ident - The identifier string of the requested pane.

The - dialog pane.

removeDialogPane

void removeDialogPane(java.lang.String ident)

remove a spezial dialog pane with the given identifier.

Parameters:

ident - The identifier string of the requested pane.

getDialogPaneValues

java.util.HashMap getDialogPaneValues()

Retrieves the property dialog pane values.

Parameters:

component - The component

Returns:

panes The hashtable with ident/value pairs..

setDialogPaneValues

void setDialogPaneValues(java.util.HashMap values)

Sets the property dialog pane values for the component. Teh routine will remove evaluated entries from hastable.

Parameters:

component - The component

values - The hashtable with ident/value pairs.

getDialogPaneValue

FwkDialogPaneValueInterface getDialogPaneValue(java.lang.String ident)

Retrieves a spezial dialog pane value for the given identifier.

Parameters:

component - The component

ident - The identifier string of the requested pane.

Returns:

The dialog pane value or null if unknown

boundsAcceptable

boolean boundsAcceptable(java.awt.geom.Point2D lower,
                       java.awt.geom.Point2D upper)

Checks the given bounds to be acceptable bounds.

Parameters:

upper - The upper point of the bounds to be checked.

lower - The lower point of the bounds to be checked.

Returns:

true if the given bounds are acceptable bounds.