com.highqsoft.p2d

Class P2DContainer

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

com.highqsoft.fwk.FwkItem

com.highqsoft.fwk.FwkInfoBusMember

com.highqsoft.p2d.P2DContainer

All Implemented Interfaces:

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

Direct Known Subclasses:

P2DComponent

public abstract class P2DContainer
extends FwkInfoBusMember
implements P2DContainerInterface

A container object is a P2D object that can contain P2DComponents.

Components added to a container are tracked in a list. The order of the list will define the components' front-to-back stacking order within the container. If no index is specified when adding a component to a container, it will be added to the end of the list (and hence to the bottom of the stacking order).

Since:

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

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected FwkArray	components The components in this container.
protected static FwkDescriptionInterface	descriptor
protected java.awt.event.MouseEvent	lastMouseEvent
protected javax.swing.event.EventListenerList	listeners The event listener list.
protected java.awt.geom.Point2D	localMousePoint
protected java.lang.Object	LOCK The locking object for component-tree and layout operations.
protected P2DContainerInterface	parent
protected boolean	readingDOM
protected boolean	selectable
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkInfoBusMember

infoBusMemberSupport

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, properties, suspendChangeManager

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

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

Constructor Summary

Constructors

Constructor and Description
P2DContainer() Constructs a new Container.

Method Summary

Methods

