org.openbp.cockpit.modeler.figures.generic
Class FixedTitleFigure

java.lang.Object
  CH.ifa.draw.standard.AbstractFigure
      org.openbp.cockpit.modeler.figures.generic.BasicFigure
          org.openbp.cockpit.modeler.figures.generic.XTextFigure
              org.openbp.cockpit.modeler.figures.generic.FixedTitleFigure

All Implemented Interfaces:

CH.ifa.draw.framework.Figure, CH.ifa.draw.util.Storable, java.io.Serializable, java.lang.Cloneable, ChildFigure, Colorizable, TitleFigure, UpdatableFigure

public class FixedTitleFigure
extends XTextFigure
implements TitleFigure

Fixed width/height text figure that is connected to a given display object (the client) and displays either the name or the display text of the object.

Author:

Heiko Erhardt

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openbp.cockpit.modeler.figures.generic.XTextFigure

displayBoxCache, HANDLE_DISTANCE, originX, originY

Fields inherited from class org.openbp.cockpit.modeler.figures.generic.BasicFigure

DECO_FILLCOLOR, DECO_OVERLAY

Fields inherited from interface CH.ifa.draw.framework.Figure

POPUP_MENU

Constructor Summary

FixedTitleFigure()
Default constructor.

FixedTitleFigure(DisplayObject client)
Constructor.

Method Summary

DisplayObject	getClient() Gets the the display object we are connected with.
java.lang.String	getTitleFormat() Gets the title format.
boolean	isVerboseDisplay() Gets the flag if the display text or the object name should be displayed if there is no display name of the client object.
void	setClient(DisplayObject client) Sets the the display object we are connected with.
void	setTitleFormat(java.lang.String titleFormat) Sets the title format.
void	setVerboseDisplay(boolean verboseDisplay) Sets the flag if the display text or the object name should be displayed if there is no display name of the client object.
void	updateFigure() Synchronizes this figure with its provider, i\.e\. the object that is represented by the figure.

Methods inherited from class org.openbp.cockpit.modeler.figures.generic.XTextFigure

basicDisplayBox, basicMoveBy, createGeometry, displayBox, drawFigure, getAlignment, getFont, getFontSize, getText, handles, invalidate, isAutoSize, parseGeometry, parseParameter, setAlignment, setAutoSize, setFont, setFontSize, setText

Methods inherited from class org.openbp.cockpit.modeler.figures.generic.BasicFigure

clone, decorateValue, draw, getDecorationOwner, getDefaultFillColor, getFillColor, getParent, setFillColor, setParent

Methods inherited from class CH.ifa.draw.standard.AbstractFigure

addFigureChangeListener, addToContainer, canConnect, center, changed, connectedTextLocator, connectionInsets, connectorAt, connectorVisibility, containsPoint, decompose, displayBox, displayBox, figures, findFigureInside, getAttribute, getZValue, includes, isEmpty, listener, moveBy, read, release, removeFigureChangeListener, removeFromContainer, setAttribute, setZValue, size, willChange, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openbp.cockpit.modeler.figures.generic.TitleFigure

getText, setText

Methods inherited from interface CH.ifa.draw.framework.Figure

addFigureChangeListener, addToContainer, basicDisplayBox, canConnect, center, changed, clone, connectedTextLocator, connectionInsets, connectorAt, connectorVisibility, containsPoint, decompose, displayBox, displayBox, displayBox, draw, figures, findFigureInside, getAttribute, getZValue, handles, includes, invalidate, isEmpty, listener, moveBy, release, removeFigureChangeListener, removeFromContainer, setAttribute, setZValue, size, willChange

Methods inherited from interface CH.ifa.draw.util.Storable

read, write

Constructor Detail

FixedTitleFigure

public FixedTitleFigure()

Default constructor.

FixedTitleFigure

public FixedTitleFigure(DisplayObject client)

Constructor.

Parameters:

client - The display object we are connected with

Method Detail

updateFigure

public void updateFigure()

Description copied from interface: UpdatableFigure

Synchronizes this figure with its provider, i\.e\. the object that is represented by the figure. Updates the figure according to the current properties of the provider.

Specified by:

updateFigure in interface UpdatableFigure

getClient

public DisplayObject getClient()

Description copied from interface: TitleFigure

Gets the the display object we are connected with.

Specified by:

getClient in interface TitleFigure

setClient

public void setClient(DisplayObject client)

Description copied from interface: TitleFigure

Sets the the display object we are connected with.

Specified by:

setClient in interface TitleFigure

getTitleFormat

public java.lang.String getTitleFormat()

Description copied from interface: TitleFigure

Gets the title format. The title format determines how the title is to be formatted. The following placehodlers apply:
$name - Name of the underlying DisplayObject
$text - Display text (i. e. display name or name) of the underlying DisplayObject

Specified by:

getTitleFormat in interface TitleFigure

setTitleFormat

public void setTitleFormat(java.lang.String titleFormat)

Description copied from interface: TitleFigure

Sets the title format. The title format determines how the title is to be formatted. The following placehodlers apply:
$name - Name of the underlying DisplayObject
$text - Display text (i. e. display name or name) of the underlying DisplayObject

Specified by:

setTitleFormat in interface TitleFigure

isVerboseDisplay

public boolean isVerboseDisplay()

Description copied from interface: TitleFigure

Gets the flag if the display text or the object name should be displayed if there is no display name of the client object.

Specified by:

isVerboseDisplay in interface TitleFigure

setVerboseDisplay

public void setVerboseDisplay(boolean verboseDisplay)

Description copied from interface: TitleFigure

Sets the flag if the display text or the object name should be displayed if there is no display name of the client object.

Specified by:

setVerboseDisplay in interface TitleFigure