com.highqsoft.interfaces.p2d

Interface P2DComponentInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, FwkAppearanceInterface, FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, javax.infobus.InfoBusMember, P2DComponentControlInterface, P2DComponentModelInterface, P2DComponentViewInterface, P2DContainerInterface, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Subinterfaces:

P2DAxisInterface, P2DChannelInterface, 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 P2DComponentInterface
extends FwkInfoBusMemberInterface, P2DContainerInterface, FwkAppearanceInterface, P2DComponentModelInterface, P2DComponentViewInterface, P2DComponentControlInterface

The P2DComponentInterface describes the functionality of a P2D package component.

Since:

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

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTROL_KEY The constant for the control class id property key.
static java.lang.String	MODEL_KEY The constant for the model class id property key.
static java.lang.String	VIEW_KEY The constant for the view class id property key.

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

INFOBUS_SOURCE

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

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

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

DASH_STROKE, DOT_DASH_STROKE, DOT_DOT_DASH_STROKE, DOT_STROKE, LINE_STROKE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	askForName(java.awt.Container parent, java.lang.String title, java.lang.String defaultValue) Ask for component name.
P2DBoundingBoxInterface	calculateBoundingBoxRelativeTo(P2DBoundingBoxInterface bb, java.awt.geom.Point2D p) Calculate a new bounding box relative to the given point.
P2DControlInterface	getControl() Returns the control of the component.
java.lang.String	getControlClassId() Returns the control class ID string.
FwkDialogPaneInterface	getDialogPane(java.lang.String ident) Retrieves a spezial dialog pane for the given identifier.
java.util.HashMap	getDialogPanes() Retrieves the property dialog panes in a hashtable.
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.
boolean	getInternalMouseListenerActive() Get the activity flag for the internal mouse listener.
P2DModelInterface	getModel() Returns the model of the component.
java.lang.String	getModelClassId() Returns the model class ID string.
int	getRegisterCounter() Get the register counter.
P2DViewInterface	getView() Returns the view of the component.
java.lang.String	getViewClassId() Returns the view class ID string.
void	initialize() The initialization routine of the behaviour node.
boolean	isInternalMouseListenerActive() Get a boolean whether the internal mouse listener is active.
boolean	isMVCValid() Return a boolean whether the Model-View-Control is valid.
P2DControlInterface	loadControl() Load the control object.
P2DModelInterface	loadModel() Load the model object.
P2DViewInterface	loadView() Load the view object.
void	paint(java.awt.Graphics2D g) Paint the component.
void	paint(P2DContainerInterface container, java.awt.Graphics2D g) Paint the component.
void	processFocusEvent(java.awt.event.FocusEvent e) Process the focus event.
void	processMouseEvent(java.awt.event.MouseEvent e) Process the mouse event.
void	register() Register the component.
void	setControl(P2DControlInterface newControl) Set the control of the component.
void	setControlClassId(java.lang.String controlId) Sets the control class ID string.
void	setDialogPaneValues(java.util.HashMap values) Sets the property dialog pane values for the component.
void	setInternalMouseListenerActive(boolean flag) Set the activity flag for the internal mouse listener.
void	setModel(P2DModelInterface newModel) Set the model of the component.
void	setModelClassId(java.lang.String modelId) Sets the model class ID string.
void	setView(P2DViewInterface newView) Set the view of the component.
void	setViewClassId(java.lang.String viewId) Sets the view class ID string.
void	unregister() Unregister the component.
void	unregister(boolean flag) Unregister the component.
void	update() Update the component.
void	updateControl() Update the control component.
void	updateModel() Update the model component.
void	updateView() Update the view component.

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DContainerInterface

addContainerListener, addFocusListener, addListener, addMouseListener, addMouseMotionListener, addOrderListener, addP2D, addP2D, addP2D, addP2D, addRepaintListener, fireOrderEvent, getActive, getActiveComponent, getAllArmedComponents, getAllArmedComponents, getArmedComponent, getComponentCommands, getContainerListenerArray, getFocusListenerArray, getListenerArray, getMouseListenerArray, getMouseMotionListenerArray, getOrderListenerArray, getP2D, getP2D, getP2D, getP2DComponentArray, getP2DComponents, getParentContainer, getRepaintListenerArray, getSelectable, getShortName, getTreeLock, openPopupMenu, removeAllP2D, removeContainerListener, removeFocusListener, removeListener, removeMouseListener, removeMouseMotionListener, removeOrderListener, removeP2D, removeP2D, removeRepaintListener, repaint, restoreLastMouseEvent, restoreLocalMousePoint, revalidate, saveLastMouseEvent, saveLocalMousePoint, setActive, setActiveComponent, setParentContainer, setSelectable, toBack, toBack, toBack, toFront, toFront, toFront

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