Modifier and Type	Method and Description
void	addContainerListener(P2DContainerListenerInterface listener) Add a container listener.
void	addFocusListener(java.awt.event.FocusListener l) Adds a focus listener.
void	addListener(java.lang.Class clazz, java.util.EventListener listener) Adds a order listener.
void	addMouseListener(java.awt.event.MouseListener l) Adds an MouseMotionListener.
void	addMouseMotionListener(java.awt.event.MouseMotionListener l) Adds an MouseMotionListener.
void	addOrderListener(P2DOrderListenerInterface l) Adds a order listener.
P2DContainerInterface	addP2D(P2DContainerInterface comp) Adds the specified component to the end of this container.
P2DContainerInterface	addP2D(P2DContainerInterface comp, int index) Adds the specified component to this container at the given position.
P2DContainerInterface	addP2D(java.lang.String name) Adds the specified component to the end of this container.
P2DContainerInterface	addP2D(java.lang.String name, int index) Adds the specified component to this container at the given position.
protected P2DContainerInterface	addP2DImpl(P2DContainerInterface comp, java.lang.Object constraints, int index) Adds the specified component to this container at the specified index.
void	addRepaintListener(P2DRepaintListenerInterface listener) Add a repaint listener.
protected void	finalize() Leave the info at the end of session.
protected void	fireContainerAddedEvent(P2DContainerInterface container) Fire a container add event.
protected void	fireContainerRemovedEvent(P2DContainerInterface container) Fire a container remove event.
void	fireOrderEvent(boolean flag) Fire an order event.
boolean	getActive(P2DContainerInterface container) Get the active flag.
P2DContainerInterface	getActiveComponent(P2DContainerInterface container) Get the active component.
void	getAllArmedComponents(P2DContainerInterface container, double x, double y, FwkArrayInterface arr) return all armed component.
void	getAllArmedComponents(P2DContainerInterface container, java.awt.geom.Point2D p, FwkArrayInterface arr) return all armed component.
P2DContainerInterface	getArmedComponent(double x, double y) return the armed component.
P2DContainerInterface	getArmedComponent(java.awt.event.MouseEvent ev) return the armed component.
FwkCommandInterface[]	getCommands() Get the commands of the component.
FwkCommandInterface[]	getComponentCommands() Get the commands of all components.
FwkArrayInterface	getContainerListenerArray() Get the array containing the container listeners.
static FwkDescriptionInterface	getDescriptor()
FwkArrayInterface	getFocusListenerArray() Get the array containing the focus listenres.
FwkArrayInterface	getListenerArray(java.lang.Class clazz) Get the array containing the order listeners.
FwkArrayInterface	getMouseListenerArray() Get the array containing the mouse motion listenres.
FwkArrayInterface	getMouseMotionListenerArray() Get the array containing the mouse motion listenres.
FwkArrayInterface	getOrderListenerArray() Get the array containing the order listeners.
P2DContainerInterface[]	getP2D(java.lang.Class clazz) Retrieves the specified component class from this container.
P2DContainerInterface[]	getP2D(java.lang.Class clazz, java.lang.String name) Retrieves the specified component class from this container.
P2DContainerInterface	getP2D(int index) Gets the component, specified by index, from this container.
FwkArrayInterface	getP2DComponentArray() Gets all the components in this container.
FwkArrayInterface	getP2DComponents() Gets all the components in this container.
P2DContainerInterface	getParentContainer() Get the parent container of this component.
FwkArrayInterface	getRepaintListenerArray() Get the array containing the repaint listeners.
boolean	getSelectable() Get a boolean indicates whether the container is selectable.
java.lang.String	getShortName() Get the short name of the container.
java.lang.Object	getTreeLock() Gets the locking object for component-tree and layout Gets this component's locking object (the object that owns the thread sychronization monitor) for component-tree and layout operations.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	openPopupMenu(java.awt.event.MouseEvent ev) Open the popup menu.
abstract void	processFocusEvent(java.awt.event.FocusEvent e) Process the focus event.
void	processMouseEvent(java.awt.event.MouseEvent e) Process the mouse event.
java.lang.Object	readConstructor(org.w3c.dom.Document document, org.w3c.dom.Element node) Read a construtor dom node.
void	readFromDOM(org.w3c.dom.Document doc, org.w3c.dom.Element element) Read from DOM
boolean	readingDOM() Get the DOM reading flag.
void	readingDOM(boolean flag) Set a flag that the object is currently reading the DOM.
void	release() Release object.
void	removeAllP2D() Removes all the components from this container.
void	removeContainerListener(P2DContainerListenerInterface listener) Remove a container listener.
void	removeFocusListener(java.awt.event.FocusListener l) Removes an focus listener.
void	removeListener(java.lang.Class clazz, java.util.EventListener listener) Removes an order listener.
void	removeMouseListener(java.awt.event.MouseListener l) Removes an MouseMotionListener.
void	removeMouseMotionListener(java.awt.event.MouseMotionListener l) Removes an MouseMotionListener.
void	removeOrderListener(P2DOrderListenerInterface l) Removes an order listener.
P2DContainerInterface	removeP2D(int index) Removes the component, specified by index, from this container.
P2DContainerInterface	removeP2D(P2DContainerInterface comp) Removes the specified component from this container.
void	removeRepaintListener(P2DRepaintListenerInterface listener) Remove a repaint listener.
void	repaint() Repaint the container.
java.awt.event.MouseEvent	restoreLastMouseEvent() Restore last mouse event.
void	revalidate(boolean recursive) Revalidate the container.
void	saveLastMouseEvent(java.awt.event.MouseEvent ev) Save the last mouse event.
void	setActive(P2DContainerInterface container, boolean flag) Activate the component.
void	setActiveComponent(P2DContainerInterface container, P2DContainerInterface component) Set the active component.
void	setParentContainer(P2DContainerInterface container) Set the parent container of the component.
void	setSelectable(boolean flag) Set the container selectable.
void	toBack() Move this component to back inside the parent container.
void	toBack(int index) Move the component with the given index to the back (first array position).
void	toBack(P2DContainerInterface container) Move the given component to the back (first array position).
void	toFront() Move this component to front inside the parent container.
void	toFront(int index) Move the component with the given index to the front (last array position).
void	toFront(P2DContainerInterface container) Move the given component to the front (last array position).
org.w3c.dom.Element	writeConstructor(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write a construtor dom node.
org.w3c.dom.Element	writeToDOM(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write the container as child to the given DOM node.
boolean	writeToXML(java.lang.String filename, boolean validate) Writes the canvas to an XML file.

Methods inherited from class com.highqsoft.fwk.FwkInfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, getInfoBusName, getMemberName, isConnected, joinInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus, setInfoBusName, setMemberName, setName

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getProperty, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from class com.highqsoft.fwk.FwkPersistence

addCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, destroyController, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommand, getCommands, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIcon, getIconKey, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeCommand, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCommands, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSource, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

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

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, getPresentationString, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

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

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

restoreLocalMousePoint, saveLocalMousePoint, unregister

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, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

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

getPresentationString, getPresentationString

Methods inherited from interface javax.infobus.DataItem

getSource

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

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

getCompany

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

descriptor

protected static final FwkDescriptionInterface descriptor

lastMouseEvent

protected java.awt.event.MouseEvent lastMouseEvent

localMousePoint

protected java.awt.geom.Point2D localMousePoint

listeners

protected javax.swing.event.EventListenerList listeners

The event listener list.

parent

protected P2DContainerInterface parent

selectable

protected boolean selectable

readingDOM

protected boolean readingDOM

components

protected FwkArray components

The components in this container.

See Also:

#add(P2DContainerInterface), #add(P2DContainerInterface, int), #add(P2DContainerInterface, java.lang.Object), #getComponents()

LOCK

protected final java.lang.Object LOCK

The locking object for component-tree and layout operations.

See Also:

getTreeLock()

Constructor Detail

P2DContainer

public P2DContainer()

Constructs a new Container.

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

Overrides:

getVersion in class FwkInfoBusMember

getDescriptor

public static FwkDescriptionInterface getDescriptor()

finalize

protected void finalize()
                 throws java.lang.Throwable

Description copied from class: FwkInfoBusMember

Leave the info at the end of session.

Overrides:

finalize in class FwkInfoBusMember

Throws:

java.lang.Throwable

release

public void release()

Release object.

Specified by:

release in interface FwkInterface

Specified by:

release in interface javax.infobus.DataItem

Overrides:

release in class FwkItem

getTreeLock

public final java.lang.Object getTreeLock()

Gets the locking object for component-tree and layout Gets this component's locking object (the object that owns the thread sychronization monitor) for component-tree and layout operations.

Specified by:

getTreeLock in interface P2DContainerInterface

Returns:

This component's locking object.

getP2DComponents

public FwkArrayInterface getP2DComponents()

Gets all the components in this container. Method makes a copy of all components.

Specified by:

getP2DComponents in interface P2DContainerInterface

Returns:

an array of all the components in this container.

getP2DComponentArray

public FwkArrayInterface getP2DComponentArray()

Gets all the components in this container. Method doesn't make a copy of all components.

Specified by:

getP2DComponentArray in interface P2DContainerInterface

Returns:

an array of all the components in this container.

addP2D

public P2DContainerInterface addP2D(P2DContainerInterface comp)

Adds the specified component to the end of this container.

Specified by:

addP2D in interface P2DContainerInterface

Parameters:

comp - the component to be added.

Returns:

the component argument.

addP2D

public P2DContainerInterface addP2D(java.lang.String name,
                           int index)

Adds the specified component to this container at the given position.

Specified by:

addP2D in interface P2DContainerInterface

Parameters:

name - the component's to be added.

index - the position at which to insert the component, or -1 to insert the component at the end.

Returns:

the component comp

See Also:

#remove, #add(String)

addP2D

public P2DContainerInterface addP2D(java.lang.String name)

Adds the specified component to the end of this container.

Specified by:

addP2D in interface P2DContainerInterface

Parameters:

name - The component's name. The component is found on InfoBus.

Returns:

the component argument.

addP2D

public P2DContainerInterface addP2D(P2DContainerInterface comp,
                           int index)

Adds the specified component to this container at the given position.

Specified by:

addP2D in interface P2DContainerInterface

Parameters:

comp - the component to be added.

index - the position at which to insert the component, or -1 to insert the component at the end.

Returns:

the component comp

See Also:

#remove

addP2DImpl

protected P2DContainerInterface addP2DImpl(P2DContainerInterface comp,
                               java.lang.Object constraints,
                               int index)

Adds the specified component to this container at the specified index. This method also notifies the layout manager to add the component to this container's layout using the specified constraints object.
This method fire a property change event on the value .

This is the method to override if a program needs to track every add request to a container. An overriding method should usually include a call to the superclass's version of the method:

super.addImpl(comp, constraints, index)

Parameters:

comp - the component to be added.

constraints - an object expressing layout contraints for this component.

index - the position in the container's list at which to insert the component, where -1 means insert at the end.

See Also:

#add(P2DComponent), #add(P2DComponent, int), #add(P2DComponent, java.lang.Object)

removeP2D

public P2DContainerInterface removeP2D(int index)

Removes the component, specified by index, from this container.

Specified by:

removeP2D in interface P2DContainerInterface

Parameters:

index - the index of the component to be removed.

See Also:

#add

removeP2D

public P2DContainerInterface removeP2D(P2DContainerInterface comp)

Removes the specified component from this container.
This method fire a property change event on the value .

Specified by:

removeP2D in interface P2DContainerInterface

Parameters:

comp - the component to be removed

See Also:

#add

getP2D

public P2DContainerInterface getP2D(int index)

Gets the component, specified by index, from this container.

Specified by:

getP2D in interface P2DContainerInterface

Parameters:

index - the index of the component to be retrieved.

the - element that was retrieved or null if not available.

See Also:

#add

getP2D

public P2DContainerInterface[] getP2D(java.lang.Class clazz)

Retrieves the specified component class from this container.

Specified by:

getP2D in interface P2DContainerInterface

Parameters:

clazz - the child class.

an - array containing component implementing the specified class.

getP2D

public P2DContainerInterface[] getP2D(java.lang.Class clazz,
                             java.lang.String name)

Retrieves the specified component class from this container.

Specified by:

getP2D in interface P2DContainerInterface

Parameters:

clazz - the child class.

name - the name of the component.

an - array containing component implementing the specified class and with the specified name.

removeAllP2D

public void removeAllP2D()

Removes all the components from this container.

Specified by:

removeAllP2D in interface P2DContainerInterface

See Also:

#add, #remove

toFront

public void toFront()

Move this component to front inside the parent container.

Specified by:

toFront in interface P2DContainerInterface

toFront

public void toFront(int index)

Move the component with the given index to the front (last array position).

Specified by:

toFront in interface P2DContainerInterface

Parameters:

index - The index of the component to be moved.

toFront

public void toFront(P2DContainerInterface container)

Move the given component to the front (last array position).

Specified by:

toFront in interface P2DContainerInterface

Parameters:

container - The component to be moved.

toBack

public void toBack()

Move this component to back inside the parent container.

Specified by:

toBack in interface P2DContainerInterface

toBack

public void toBack(int index)

Move the component with the given index to the back (first array position).

Specified by:

toBack in interface P2DContainerInterface

Parameters:

index - The index of the component to be moved.

toBack

public void toBack(P2DContainerInterface container)

Move the given component to the back (first array position).

Specified by:

toBack in interface P2DContainerInterface

Parameters:

container - The component to be moved.

setParentContainer

public void setParentContainer(P2DContainerInterface container)

Set the parent container of the component.

Specified by:

setParentContainer in interface P2DContainerInterface

Parameters:

container - The parent container.

See Also:

getParentContainer

getParentContainer

public P2DContainerInterface getParentContainer()

Get the parent container of this component.

Specified by:

getParentContainer in interface P2DContainerInterface

Returns:

The parent container of the component.

See Also:

setParentContainer

getCommands

public FwkCommandInterface[] getCommands()

Get the commands of the component.

Specified by:

getCommands in interface FwkInstructionInterface

Overrides:

getCommands in class FwkPersistence

Returns:

The command array.

getAllArmedComponents

public void getAllArmedComponents(P2DContainerInterface container,
                         double x,
                         double y,
                         FwkArrayInterface arr)

return all armed component.

Specified by:

getAllArmedComponents in interface P2DContainerInterface

Parameters:

x - The x part of the armed coordinate.

y - The y part of the armed coordinate.

arr - The array to collect all armed components.

getAllArmedComponents

public void getAllArmedComponents(P2DContainerInterface container,
                         java.awt.geom.Point2D p,
                         FwkArrayInterface arr)

return all armed component.

Specified by:

getAllArmedComponents in interface P2DContainerInterface

Parameters:

x - The x part of the armed coordinate.

y - The y part of the armed coordinate.

arr - The array to collect all armed components.

getArmedComponent

public P2DContainerInterface getArmedComponent(java.awt.event.MouseEvent ev)

return the armed component.

Returns:

The component or null if no component is armed.

getArmedComponent

public P2DContainerInterface getArmedComponent(double x,
                                      double y)

return the armed component.

Specified by:

getArmedComponent in interface P2DContainerInterface

Returns:

The component or null if no component is armed.

setActiveComponent

public void setActiveComponent(P2DContainerInterface container,
                      P2DContainerInterface component)

Set the active component.

Specified by:

setActiveComponent in interface P2DContainerInterface

Parameters:

component - The component.

getActiveComponent

public P2DContainerInterface getActiveComponent(P2DContainerInterface container)

Get the active component.

Specified by:

getActiveComponent in interface P2DContainerInterface

Returns:

The component.

addRepaintListener

public void addRepaintListener(P2DRepaintListenerInterface listener)

Add a repaint listener.

Specified by:

addRepaintListener in interface P2DContainerInterface

Parameters:

listener - the repaint listener.

removeRepaintListener

public void removeRepaintListener(P2DRepaintListenerInterface listener)

Remove a repaint listener.

Specified by:

removeRepaintListener in interface P2DContainerInterface

Parameters:

listener - the repaint listener.

getRepaintListenerArray

public FwkArrayInterface getRepaintListenerArray()

Get the array containing the repaint listeners.

Specified by:

getRepaintListenerArray in interface P2DContainerInterface

Parameters:

The - FwkArrayInterface.

repaint

public void repaint()

Repaint the container.

Specified by:

repaint in interface P2DContainerInterface

addContainerListener

public void addContainerListener(P2DContainerListenerInterface listener)

Add a container listener.

Specified by:

addContainerListener in interface P2DContainerInterface

Parameters:

listener - the container listener.

removeContainerListener

public void removeContainerListener(P2DContainerListenerInterface listener)

Remove a container listener.

Specified by:

removeContainerListener in interface P2DContainerInterface

Parameters:

listener - the container listener.

getContainerListenerArray

public FwkArrayInterface getContainerListenerArray()

Get the array containing the container listeners.

Specified by:

getContainerListenerArray in interface P2DContainerInterface

Parameters:

The - FwkArrayInterface.

fireContainerAddedEvent

protected void fireContainerAddedEvent(P2DContainerInterface container)

Fire a container add event.

Parameters:

container - that was added.

fireContainerRemovedEvent

protected void fireContainerRemovedEvent(P2DContainerInterface container)

Fire a container remove event.

Parameters:

container - that was removed.

setActive

public void setActive(P2DContainerInterface container,
             boolean flag)

Activate the component.

Specified by:

setActive in interface P2DContainerInterface

Parameters:

flag - true if the component should be activated.

getActive

public boolean getActive(P2DContainerInterface container)

Get the active flag.

Specified by:

getActive in interface P2DContainerInterface

Returns:

true if component is active.

getFocusListenerArray

public FwkArrayInterface getFocusListenerArray()

Get the array containing the focus listenres.

Specified by:

getFocusListenerArray in interface P2DContainerInterface

Parameters:

The - FwkArrayInterface.

addFocusListener

public void addFocusListener(java.awt.event.FocusListener l)

Adds a focus listener.

Specified by:

addFocusListener in interface P2DContainerInterface

Parameters:

l - The focus listener.

removeFocusListener

public void removeFocusListener(java.awt.event.FocusListener l)

Removes an focus listener.

Specified by:

removeFocusListener in interface P2DContainerInterface

Parameters:

l - The focus listener.

processFocusEvent

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

Process the focus event.

Specified by:

processFocusEvent in interface P2DContainerInterface

See Also:

Component

processMouseEvent

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

Process the mouse event.

Specified by:

processMouseEvent in interface P2DContainerInterface

See Also:

Component

getMouseListenerArray

public FwkArrayInterface getMouseListenerArray()

Get the array containing the mouse motion listenres.

Specified by:

getMouseListenerArray in interface P2DContainerInterface

Parameters:

The - FwkArrayInterface.

addMouseListener

public void addMouseListener(java.awt.event.MouseListener l)

Adds an MouseMotionListener.

Specified by:

addMouseListener in interface P2DContainerInterface

Parameters:

l - The mouse motion listener.

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener l)

Removes an MouseMotionListener.

Specified by:

removeMouseListener in interface P2DContainerInterface

Parameters:

l - The mouse motion listener.

getMouseMotionListenerArray

public FwkArrayInterface getMouseMotionListenerArray()

Get the array containing the mouse motion listenres.

Specified by:

getMouseMotionListenerArray in interface P2DContainerInterface

Parameters:

The - FwkArrayInterface.

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener l)

