de.uni_paderborn.fujaba.fsa
Class FSAObject

java.lang.Object
  extended byde.uni_paderborn.fujaba.basic.BasicIncrement
      extended byde.uni_paderborn.fujaba.fsa.FSAObject
All Implemented Interfaces:
java.lang.Comparable, java.util.EventListener, ParentListener, java.beans.PropertyChangeListener, UniqueIdentifier
Direct Known Subclasses:
FSAArrow, FSABigArrow, FSACircle, FSAComboBox, FSAComboBoxLabel, FSAContainer, FSADialog, FSADirectionIndicator, FSAFrame, FSALabel, FSASeparator, FSATextComponent, FSATextFieldLabel, FSAWindow

public abstract class FSAObject
extends BasicIncrement
implements java.beans.PropertyChangeListener, ParentListener

FSAObject is the Controller in the MVC UMLUnparseInterface-FSAObject-JComponent. It has an association to a JComponent that visualises (a part of) a UMLUnparseInterface. It can update the JComponent through the appropriate get- and set-Methods of the UMLUnparseInterface, which are specified by the propertyName-Attribute Additionally it has several wrapper methods which simply call the according methods of the jComponent. the several listener methods of FSAObject allow "persistent" handling of listeners. This means, that in case the jComponent changes, the listeners are removed from the old component and added to the new one UMLClass: 'FSAObject'

Version:
$Revision: 1.98.2.7 $
Author:
$Author: lowende $

Field Summary
static java.awt.Color COLOR_BACKGROUND
          No comment provided by developer, please add a comment to improve documentation.
static java.awt.Color COLOR_FOCUSED
          No comment provided by developer, please add a comment to improve documentation.
static java.awt.Color COLOR_FOREGROUND
          No comment provided by developer, please add a comment to improve documentation.
static java.awt.Color COLOR_SELECTED
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String DIMENSION
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String JCOMPONENT_CLIENT_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String LOCATION
          No comment provided by developer, please add a comment to improve documentation.
static boolean TRANSIENT_PROPERTIES_DEFAULT
          default setting: do not save properties
 
Fields inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
dontUseAccessMethodsInThisClass
 
Constructor Summary
FSAObject()
          Constructor for class FSAObject
FSAObject(LogicUnparseInterface incr, java.lang.String propName)
          Constructor for class FSAObject
FSAObject(LogicUnparseInterface incr, java.lang.String propName, javax.swing.JComponent parent)
          Constructor for class FSAObject This is the typical constructor for creating a new FSA instance.
FSAObject(LogicUnparseInterface incr, java.lang.String propName, javax.swing.JComponent parent, boolean transientProperties)
          Constructor for class FSAObject Use this constructor, if you want transient properties to be disabled right at creation time.
FSAObject(LogicUnparseInterface incr, java.lang.String propName, javax.swing.JComponent parent, javax.swing.JComponent myJComponent)
          Constructor for class FSAObject
 
Method Summary
 void addAncestorListener(javax.swing.event.AncestorListener listener)
          Access method for an one to n association.
 void addComponentListener(java.awt.event.ComponentListener listener)
          Access method for an one to n association.
 void addDimensionToUnparseInformation(java.lang.String property, java.awt.Dimension value)
          Access method for an one to n association.
 void addFocusListener(java.awt.event.FocusListener listener)
          Access method for an one to n association.
 void addInputMethodListener(java.awt.event.InputMethodListener listener)
          Access method for an one to n association.
 void addKeyListener(java.awt.event.KeyListener listener)
          Access method for an one to n association.
 void addMouseListener(java.awt.event.MouseListener listener)
          Access method for an one to n association.
 void addMouseMotionListener(java.awt.event.MouseMotionListener listener)
          Access method for an one to n association.
 void addParentListener(ParentListener listener)
          Access method for an one to n association.
 void addPointToUnparseInformation(java.lang.String property, java.awt.Point value)
          Adds data of a Point object (x and y coordinate) to unparse information.
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          add propertychanngelistener for events on this fsaObject and its jComponent The events of the jComponent will have it as source, the events from the fsaObject will have the fsaObject itself.
 void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Access method for an one to n association.
 boolean addToUpdater(AbstractUpdater value)
          Access method for an one to n association.
 void addUnparseInformation(java.lang.String property, java.lang.String value)
          Store textual information in this FSAObject.
 void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Access method for an one to n association.
protected  void applyProperties()
          Read formerly saved properties from logic and apply them to the GUI.
 AbstractUpdater createDefaultUpdater()
          creates an instance of the defaultUpdaterClass, configured with umlIncr, propertyName and the default fsaAttrName.