getInfoBusName, getMemberName, isConnected, setInfoBusName, setMemberName

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

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

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

getCommands, getPersistentObjectNames

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

destroyController

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

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

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

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

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

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

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

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

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

getCompany, readConstructor, readFromDOM, readingDOM, readingDOM, writeConstructor, writeToDOM, writeToXML

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

configure, getBackgroundColor, getClip, getColor, getDashArray, getDashPhase, getEndCap, getFill, getFont, getLineJoin, getLineWidth, getMiterLimit, getStroke, getTransform, getTranslation, getTransparency, getVisible, isVisible, scaleStroke, scaleStroke, setBackgroundColor, setClip, setClip, setColor, setDashArray, setDashPhase, setEndCap, setFill, setFont, setLineJoin, setLineWidth, setMiterLimit, setScale, setStroke, setTransform, setTranslation, setTransparency, setVisible

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DComponentModelInterface

addDialogPane, boundsAcceptable, containsAllChildren, containsAllChildren, frameHasHandles, getActive, getActiveHandle, getAppearance, getBackground, getBackgroundColor, getBackgroundTransparency, getBackgroundVisible, getBoundingBox, getChild, getChild, getContainerMap, getDecorated, getFrame, getFrameColor, getFrameHandlesVisible, getFrameLinesVisible, getFrameTransparency, getFrameVisible, getHeight, getRatioFix, getTransform, getWidth, hasActiveChild, isInside, isInside, registerContainer, removeDialogPane, resetActiveHandle, revalidate, scaleStroke, scaleStroke, setActive, setActiveHandle, setAppearance, setBackgroundColor, setBackgroundTransparency, setBackgroundVisible, setBoundingBox, setContainerMap, setDecorated, setFrameColor, setFrameHandlesVisible, setFrameLinesVisible, setFrameTransparency, setFrameVisible, setRatioFix, setTransform, transformPoint, transformPoint, unregisterContainer

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DComponentControlInterface

focusGained, focusLost, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased

Field Detail

MODEL_KEY

static final java.lang.String MODEL_KEY

The constant for the model class id property key.

See Also:

Constant Field Values

VIEW_KEY

static final java.lang.String VIEW_KEY

The constant for the view class id property key.

See Also:

Constant Field Values

CONTROL_KEY

static final java.lang.String CONTROL_KEY

The constant for the control class id property key.

See Also:

Constant Field Values

Method Detail

register

void register()

Register the component. This method increase the register counter.

getRegisterCounter

int getRegisterCounter()

Get the register counter.

Returns:

the register counter.

unregister

void unregister()

Unregister the component. This method decrease the register counter.

Specified by:

unregister in interface P2DContainerInterface

Throws:

A - P2D_COMPONENT_IS_NOT_REGISTERED if the counter has already reached 0.

unregister

void unregister(boolean flag)

Unregister the component. This method decrease the register counter.

Parameters:

flag - if true the component will unregister all its children.

Throws:

A - P2D_COMPONENT_IS_NOT_REGISTERED if the counter has already reached 0.

updateView

void updateView()

Update the view component.

Throws:

BrickException - with number P2D_CANNOT_UPDATE_VIEW

setView

void setView(P2DViewInterface newView)

Set the view of the component.

Parameters:

newView - The new view instance for the component.

getView

P2DViewInterface getView()

Returns the view of the component.

Returns:

The current view instance of the component.

getViewClassId

java.lang.String getViewClassId()

Returns the view class ID string.

Returns:

The current view id string.

setViewClassId

void setViewClassId(java.lang.String viewId)

Sets the view class ID string. This routine fires a PropertyChangeEvent with ViewClassId

Parameters:

modelId - The new model id string.

loadView

P2DViewInterface loadView()

Load the view object.

Returns:

The view instance of the component.

Throws:

BrickException - with number P2D_CANNOT_LOAD_VIEW

updateModel

void updateModel()

Update the model component.

Throws:

BrickException - with number P2D_CANNOT_UPDATE_MODEL

setModel

void setModel(P2DModelInterface newModel)

Set the model of the component.

Parameters:

newModel - The new model instance for the component.

getModel

P2DModelInterface getModel()

Returns the model of the component.

Returns:

The current model instance of the component.

getModelClassId

java.lang.String getModelClassId()

Returns the model class ID string.

Returns:

The current model id string.

setModelClassId

void setModelClassId(java.lang.String modelId)

Sets the model class ID string. This routine fires a PropertyChangeEvent with modelClassId

Parameters:

modelId - The new model id string.

loadModel

P2DModelInterface loadModel()

Load the model object.

Returns:

The model instance of the component.

Throws:

BrickException - with number P2D_CANNOT_LOAD_MODEL