Adds an MouseMotionListener.

Specified by:

addMouseMotionListener in interface P2DContainerInterface

Parameters:

l - The mouse motion listener.

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener l)

Removes an MouseMotionListener.

Specified by:

removeMouseMotionListener in interface P2DContainerInterface

Parameters:

l - The mouse motion listener.

getOrderListenerArray

public FwkArrayInterface getOrderListenerArray()

Get the array containing the order listeners.

Specified by:

getOrderListenerArray in interface P2DContainerInterface

Parameters:

The - BrickArrayInterface.

addOrderListener

public void addOrderListener(P2DOrderListenerInterface l)

Adds a order listener.

Specified by:

addOrderListener in interface P2DContainerInterface

Parameters:

l - The order listener.

removeOrderListener

public void removeOrderListener(P2DOrderListenerInterface l)

Removes an order listener.

Specified by:

removeOrderListener in interface P2DContainerInterface

Parameters:

l - The order listener.

fireOrderEvent

public void fireOrderEvent(boolean flag)

Fire an order event.

Specified by:

fireOrderEvent in interface P2DContainerInterface

Parameters:

flag - if true then an popToFront is fired else an pushToButton event.

getListenerArray

public FwkArrayInterface getListenerArray(java.lang.Class clazz)

Get the array containing the order listeners.

Specified by:

getListenerArray in interface P2DContainerInterface

Parameters:

clazz - The listener class.

The - BrickArrayInterface.

addListener

public void addListener(java.lang.Class clazz,
               java.util.EventListener listener)

Adds a order listener.

Specified by:

addListener in interface P2DContainerInterface

Parameters:

clazz - The listener class.

listener - An instance of the listener class.

l - The order listener.

removeListener

public void removeListener(java.lang.Class clazz,
                  java.util.EventListener listener)

Removes an order listener.

Specified by:

removeListener in interface P2DContainerInterface

Parameters:

clazz - The listener class.

listener - An instance of the listener class.

l - The order listener.

revalidate

public void revalidate(boolean recursive)

Revalidate the container.

Specified by:

revalidate in interface P2DContainerInterface

setSelectable

public void setSelectable(boolean flag)

Set the container selectable.

Specified by:

setSelectable in interface P2DContainerInterface

Parameters:

flag - if true the container is selectable.

getSelectable

public boolean getSelectable()

Get a boolean indicates whether the container is selectable.

Specified by:

getSelectable in interface P2DContainerInterface

Returns:

true if the container is selectable.

writeConstructor

public org.w3c.dom.Element writeConstructor(org.w3c.dom.Document document,
                                   FwkXmlDtdInterface dtd,
                                   org.w3c.dom.Node node,
                                   java.util.Map classProperties)