protected abstract  javax.swing.JComponent createJComponent()
          creates a standard JComponent for this FSAObject UMLMethod: '+ createJComponent () : Void'
 void dragByDelta(int deltaX, int deltaY)
          Drags the JComponent by an offset of x/y, removes the transient-flag and saves the new location.
 void dragTo(int newX, int newY)
          Drags the JComponent to an absolute position, removes the transient-flag and saves the new location.
 FSAObject findChildForProperty(java.lang.String property)
          No comment provided by developer, please add a comment to improve documentation.
static FSAObject findFSAObjectFromJComponent(javax.swing.JComponent comp)
          No comment provided by developer, please add a comment to improve documentation.
protected  void firePropertyChange(java.beans.PropertyChangeEvent e)
          No comment provided by developer, please add a comment to improve documentation.
protected  void firePropertyChange(java.lang.String name, boolean oldValue, boolean newValue)
          No comment provided by developer, please add a comment to improve documentation.
protected  void firePropertyChange(java.lang.String name, double oldValue, double newValue)
          No comment provided by developer, please add a comment to improve documentation.
protected  void firePropertyChange(java.lang.String name, int oldValue, int newValue)
          No comment provided by developer, please add a comment to improve documentation.
protected  void firePropertyChange(java.lang.String name, java.lang.Object oldValue, java.lang.Object newValue)
          No comment provided by developer, please add a comment to improve documentation.
 ASGInformation getASGInformation()
          Get the ASGInformation for the FSAObject
 ASGInformation getASGInformation(boolean create)
          Get the ASGInformation for the FSAObject
 java.awt.Color getBackground()
          Get the background attribute of the FSAObject object
 java.lang.String getDefaultAttrName()
          the default name used in createDefaultUpdater for fsaAttrName of the Updater
 java.lang.Class getDefaultUpdaterClass()
          class of the AbstractUpdater that usually fits best the jComponent
 FSALayeredPane getDiagramRoot()
           
 java.awt.Dimension getDimensionFromUnparseInformation(java.lang.String property)
          Get the dimensionFromUnparseInformation attribute of the FSAObject object
 java.awt.Font getFont()
          Get the font attribute of the FSAObject object
 java.awt.Color getForeground()
          Get the foreground attribute of the FSAObject object
 FSAInterface getFSAInterface()
           
static FSAObject getFSAObjectFromJComponent(javax.swing.JComponent comp)
          Get the fSAObjectFromJComponent attribute of the FSAObject class
 ASGElement getFSAQualifier()
          Get the fSAQualifier attribute of the FSAObject object This function will search this FSAObject objects parents.
static java.lang.String getID(FSAObject object)
          Get the iD attribute of the FSAObject class
 javax.swing.JComponent getJComponent()
          UMLMethod: '+ getJComponent () : Void'
static javax.swing.JComponent getJComponent(FSAObject object)
          Get the jComponent attribute of the FSAObject class
 java.awt.Point getLocation()
           
 java.awt.Point getLocation(java.awt.Point point)
          Get the location attribute of the FSAObject object
 LogicUnparseInterface getLogic()
           
 LogicUnparseInterface getLogic(boolean recursive)
          Get the logic attribute of the FSAObject object
static LogicUnparseInterface getLogicFromJComponent(javax.swing.JComponent comp)
          Get the logicFromJComponent attribute of the FSAObject class
 java.awt.Dimension getMaximumSize()
          Get the maximumSize attribute of the FSAObject object
 java.awt.Dimension getMinimumSize()
          Get the minimumSize attribute of the FSAObject object
 FSAContainer getParent()
          get the parent of this FSAObject.
 java.lang.String getParentID()
          Get the parentID attribute of the FSAObject object
 java.awt.Container getParentOfJComponent()
          Get the Object in the JComponent hierarchy where the JComponent for this Object should be connected to If the JComponent of this instance is non-null the parent of that JComponent is returned.
 java.awt.Point getPointFromUnparseInformation(java.lang.String property)
          Get the pointFromUnparseInformation attribute of the FSAObject object
 java.awt.Dimension getPreferredSize()
          Get the preferredSize attribute of the FSAObject object
 java.lang.String getPropertyName()
          The name of the property in the LogicUnparseInterface that is visualized by this Object's JComponent.
 java.lang.String getQualifiedName()
          Get the qualifiedName attribute of the FSAObject object
static java.lang.String getQualifiedName(FSAObject parent, java.lang.String name)
          Get the qualifiedName attribute of the FSAObject class
 java.awt.Dimension getSize()
           
 java.lang.String getUnparseInformation(java.lang.String property)
          Get the unparseInformation attribute of the FSAObject object
 boolean hasInUpdater(AbstractUpdater value)
          No comment provided by developer, please add a comment to improve documentation.
