org.openbp.cockpit.modeler.figures.generic
Interface TitleFigure

All Superinterfaces:

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

All Known Implementing Classes:

FixedTitleFigure, MoveableTitleFigure

public interface TitleFigure
extends CH.ifa.draw.framework.Figure, UpdatableFigure

A title figure displays the textual title of another figure. It is the display text of the object represented by the figure.

Author:

Heiko Erhardt

Field Summary

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

POPUP_MENU

Method Summary

DisplayObject	getClient() Gets the the display object we are connected with.
java.lang.String	getText() Gets the title text of the figure.
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	setText(java.lang.String text) Sets the title text of the figure.
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.

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

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

updateFigure

Method Detail

getText

java.lang.String getText()

Gets the title text of the figure.

setText

void setText(java.lang.String text)

Sets the title text of the figure.

getClient

DisplayObject getClient()

Gets the the display object we are connected with.

setClient

void setClient(DisplayObject client)

Sets the the display object we are connected with.

getTitleFormat

java.lang.String getTitleFormat()

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

setTitleFormat

void setTitleFormat(java.lang.String titleFormat)

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

isVerboseDisplay

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.

setVerboseDisplay

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.