Write a construtor dom node.

Specified by:

writeConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

the create document element.

writeToDOM

public org.w3c.dom.Element writeToDOM(org.w3c.dom.Document document,
                             FwkXmlDtdInterface dtd,
                             org.w3c.dom.Node node,
                             java.util.Map classProperties)

Write the container as child to the given DOM node.

Specified by:

writeToDOM in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

node - The parent node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

The create document element.

readConstructor

public java.lang.Object readConstructor(org.w3c.dom.Document document,
                               org.w3c.dom.Element node)

Read a construtor dom node.

Specified by:

readConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

readFromDOM

public void readFromDOM(org.w3c.dom.Document doc,
               org.w3c.dom.Element element)

Read from DOM

Specified by:

readFromDOM in interface FwkDOMHandlerInterface

writeToXML

public boolean writeToXML(java.lang.String filename,
                 boolean validate)

Writes the canvas to an XML file.

Specified by:

writeToXML in interface FwkDOMHandlerInterface

Parameters:

filename - The name of the xml file.

validate - Write a validated cml file.

readingDOM

public void readingDOM(boolean flag)

Set a flag that the object is currently reading the DOM.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Parameters:

flag - true if the object reads currently fom DOM.

readingDOM

public boolean readingDOM()

Get the DOM reading flag.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Returns:

true if the object reads currently fom DOM.

getShortName

public java.lang.String getShortName()

Get the short name of the container. Use for popupmenu an so on.
This method returns just the name.

Specified by:

getShortName in interface P2DContainerInterface

Returns:

The short name of the component.

saveLastMouseEvent

public void saveLastMouseEvent(java.awt.event.MouseEvent ev)

Save the last mouse event.

Specified by:

saveLastMouseEvent in interface P2DContainerInterface

Parameters:

ev - The mouse event to be saved.

restoreLastMouseEvent

public java.awt.event.MouseEvent restoreLastMouseEvent()

Restore last mouse event.

Specified by:

restoreLastMouseEvent in interface P2DContainerInterface

Returns:

the last mouse event.

openPopupMenu

public boolean openPopupMenu(java.awt.event.MouseEvent ev)

Open the popup menu.

Specified by:

openPopupMenu in interface P2DContainerInterface

Parameters:

ev - The mouse event.

getComponentCommands

public FwkCommandInterface[] getComponentCommands()

Get the commands of all components.

Specified by:

getComponentCommands in interface P2DContainerInterface

Returns:

The commands of all components.