A - BrickException os thrown if it isn't possible to load the model.

updateControl

void updateControl()

Update the control component.

Throws:

BrickException - with number P2D_CANNOT_UPDATE_CONTROL

setControl

void setControl(P2DControlInterface newControl)

Set the control of the component. This routine fires a PropertyChangeEvent with Control

Parameters:

newControl - The new control instance for the component.

getControl

P2DControlInterface getControl()

Returns the control of the component.

Returns:

The current control instance of the component.

getControlClassId

java.lang.String getControlClassId()

Returns the control class ID string.

Returns:

The current control id string.

setControlClassId

void setControlClassId(java.lang.String controlId)

Sets the control class ID string. This routine fires a PropertyChangeEvent with ControlClassId

Parameters:

modelId - The new control id string.

loadControl

P2DControlInterface loadControl()

Load the control object.

Returns:

The control instance of the component.

Throws:

BrickException - with number P2D_CANNOT_LOAD_CONTROL

update

void update()

Update the component.

isInternalMouseListenerActive

boolean isInternalMouseListenerActive()

Get a boolean whether the internal mouse listener is active.

Returns:

true the internal mouse listener is active.

setInternalMouseListenerActive

void setInternalMouseListenerActive(boolean flag)

Set the activity flag for the internal mouse listener.

Parameters:

flag - true if the internal mouse listener should be active.

getInternalMouseListenerActive

boolean getInternalMouseListenerActive()

Get the activity flag for the internal mouse listener.

Returns:

true if the internal mouse listener should be active.

initialize

void initialize()

The initialization routine of the behaviour node.

See Also:

javax.media.Behavior

paint

void paint(java.awt.Graphics2D g)

Paint the component.

Parameters:

g - The graphics context.

paint

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

Paint the component. This method saves the transformation of the context. This information will be stored in a hashtable where the key is the toplevel container.

Parameters:

container - The toplevel container.

g - The graphics context.

calculateBoundingBoxRelativeTo

P2DBoundingBoxInterface calculateBoundingBoxRelativeTo(P2DBoundingBoxInterface bb,
                                                     java.awt.geom.Point2D p)

Calculate a new bounding box relative to the given point. The components of point should be the distances to the point that initiate the active handle.
This method make sense only if the active handle is set.

Parameters:

component - The component

bb - The boundingbox.

p - The point for that the new bounding box should be calculated.

Returns:

The new bounding box.

processMouseEvent

void processMouseEvent(java.awt.event.MouseEvent e)

Process the mouse event.

Specified by:

processMouseEvent in interface P2DContainerInterface

Parameters:

e - The mouse event.

See Also:

Component

processFocusEvent

void processFocusEvent(java.awt.event.FocusEvent e)

Process the focus event.

Specified by:

processFocusEvent in interface P2DContainerInterface

Parameters:

e - The focus event.

See Also:

Component

getDialogPanes

java.util.HashMap getDialogPanes()

Retrieves the property dialog panes in a hashtable. The hash-keys are the idents of the panes.

Specified by:

getDialogPanes in interface P2DComponentModelInterface

Returns:

tab The hashtable.

getDialogPane

FwkDialogPaneInterface getDialogPane(java.lang.String ident)

Retrieves a spezial dialog pane for the given identifier.

Specified by:

getDialogPane in interface P2DComponentModelInterface

Parameters:

ident - The identifier string of the requested pane.

Returns:

The dialog pane.

getDialogPaneValues

java.util.HashMap getDialogPaneValues()

Retrieves the property dialog pane values.

Specified by:

getDialogPaneValues in interface P2DComponentModelInterface

Returns:

panes The hashtable with ident/value pairs..

setDialogPaneValues

void setDialogPaneValues(java.util.HashMap values)

Sets the property dialog pane values for the component. The routine will remove evaluated entries from hastable.
This method fire a property change event on property "DialogPaneValues".

Specified by:

setDialogPaneValues in interface P2DComponentModelInterface

Parameters:

values - The hashtable with ident/value pairs.

getDialogPaneValue

FwkDialogPaneValueInterface getDialogPaneValue(java.lang.String ident)

Retrieves a spezial dialog pane value for the given identifier.

Specified by:

getDialogPaneValue in interface P2DComponentModelInterface

Parameters:

ident - The identifier string of the requested pane.

Returns:

The dialog pane value or null if unknown

askForName

java.lang.String askForName(java.awt.Container parent,
                          java.lang.String title,
                          java.lang.String defaultValue)

Ask for component name.

Parameters:

parent - This parameter is used as parent for the dialog box.

isMVCValid

boolean isMVCValid()

Return a boolean whether the Model-View-Control is valid.

Parameters:

true - if the structure is valid.