protected  void initFSAProperties()
          Initializes properties stored in qualifying ASGElement and applies them to this FSAObject.
protected  void initLocation()
          Set the FSAObject to an initial location.
 void invalidate()
          No comment provided by developer, please add a comment to improve documentation.
 boolean isBold()
          returns true if the component has set to bold.
 boolean isDelegated()
           
 boolean isFocused()
           
 boolean isItalic()
          returns true if the component has set to italic.
 boolean isSelected()
           
 boolean isTransientProperties()
          Get the transientProperties attribute of the FSAObject object
 boolean isUnderlined()
          Get the underlined attribute of the FSAObject object
 boolean isVisible()
          Get the visible attribute of the FSAObject object
 java.util.Iterator iteratorOfAncestorListeners()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfComponentListeners()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfFocusListeners()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfInputMethodListeners()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfKeyListeners()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfMouseListeners()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfMouseMotionListeners()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfPropertyChangeListeners()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfPropertyChangeListeners(java.lang.String property)
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfUpdater()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfVetoableChangeListeners()
          No comment provided by developer, please add a comment to improve documentation.
 void parentChanged(ParentEvent evt)
          No comment provided by developer, please add a comment to improve documentation.
 void propertyChange(java.beans.PropertyChangeEvent event)
          forward event to the FujabaPropertyChangeSupport
 void removeAllFromUpdater()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllUnparseInformation()
          Remove all information stored in this FSAObject.
 void removeAncestorListener(javax.swing.event.AncestorListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removeComponentListener(java.awt.event.ComponentListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removeFocusListener(java.awt.event.FocusListener listener)
          No cRomment provided by developer, please add a comment to improve documentation.
 boolean removeFromUnparseInformation(java.lang.String property)
          Remove information from this FSAObject stored under the specified key.
 boolean removeFromUpdater(AbstractUpdater value)
          No comment provided by developer, please add a comment to improve documentation.
 void removeInputMethodListener(java.awt.event.InputMethodListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removeKeyListener(java.awt.event.KeyListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removeMouseListener(java.awt.event.MouseListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removeMouseMotionListener(java.awt.event.MouseMotionListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removeParentListener(ParentListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removePointFromUnparseInformation(java.lang.String property)
          Removes data of a point specified by property from unparse information.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          UMLMethod: '+ removeYou () : Void'
protected  void saveAdditionalFSAProperties()
          Part of 'Template Method'-design pattern for saving FSA-properties.
 void saveDimension()
          Stores dimension of this FSAObject in associated unparse information.
 void saveFSAProperties()
          Part of 'Template Method'-design pattern for saving FSA-properties.
 void saveLocation()
          Stores location of this FSAObject in associated unparse information.
 void setBackground(java.awt.Color color)
          Sets the background attribute of the FSAObject object
 void setBold(boolean bold)
          set the italic flag for this component.
protected  void setDefaultProperties()
          This methods sets the default properties for new FSAObjects.
 void setFocused(boolean focus)
          set this Object focused If this Object is selectable by means of the SelectionManager (SelectionManager.get().isSelectable(this) returns true), it is set as the focused Object in the SelectionManager and the previously focused Object is unfocused.
 void setFont(java.awt.Font newFont)
          Sets the font attribute of the FSAObject object
 void setForeground(java.awt.Color color)
          Sets the foreground attribute of the FSAObject object
 void setFSAInterface(FSAInterface elem)
           
protected static void setFSAObjectFromJComponent(javax.swing.JComponent jComp, FSAObject fsaComp)
          Sets the fSAObjectFromJComponent attribute of the FSAObject class
 void setItalic(boolean italic)
          set the italic flag for this component.
 void setLocation(int x, int y)
          Sets the Location of the JComponent to x,y
 void setLocation(java.awt.Point location)
          Sets the Location of the JComponent to location
 void setLogic(LogicUnparseInterface elem)
          

0..1 swingAdapter 0..1 ---------------- FSAObject ----------------------------| propertyName | LogicUnparseInterface fsaObjects logic ----------------

 void setOpaque(boolean opaque)
          Sets the JComponent's opaque property
 void setParentOfJComponent(java.awt.Container comp)
          Set the Object in the JComponent hierarchy that the JComponent for this Object should be connected to If the JComponent is non-null, it is connected to that parent.
 void setPreferredSize(java.awt.Dimension newDimension)
          Sets the preferredSize attribute of the FSAObject object
 java.lang.String setPropertyName(java.lang.String propertyName)
          The Name of the property in the LogicUnparseInterface The appropriate get- and set-methods for this property are derived from the UMLIncr and are used for the set/getPropertyValue methods and the current propertyValue is cached for use by getPropertyValue ()
 void setSelected(boolean selected)
          Set this object selected Equals to setSelected (selected, false)
 void setTransientProperties(boolean enabled)
          Sets the transientProperties attribute of the FSAObject object.
 void setUnderlined(boolean newUnderlined)
          Sets the underlined attribute of the FSAObject object
 void setVisible(boolean vis)
          Sets the visible attribute of the FSAObject object
 int sizeOfUpdater()
          No comment provided by developer, please add a comment to improve documentation.
 java.lang.String toString()
          No comment provided by developer, please add a comment to improve documentation.
 
Methods inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
compareTo, getID, getUniqueID, getUniqueID, isGenerated, lessUniqueId, readAttributes, readAttributes, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, resetClassInfos, resetFieldWriteMethods, setAttribValue, setAttribValue, setGenerated, setID, setUniqueId, writeAttributes, writeClassToStringBuffer, writeClassToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

JCOMPONENT_CLIENT_PROPERTY

public static final java.lang.String JCOMPONENT_CLIENT_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

COLOR_FOREGROUND

public static final java.awt.Color COLOR_FOREGROUND
No comment provided by developer, please add a comment to improve documentation.


COLOR_BACKGROUND

public static final java.awt.Color COLOR_BACKGROUND
No comment provided by developer, please add a comment to improve documentation.


COLOR_FOCUSED

public static final java.awt.Color COLOR_FOCUSED
No comment provided by developer, please add a comment to improve documentation.


COLOR_SELECTED

public static final java.awt.Color COLOR_SELECTED
No comment provided by developer, please add a comment to improve documentation.


LOCATION

public static final java.lang.String LOCATION
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

DIMENSION

public static final java.lang.String DIMENSION
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

TRANSIENT_PROPERTIES_DEFAULT

public static transient boolean TRANSIENT_PROPERTIES_DEFAULT
default setting: do not save properties

Constructor Detail

FSAObject

public FSAObject()
Constructor for class FSAObject


FSAObject

public FSAObject(LogicUnparseInterface incr,
                 java.lang.String propName)
Constructor for class FSAObject

Parameters:
incr - No description provided
propName - No description provided

FSAObject

public FSAObject(LogicUnparseInterface incr,
                 java.lang.String propName,
                 javax.swing.JComponent parent)
Constructor for class FSAObject This is the typical constructor for creating a new FSA instance.

Parameters:
incr - No description provided
propName - No description provided
parent - No description provided

FSAObject

public FSAObject(LogicUnparseInterface incr,
                 java.lang.String propName,
                 javax.swing.JComponent parent,
                 boolean transientProperties)
Constructor for class FSAObject Use this constructor, if you want transient properties to be disabled right at creation time. Use this constructor to store initial-location of FSAObject. Otherwise transientProperties must be disabled and FSAObject#saveLocation() must be called, if initial-location should be saved.

Parameters:
incr - Defines the logic for this FSAObject.
propName - No description provided
parent - Parent of this FSAObject.
transientProperties - Should properties of this FSAObject be transient?

FSAObject

public FSAObject(LogicUnparseInterface incr,
                 java.lang.String propName,
                 javax.swing.JComponent parent,
                 javax.swing.JComponent myJComponent)
Constructor for class FSAObject

Parameters:
incr - No description provided
propName - No description provided
parent - No description provided
myJComponent - No description provided
Method Detail

getFSAQualifier

public ASGElement getFSAQualifier()
Get the fSAQualifier attribute of the FSAObject object
 This function will search this FSAObject objects parents.
 The first parent which is a ASGDiagram will be returned.
 If this FSAObject has no ASGDiagram-parent the first ASGElement
 contained in this FSAObject objects parent-chain will be returned.
 If none of the former described objects exist, null is returned.
 

Returns:
The fSAQualifier value

getASGInformation

public ASGInformation getASGInformation()
Get the ASGInformation for the FSAObject

Returns:
The associated ASGInformation, null if not created yet

getASGInformation

public ASGInformation getASGInformation(boolean create)
Get the ASGInformation for the FSAObject

Parameters:
create - create the ASGInformation if it does not exist
Returns:
The associated ASGInformation, null if not created yet

getUnparseInformation

public java.lang.String getUnparseInformation(java.lang.String property)
Get the unparseInformation attribute of the FSAObject object

Parameters:
property - No description provided
Returns:
The unparseInformation value

addUnparseInformation

public void addUnparseInformation(java.lang.String property,
                                  java.lang.String value)
Store textual information in this FSAObject.

Parameters:
property - Key under which information is stored.
value - The String object to be added.

removeFromUnparseInformation

public boolean removeFromUnparseInformation(java.lang.String property)
Remove information from this FSAObject stored under the specified key.

Parameters:
property - Key under which information is stored.
Returns:
A boolean value specifying whether information has been removed.

removeAllUnparseInformation

public void removeAllUnparseInformation()
Remove all information stored in this FSAObject.


addPointToUnparseInformation

public void addPointToUnparseInformation(java.lang.String property,
                                         java.awt.Point value)
Adds data of a Point object (x and y coordinate) to unparse information.

Parameters:
property - Key for the point to be added.
value - The Point object whose data should be stored.
See Also:
removePointFromUnparseInformation(String)

removePointFromUnparseInformation

public boolean removePointFromUnparseInformation(java.lang.String property)
Removes data of a point specified by property from unparse information.

Parameters:
property - The key for the point to be removed.
Returns:
A boolean value specifying whether the point was deleted. The point has been deleted, if at least x or y - position could be removed from unparse information.
See Also:
addPointToUnparseInformation(String, Point)

getPointFromUnparseInformation

public java.awt.Point getPointFromUnparseInformation(java.lang.String property)
Get the pointFromUnparseInformation attribute of the FSAObject object

Parameters:
property - No description provided
Returns:
The pointFromUnparseInformation value

addDimensionToUnparseInformation

public void addDimensionToUnparseInformation(java.lang.String property,
                                             java.awt.Dimension value)
Access method for an one to n association.

Parameters:
property - The object added.
value - The object added.

getDimensionFromUnparseInformation

public java.awt.Dimension getDimensionFromUnparseInformation(java.lang.String property)
Get the dimensionFromUnparseInformation attribute of the FSAObject object

Parameters:
property - No description provided
Returns:
The dimensionFromUnparseInformation value

initFSAProperties

protected void initFSAProperties()
Initializes properties stored in qualifying ASGElement and applies them to this FSAObject. Calls 'Template Method' applyProperties() if this FSAObject is restored from ASGElement information. If this FSAObject is a new one (it has no stored properties) a new location will be given to this FSAObject. If properties aren't transient, this initial location will be stored.


setDefaultProperties

protected void setDefaultProperties()
This methods sets the default properties for new FSAObjects.


initLocation

protected void initLocation()
Set the FSAObject to an initial location. This is a template method that may be overwritten by a child-class. This basic implementation tries to set the FSAObject to the last pointer-position. If no last pointer-position is found, it will be set to a random location.


applyProperties

protected void applyProperties()
Read formerly saved properties from logic and apply them to the GUI. Objects derived from FSAObject that save additional FSA-properties should override this method, so these properties will be loaded when necessary.
 NOTE: If information changes in logic, ASGInformationListener will
 call 'applyProperties()' to adjust this graphical instance.
 So don't override 'initFSAProperties()', because this method
 won't be called when information changes in logic. Instead override
 'applyProperties()', so e.g. an 'undo'-call will result in
 applying undo-properties to child-classes instead of just applying
 properties to FSAObject.
 

See Also:
saveAdditionalFSAProperties()

isTransientProperties

public boolean isTransientProperties()
Get the transientProperties attribute of the FSAObject object

Returns:
The transientProperties value

setTransientProperties

public void setTransientProperties(boolean enabled)
Sets the transientProperties attribute of the FSAObject object. If enabled, properties (such as location) will be persistent. If transientProperties are enabled, all unparse information will be removed by this call.
 Note that properties must be saved by an explicit call to
 'saveFSAProperties()' or another finegranular 'save'-call.
 

Parameters:
enabled - The new transientProperties value

saveFSAProperties

public void saveFSAProperties()
Part of 'Template Method'-design pattern for saving FSA-properties. If properties for this FSAObject object are transient, this method removes all unparse information. Otherwise it calls all own primitive save-methods. Then 'saveAdditionalFSAProperties()' is called, which should be implemented by a concrete FSAObject, that wants to save some additional properties.

See Also:
saveAdditionalFSAProperties(), applyProperties()

saveLocation

public void saveLocation()
Stores location of this FSAObject in associated unparse information.


saveDimension

public void saveDimension()
Stores dimension of this FSAObject in associated unparse information.


saveAdditionalFSAProperties

protected void saveAdditionalFSAProperties()
Part of 'Template Method'-design pattern for saving FSA-properties. Should be implemented only by child-classes that have additional properties to be saved. Will be called from within method 'saveFSAProperties()'. Allows fine-granular saving of FSA-properties.

See Also:
saveFSAProperties(), applyProperties()

getDefaultUpdaterClass

public java.lang.Class getDefaultUpdaterClass()
class of the AbstractUpdater that usually fits best the jComponent

Returns:
The defaultUpdaterClass value

createDefaultUpdater

public AbstractUpdater createDefaultUpdater()
creates an instance of the defaultUpdaterClass, configured with umlIncr, propertyName and the default fsaAttrName.

Just add it to the updaters to activate it.

Returns:
an instance of the defaultUpdaterClass ready to be used

getDefaultAttrName

public java.lang.String getDefaultAttrName()
the default name used in createDefaultUpdater for fsaAttrName of the Updater

Returns:
The defaultAttrName value

getPropertyName

public java.lang.String getPropertyName()
The name of the property in the LogicUnparseInterface that is visualized by this Object's JComponent. Defaults to value of getID(). UMLMethod: 'Read access method for attribute propertyName : String'

Returns:
The propertyName value

setPropertyName

public java.lang.String setPropertyName(java.lang.String propertyName)
The Name of the property in the LogicUnparseInterface The appropriate get- and set-methods for this property are derived from the UMLIncr and are used for the set/getPropertyValue methods and the current propertyValue is cached for use by getPropertyValue ()

Parameters:
propertyName - The new propertyName value
Returns:
No description provided
See Also:
getPropertyName()

getParentID

public java.lang.String getParentID()
Get the parentID attribute of the FSAObject object

Returns:
The parentID value

getID

public static java.lang.String getID(FSAObject object)
Get the iD attribute of the FSAObject class

Parameters:
object - No description provided
Returns:
The iD value

getQualifiedName

public java.lang.String getQualifiedName()
Get the qualifiedName attribute of the FSAObject object

Returns:
The qualifiedName value

getQualifiedName

public static java.lang.String getQualifiedName(FSAObject parent,
                                                java.lang.String name)
Get the qualifiedName attribute of the FSAObject class

Parameters:
parent - No description provided
name - No description provided
Returns:
The qualifiedName value

createJComponent

protected abstract javax.swing.JComponent createJComponent()
creates a standard JComponent for this FSAObject UMLMethod: '+ createJComponent () : Void'

Returns:
No description provided

getJComponent

public javax.swing.JComponent getJComponent()
UMLMethod: '+ getJComponent () : Void'

Returns:
The jComponent value

getJComponent

public static javax.swing.JComponent getJComponent(FSAObject object)
Get the jComponent attribute of the FSAObject class

Parameters:
object - No description provided
Returns:
The jComponent value

getParentOfJComponent

public java.awt.Container getParentOfJComponent()
Get the Object in the JComponent hierarchy where the JComponent for this Object should be connected to If the JComponent of this instance is non-null the parent of that JComponent is returned. Otherwise the value last set by setParentOfJComonent() is returned.

Returns:
The parentOfJComponent value
See Also:
setParentOfJComponent(java.awt.Container)

setParentOfJComponent

public void setParentOfJComponent(java.awt.Container comp)
Set the Object in the JComponent hierarchy that the JComponent for this Object should be connected to If the JComponent is non-null, it is connected to that parent. Otherwise it is stored for later use by setJComponent()

Parameters:
comp - The new parentOfJComponent value
See Also:
getParentOfJComponent()

getLogicFromJComponent

public static LogicUnparseInterface getLogicFromJComponent(javax.swing.JComponent comp)
Get the logicFromJComponent attribute of the FSAObject class

Parameters:
comp - No description provided
Returns:
The logicFromJComponent value

findFSAObjectFromJComponent

public static FSAObject findFSAObjectFromJComponent(javax.swing.JComponent comp)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
comp - No description provided
Returns:
No description provided

getFSAObjectFromJComponent

public static FSAObject getFSAObjectFromJComponent(javax.swing.JComponent comp)
Get the fSAObjectFromJComponent attribute of the FSAObject class

Parameters:
comp - No description provided
Returns:
The fSAObjectFromJComponent value

setFSAObjectFromJComponent

protected static void setFSAObjectFromJComponent(javax.swing.JComponent jComp,
                                                 FSAObject fsaComp)
Sets the fSAObjectFromJComponent attribute of the FSAObject class

Parameters:
jComp - The new fSAObjectFromJComponent value
fsaComp - The new fSAObjectFromJComponent value

findChildForProperty

public FSAObject findChildForProperty(java.lang.String property)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
property - No description provided
Returns:
No description provided

getDiagramRoot

public FSALayeredPane getDiagramRoot()
Returns:
the highest FSALayeredPane in the hierarchy

getParent

public FSAContainer getParent()
get the parent of this FSAObject.

There is no setParent-Method, because the hierarchy of FSAObjects is based on the hierarchy of the underlying JComponents. A path from a FSAObject to its parent may spread over more than one JComponent - making a setParent-Method semantically ambiguous.

Returns:
the parent of this FSAObject

getPreferredSize

public java.awt.Dimension getPreferredSize()
Get the preferredSize attribute of the FSAObject object

Returns:
The preferredSize value

setPreferredSize

public void setPreferredSize(java.awt.Dimension newDimension)
Sets the preferredSize attribute of the FSAObject object

Parameters:
newDimension - The new preferredSize value

getMinimumSize

public java.awt.Dimension getMinimumSize()
Get the minimumSize attribute of the FSAObject object

Returns:
The minimumSize value

getMaximumSize

public java.awt.Dimension getMaximumSize()
Get the maximumSize attribute of the FSAObject object

Returns:
The maximumSize value

setSelected

public void setSelected(boolean selected)
Set this object selected Equals to setSelected (selected, false)

Parameters:
selected - The new selected value

isSelected

public boolean isSelected()
Returns:
true, if this object is selected
See Also:
(boolean)

setFocused

public void setFocused(boolean focus)
set this Object focused If this Object is selectable by means of the SelectionManager (SelectionManager.get().isSelectable(this) returns true), it is set as the focused Object in the SelectionManager and the previously focused Object is unfocused. If this Object is not yet selected, it is selected, too.

Parameters:
focus - The new focused value
See Also:
SelectionManager, (boolean), ()

isFocused

public boolean isFocused()
Returns:
true, if this object is focused
See Also:
(boolean)

setFSAInterface

public void setFSAInterface(FSAInterface elem)
Parameters:
elem - The new fSAInterface value

getFSAInterface

public FSAInterface getFSAInterface()
Returns:
The fSAInterface value

setLogic

public void setLogic(LogicUnparseInterface elem)
 

0..1 swingAdapter 0..1 ---------------- FSAObject ----------------------------| propertyName | LogicUnparseInterface fsaObjects logic ----------------

Parameters:
elem - The new logic value

getLogic

public LogicUnparseInterface getLogic()
Returns:
The logic value

getLogic

public LogicUnparseInterface getLogic(boolean recursive)
Get the logic attribute of the FSAObject object

Parameters:
recursive - No description provided
Returns:
The logic value FIXME: recursive flag isn't used in implementation

addToUpdater

public boolean addToUpdater(AbstractUpdater value)
Access method for an one to n association.

Parameters:
value - The object added.
Returns:
No description provided

hasInUpdater

public boolean hasInUpdater(AbstractUpdater value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

iteratorOfUpdater

public java.util.Iterator iteratorOfUpdater()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

sizeOfUpdater

public int sizeOfUpdater()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

removeFromUpdater

public boolean removeFromUpdater(AbstractUpdater value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

removeAllFromUpdater

public void removeAllFromUpdater()
No comment provided by developer, please add a comment to improve documentation.


removeYou

public void removeYou()
UMLMethod: '+ removeYou () : Void'

Overrides:
removeYou in class BasicIncrement

isDelegated

public boolean isDelegated()
Returns:
true if this is a delegated component

addParentListener

public void addParentListener(ParentListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeParentListener

public void removeParentListener(ParentListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

parentChanged

public void parentChanged(ParentEvent evt)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
parentChanged in interface ParentListener
Parameters:
evt - No description provided

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
add propertychanngelistener for events on this fsaObject and its jComponent

The events of the jComponent will have it as source, the events from the fsaObject will have the fsaObject itself.

A FujabaPropertyChangeSupport is used to organize listeners and to avoid redundant listener registrations

Parameters:
listener - The object added.

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
Access method for an one to n association.

Parameters:
propertyName - The object added.
listener - The object added.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
propertyName - No description provided
listener - No description provided

iteratorOfPropertyChangeListeners

public java.util.Iterator iteratorOfPropertyChangeListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

iteratorOfPropertyChangeListeners

public java.util.Iterator iteratorOfPropertyChangeListeners(java.lang.String property)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
property - No description provided
Returns:
No description provided

firePropertyChange

protected void firePropertyChange(java.beans.PropertyChangeEvent e)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
e - No description provided

firePropertyChange

protected void firePropertyChange(java.lang.String name,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
name - No description provided
oldValue - No description provided
newValue - No description provided

firePropertyChange

protected void firePropertyChange(java.lang.String name,
                                  boolean oldValue,
                                  boolean newValue)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
name - No description provided
oldValue - No description provided
newValue - No description provided

firePropertyChange

protected void firePropertyChange(java.lang.String name,
                                  int oldValue,
                                  int newValue)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
name - No description provided
oldValue - No description provided
newValue - No description provided

firePropertyChange

protected void firePropertyChange(java.lang.String name,
                                  double oldValue,
                                  double newValue)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
name - No description provided
oldValue - No description provided
newValue - No description provided

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)
forward event to the FujabaPropertyChangeSupport

Specified by:
propertyChange in interface java.beans.PropertyChangeListener
Parameters:
event - No description provided

addAncestorListener

public void addAncestorListener(javax.swing.event.AncestorListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeAncestorListener

public void removeAncestorListener(javax.swing.event.AncestorListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

iteratorOfAncestorListeners

public java.util.Iterator iteratorOfAncestorListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

iteratorOfVetoableChangeListeners

public java.util.Iterator iteratorOfVetoableChangeListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

addComponentListener

public void addComponentListener(java.awt.event.ComponentListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeComponentListener

public void removeComponentListener(java.awt.event.ComponentListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

iteratorOfComponentListeners

public java.util.Iterator iteratorOfComponentListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

addFocusListener

public void addFocusListener(java.awt.event.FocusListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeFocusListener

public void removeFocusListener(java.awt.event.FocusListener listener)
No cRomment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

iteratorOfFocusListeners

public java.util.Iterator iteratorOfFocusListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

addInputMethodListener

public void addInputMethodListener(java.awt.event.InputMethodListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeInputMethodListener

public void removeInputMethodListener(java.awt.event.InputMethodListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

iteratorOfInputMethodListeners

public java.util.Iterator iteratorOfInputMethodListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

addKeyListener

public void addKeyListener(java.awt.event.KeyListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeKeyListener

public void removeKeyListener(java.awt.event.KeyListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

iteratorOfKeyListeners

public java.util.Iterator iteratorOfKeyListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

addMouseListener

public void addMouseListener(java.awt.event.MouseListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

iteratorOfMouseListeners

public java.util.Iterator iteratorOfMouseListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener listener)
Access method for an one to n association.

Parameters:
listener - The object added.

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener listener)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
listener - No description provided

iteratorOfMouseMotionListeners

public java.util.Iterator iteratorOfMouseMotionListeners()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

setVisible

public void setVisible(boolean vis)
Sets the visible attribute of the FSAObject object

Parameters:
vis - The new visible value

isVisible

public boolean isVisible()
Get the visible attribute of the FSAObject object

Returns:
The visible value

setForeground

public void setForeground(java.awt.Color color)
Sets the foreground attribute of the FSAObject object

Parameters:
color - The new foreground value

getForeground

public java.awt.Color getForeground()
Get the foreground attribute of the FSAObject object

Returns:
The foreground value

setBackground

public void setBackground(java.awt.Color color)
Sets the background attribute of the FSAObject object

Parameters:
color - The new background value

getBackground

public java.awt.Color getBackground()
Get the background attribute of the FSAObject object

Returns:
The background value

invalidate

public void invalidate()
No comment provided by developer, please add a comment to improve documentation.


setLocation

public final void setLocation(java.awt.Point location)
Sets the Location of the JComponent to location

Parameters:
location - The new location value

setLocation

public void setLocation(int x,
                        int y)
Sets the Location of the JComponent to x,y

Parameters:
x - The new location value
y - The new location value

getLocation

public java.awt.Point getLocation()
Returns:
the Location of the JComponent or null if the JComponent is null

getSize

public java.awt.Dimension getSize()
Returns:
the size of the JComponent or null if the JComponent is null

getLocation

public java.awt.Point getLocation(java.awt.Point point)
Get the location attribute of the FSAObject object

Parameters:
point - No description provided
Returns:
The location value

dragTo

public void dragTo(int newX,
                   int newY)
Drags the JComponent to an absolute position, removes the transient-flag and saves the new location.

Parameters:
newX - No description provided
newY - No description provided

dragByDelta

public void dragByDelta(int deltaX,
                        int deltaY)
Drags the JComponent by an offset of x/y, removes the transient-flag and saves the new location.

Parameters:
deltaX - No description provided
deltaY - No description provided

setOpaque

public void setOpaque(boolean opaque)
Sets the JComponent's opaque property

Parameters:
opaque - The new opaque value

setFont

public void setFont(java.awt.Font newFont)
Sets the font attribute of the FSAObject object

Parameters:
newFont - The new font value

getFont

public java.awt.Font getFont()
Get the font attribute of the FSAObject object

Returns:
The font value

setItalic

public void setItalic(boolean italic)
set the italic flag for this component.

Parameters:
italic - the flag.

isItalic

public boolean isItalic()
returns true if the component has set to italic.

Returns:
true if the component is italic.

setBold

public void setBold(boolean bold)
set the italic flag for this component.

Parameters:
bold - The new bold value

isBold

public boolean isBold()
returns true if the component has set to bold.

Returns:
true if the component is bold.

isUnderlined

public boolean isUnderlined()
Get the underlined attribute of the FSAObject object

Returns:
The underlined value

setUnderlined

public void setUnderlined(boolean newUnderlined)
Sets the underlined attribute of the FSAObject object

Parameters:
newUnderlined - The new underlined value

toString

public java.lang.String toString()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided