com.highqsoft.interfaces.p2d

Interface P2DContainerInterface

All Superinterfaces:

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

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface P2DContainerInterface
extends FwkInfoBusMemberInterface, FwkDOMHandlerInterface

The interface for the P2DContainer object. It is a P2D object that can contain P2DComponents.

Since:

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

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

Field Summary

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

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 MouseListener.
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.
void	addRepaintListener(P2DRepaintListenerInterface listener) Add a repaint listener.
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.
FwkCommandInterface[]	getComponentCommands() Get the commands of all components.
FwkArrayInterface	getContainerListenerArray() Get the array containing the container listeners.
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 listeners.
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.
boolean	openPopupMenu(java.awt.event.MouseEvent ev) Open the popup menu.
void	processFocusEvent(java.awt.event.FocusEvent e) Process the mouse event.
void	processMouseEvent(java.awt.event.MouseEvent e) Process the mouse event.
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 MouseListener.
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.
java.awt.geom.Point2D	restoreLocalMousePoint() Restore local mouse point.
void	revalidate(boolean recursive) Revalidate the container.
void	saveLastMouseEvent(java.awt.event.MouseEvent ev) Save the last mouse event.
void	saveLocalMousePoint(java.awt.geom.Point2D p) Save the local mouse point.
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).
void	unregister() Unregister the container.

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

Method Detail

getP2DComponents

FwkArrayInterface getP2DComponents()

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

Returns:

an array of all the components in this container.

unregister

void unregister()

Unregister the container.

getP2DComponentArray

FwkArrayInterface getP2DComponentArray()

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

Returns:

an array of all the components in this container.

addP2D

P2DContainerInterface addP2D(P2DContainerInterface comp)

Adds the specified component to the end of this container.

Parameters:

comp - the component to be added.

Returns:

the component argument.

addP2D

P2DContainerInterface addP2D(java.lang.String name)

Adds the specified component to the end of this container.

Parameters:

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

Returns:

the component argument.

addP2D

P2DContainerInterface addP2D(P2DContainerInterface comp,
                           int index)

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

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

addP2D

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

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

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)

removeP2D

P2DContainerInterface removeP2D(int index)

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

Parameters:

index - the index of the component to be removed.

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

See Also:

#add

removeP2D

P2DContainerInterface removeP2D(P2DContainerInterface comp)

Removes the specified component from this container.

Parameters:

comp - the component to be removed

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

See Also:

#add

removeAllP2D

void removeAllP2D()

Removes all the components from this container.

See Also:

#add, #remove

getP2D

P2DContainerInterface getP2D(int index)

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

Parameters:

index - the index of the component to be retrieved.

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

See Also:

#add

getP2D

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

Retrieves the specified component class from this container.

Parameters:

clazz - the child class.

an - array containing component implementing the specified class.

getP2D

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

Retrieves the specified component class from this container.

Parameters:

clazz - the child class.

name - the name of the component.

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

toFront

void toFront()

Move this component to front inside the parent container.

toFront

void toFront(int index)

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

Parameters:

index - The index of the component to be moved.

toFront

void toFront(P2DContainerInterface container)

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

Parameters:

container - The component to be moved.

toBack

void toBack()

Move this component to back inside the parent container.

toBack

void toBack(int index)

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

Parameters:

index - The index of the component to be moved.

toBack

void toBack(P2DContainerInterface container)

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

Parameters:

container - The component to be moved.

setParentContainer

void setParentContainer(P2DContainerInterface container)

Set the parent container of the component.

Parameters:

container - The parent container.

See Also:

getParent

getParentContainer

P2DContainerInterface getParentContainer()

Get the parent container of this component.

Returns:

The parent container of the component.

See Also:

setParent

processMouseEvent

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

Process the mouse event.

See Also:

Component

processFocusEvent

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

Process the mouse event.

See Also:

Component

getAllArmedComponents

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

return all armed component.

Parameters:

p - The armed coordinates.

arr - The array to collect all armed components.

getAllArmedComponents

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

return all armed component.

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

P2DContainerInterface getArmedComponent(double x,
                                      double y)

return the armed component.

Returns:

The component or null if no component is armed.

setActiveComponent

void setActiveComponent(P2DContainerInterface container,
                      P2DContainerInterface component)

Set the active component.

Parameters:

component - The component.

getActiveComponent

P2DContainerInterface getActiveComponent(P2DContainerInterface container)

Get the active component.

Returns:

The component.

getMouseListenerArray

FwkArrayInterface getMouseListenerArray()

Get the array containing the mouse motion listenres.

Parameters:

The - FwkArrayInterface.

addMouseListener

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

Adds an MouseListener.

Parameters:

l - The mouse motion listener.

removeMouseListener

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

Removes an MouseListener.

Parameters:

l - The mouse motion listener.

getMouseMotionListenerArray

FwkArrayInterface getMouseMotionListenerArray()

Get the array containing the mouse listeners.

Parameters:

The - FwkArrayInterface.

addMouseMotionListener

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

Adds an MouseMotionListener.

Parameters:

l - The mouse motion listener.

removeMouseMotionListener

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

Removes an MouseMotionListener.

Parameters:

l - The mouse motion listener.

getFocusListenerArray

FwkArrayInterface getFocusListenerArray()

Get the array containing the focus listenres.

Parameters:

The - FwkArrayInterface.

addFocusListener

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

Adds a focus listener.

Parameters:

l - The focus listener.

removeFocusListener

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

Removes an focus listener.

Parameters:

l - The focus listener.

addRepaintListener

void addRepaintListener(P2DRepaintListenerInterface listener)

Add a repaint listener.

Parameters:

listener - the repaint listener.

removeRepaintListener

void removeRepaintListener(P2DRepaintListenerInterface listener)

Remove a repaint listener.

Parameters:

listener - the repaint listener.

getRepaintListenerArray

FwkArrayInterface getRepaintListenerArray()

Get the array containing the repaint listeners.

Parameters:

The - FwkArrayInterface.

addContainerListener

void addContainerListener(P2DContainerListenerInterface listener)

Add a container listener.

Parameters:

listener - the container listener.

removeContainerListener

void removeContainerListener(P2DContainerListenerInterface listener)

Remove a container listener.

Parameters:

listener - the container listener.

getContainerListenerArray

FwkArrayInterface getContainerListenerArray()

Get the array containing the container listeners.

Parameters:

The - FwkArrayInterface.

repaint

void repaint()

Repaint the container.

getTreeLock

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.

Returns:

This component's locking object.

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.

getOrderListenerArray

FwkArrayInterface getOrderListenerArray()

Get the array containing the order listeners.

Parameters:

The - BrickArrayInterface.

addOrderListener

void addOrderListener(P2DOrderListenerInterface l)

Adds a order listener.

Parameters:

l - The order listener.

removeOrderListener

void removeOrderListener(P2DOrderListenerInterface l)

Removes an order listener.

Parameters:

l - The order listener.

fireOrderEvent

void fireOrderEvent(boolean flag)

Fire an order event.

Parameters:

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

getListenerArray

FwkArrayInterface getListenerArray(java.lang.Class clazz)

Get the array containing the order listeners.

Parameters:

clazz - The listener class.

The - BrickArrayInterface.

addListener

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

Adds a order listener.

Parameters:

clazz - The listener class.

listener - An instance of the listener class.

l - The order listener.

removeListener

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

Removes an order listener.

Parameters:

clazz - The listener class.

listener - An instance of the listener class.

l - The order listener.

revalidate

void revalidate(boolean recursive)

Revalidate the container.

setSelectable

void setSelectable(boolean flag)

Set the container selectable.

Parameters:

flag - if true the container is selectable.

getSelectable

boolean getSelectable()

Get a boolean indicates whether the container is selectable.

Returns:

true if the container is selectable.

openPopupMenu

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

Open the popup menu.

Parameters:

ev - The mouse event.

true - if operation was successful.

getShortName

java.lang.String getShortName()

Get the short name of the container. Use for popupmenu an so on.

Returns:

The short name of the component.

saveLastMouseEvent

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

Save the last mouse event.

Parameters:

ev - The mouse event to be saved.

restoreLastMouseEvent

java.awt.event.MouseEvent restoreLastMouseEvent()

Restore last mouse event.

Returns:

the last mouse event.

saveLocalMousePoint

void saveLocalMousePoint(java.awt.geom.Point2D p)

Save the local mouse point.

Parameters:

p - The local mouse point to be saved.

restoreLocalMousePoint

java.awt.geom.Point2D restoreLocalMousePoint()

Restore local mouse point.

Returns:

the last local mouse point.

getComponentCommands

FwkCommandInterface[] getComponentCommands()

Get the commands of all components.

Returns:

The commands of all components.