com.tensegrity.composite
Interface CompositeSwimLane

All Superinterfaces:

Attributable, AttributableOnSet, BaseComposite, BaseCompositeContainer, BaseInteractable, Composite, CompositeGroup, Interactable, InteractionProvider

public interface CompositeSwimLane

extends CompositeGroup

Implementations of this interface can be used to lay out Composites on a lane. This arrangement of Composites looks like a swimlane seen from the top. Every CompositeSwimLane has a title and a watermark to clarify their usage. The arrangement order goes from left to right.

A CompositeSwimLane can be contained or nested in a CompositeSwimLanePool.

Version:

$Id: CompositeSwimLane.java,v 1.9 2005/04/01 15:45:16 MichaelKegel Exp $

Author:

MichaelKegel

See Also:

CompositeSwimLanePool

Field Summary

static int	LANESTYLE_BEAM Different styles of the lanes.
static int	LANESTYLE_RECTANGLE Different styles of the lanes.
static int	TITLE_POSITION_INSIDE_BOTTOM_LEFT Constants for the layout of the title.
static int	TITLE_POSITION_INSIDE_BOTTOM_RIGHT Constants for the layout of the title.
static int	TITLE_POSITION_INSIDE_TOP_LEFT Constants for the layout of the title.
static int	TITLE_POSITION_INSIDE_TOP_RIGHT Constants for the layout of the title.
static int	TITLE_POSITION_OUTSIDE_BOTTOM_LEFT Constants for the layout of the title.
static int	TITLE_POSITION_OUTSIDE_BOTTOM_RIGHT Constants for the layout of the title.
static int	TITLE_POSITION_OUTSIDE_TOP_LEFT Constants for the layout of the title.
static int	TITLE_POSITION_OUTSIDE_TOP_RIGHT Constants for the layout of the title.
static int	WATERMARK_POSITIONING_CENTERED Position constants for the watermark.
static int	WATERMARK_POSITIONING_REPEATED Position constants for the watermark.
static int	WATERMARK_POSITIONING_REPEATED_MARGINED Position constants for the watermark.

Fields inherited from interface com.tensegrity.composite.CompositeGroup

EVENT_MASK_ADD_COMPOSITE, EVENT_MASK_ADD_COMPOSITES, EVENT_MASK_COMPOSITEORDER_CHANGED, EVENT_MASK_FOLDSTATE_CHANGE, EVENT_MASK_REMOVE_COMPOSITE, EVENT_MASK_REMOVE_COMPOSITES, EVENT_MASK_SELECTION_CHANGED, EVENT_MASK_SIZE_ADJUSTMENT, FOLDPLACEMENT_CENTERED, FOLDPLACEMENT_UNKNOWN, FOLDPLACEMENT_UPPERCORNER, FOLDSTATE_FOLDED, FOLDSTATE_UNFOLDED, SIZEADJUSTMENT_COMPOSITES, SIZEADJUSTMENT_COMPOSITESANDLINES, SIZEADJUSTMENT_NONE

Fields inherited from interface com.tensegrity.composite.Composite

BBOXMASK_INCLUDE_ALL, BBOXMASK_INCLUDE_EXTERNALS_ALL, BBOXMASK_INCLUDE_EXTERNALS_BACK, BBOXMASK_INCLUDE_EXTERNALS_BOTTOM, BBOXMASK_INCLUDE_EXTERNALS_FRONT, BBOXMASK_INCLUDE_EXTERNALS_LEFT, BBOXMASK_INCLUDE_EXTERNALS_RIGHT, BBOXMASK_INCLUDE_EXTERNALS_TOP, BBOXMASK_INCLUDE_MARKER, BBOXMASK_INCLUDE_SHADOW, BBOXMASK_INCLUDE_STROKE, BBOXMASK_INCLUDE_TEXT_OUTSIDE_OF_LABELS, EVENT_MASK_CHANGE, EVENT_MASK_MOVE, EVENT_MASK_RESIZE, TRANSFORMFROM_COMPOSITE, TRANSFORMTO_COMPOSITE

Fields inherited from interface com.tensegrity.composite.BaseComposite

DELEGATE_INFOVALUE, EVENT_MASK_MOUSE, EVENT_MASK_SELECT, GENERAL_INFOVALUE, NON_INFOVALUE

Fields inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

TREE_SUBSET_POSTFIX

Method Summary

PaintFormat	getBackgroundPaint() Returns the background PaintFormat.
StrokeFormat	getBackgroundStroke() Returns the background StrokeFormat.
int	getBeamArrowLength() Returns the length of the beam arrows.
int	getBottomMargin() Returns the bottom margin.
int	getLaneIndex() Returns the index of the CompositeSwimLane.
int	getLaneStyle() Returns the set lane-style.
int	getLaneWeight() Returns the lane-weight.
int	getLeftMargin() Returns the left margin.
java.lang.String	getTitle() Returns the set title.
FontFormat	getTitleFont() Returns the FontFormat of the title.
PaintFormat	getTitlePaint() Returns the PaintFormat of the title.
int	getTitlePosition() Returns the title position.
StrokeFormat	getTitleStroke() Returns the StrokeFormat of the title.
int	getTopMargin() Returns the top margin.
java.lang.String	getWatermark() Returns the text of the waternmark.
FontFormat	getWatermarkFont() Returns the FontFormat of the watermark.
int	getWatermarkPositioning() Returns the position of the watermark.
int	getWatermarkRepetitionLength() Returns the repetition-length of the watermark.
boolean	isTitleVisible() Returns true, if the title is visible.
boolean	isWatermarkVisible() Determines whether the watermark is visible.
void	setBackgroundPaint(PaintFormat paint) Set the PaintFormat of the background.
void	setBackgroundStroke(StrokeFormat stroke) Set the StrokeFormat of the background.
void	setBeamArrowLength(int beamarrowlength) Set the length of the beam-arrow.
void	setLaneIndex(int index) Sets the index of the CompositeSwimLane to the value given by index.
void	setLaneStyle(int style) Sets the lane-style.
void	setLaneWeight(int weight) Set the lane weight.
void	setTitle(java.lang.String text) Sets the title to the given String.
void	setTitleFont(FontFormat font) Set the FontFormat of the title.
void	setTitlePaint(PaintFormat paint) Set the PaintFormat of the title.
void	setTitlePosition(int position) Sets the position of the title.
void	setTitleStroke(StrokeFormat stroke) Set the StrokeFormat of the title.
void	setTitleVisible(boolean visible) Set the title visible / invisible.
void	setWatermark(java.lang.String text) Sets the text of the watermark.
void	setWatermarkFont(FontFormat font) Sets the FontFormat of the watermark.
void	setWatermarkPositioning(int positioning) Sets the position of the watermark.
void	setWatermarkRepetitionLength(int repetitionlength) Sets the repetition-length of the watermark.
void	setWatermarkVisible(boolean visible) Sets the watermark to visible / invisible.

Methods inherited from interface com.tensegrity.composite.CompositeGroup

addCompositeGroupListener, addVetoableCompositeGroupListener, adjustBoundingBoxToContent, computeCompositeBoundingBox, deepCopy, enableChildManipulation, enableChildMovement, enableChildSelection, getContentBorderBottom, getContentBorderLeft, getContentBorderRight, getContentBorderTop, getFoldedGeometry, getFoldedStyle, getFoldingAnchor, getFoldPlacement, getFoldState, getFoldStateButtonAnchor, getFoldStateButtonCursor, getFoldStateButtonSize, getFoldStateSize, getHorizontalContentBorder, getSizeAdjustment, getVerticalContentBorder, internalEnabledSizeAdjustment, internalEnableSizeAdjustment, internalFireCompositesAddedEvent, internalFireCompositesRemovedEvent, internalFireSelectionChangeEvent, isAdjustSizeToSingleChild, isChildManipulationEnabled, isChildMovementEnabled, isChildSelectionEnabled, isDragSource, isDropTarget, isFoldable, layout, registerAdditionalInteractionHandler, removeCompositeGroupListener, removeVetoableCompositeGroupListener, setAdjustSizeToSingleChild, setContentBorderBottom, setContentBorderLeft, setContentBorderRight, setContentBorderTop, setDragSource, setDropTarget, setFoldable, setFoldedGeometry, setFoldedStyle, setFoldingAnchor, setFoldPlacement, setFoldState, setFoldStateButtonAnchor, setFoldStateButtonCursor, setFoldStateButtonSize, setFoldStateSize, setHorizontalContentBorder, setSizeAdjustment, setVerticalContentBorder, toggleFoldState

Methods inherited from interface com.tensegrity.composite.BaseCompositeContainer

addComposite, addComposites, getCompositeCount, getCompositeIterator, removeAllComposites, removeComposite, removeComposites, setComposites

Methods inherited from interface com.tensegrity.composite.Composite

addCompositeListener, addToLocation, addVetoableCompositeListener, applyState, centerAtLocation, deepCopy, getBackgroundCursorID, getBoundingBox, getCoordinateSystem, getCoordinateSytemTransform, getLocation, getMinimumSize, getSize, getState, getTransform, internalGetHasSideHandles, internalGetKeepAspectRatioAtCornerHandles, internalSetHasSideHandles, internalSetKeepAspectRatioAtCornerHandles, layout, removeCompositeListener, removeVetoableCompositeListener, setBackgroundCursorID, setBoundingBox, setCoordinateSystem, setLocation, setMinimumSize, setSize, setTransform

Methods inherited from interface com.tensegrity.composite.BaseComposite

addPrimitive, adjustGeometry, adjustGeometry, applyGeometry, applyStyle, areEventsEnabled, disableEvents, draw, draw, drawComposite, enableEvents, getBaseCompositeContainer, getEventMask, getGeometryName, getInfoValue, getInfoValueIdentifier, getName, getPrimitiveIterator, getShadowColor, getShadowDirection, getStyleName, internalSetGeometryName, internalSetStyleName, isDeletable, isShadowVisible, registerAttributeConstraint, registerEventMediator, registerVetoableEventMediator, removeAllPrimitives, removePrimitive, setBaseCompositeContainer, setDeletable, setEventMask, setInfoValue, setInfoValue, setName, setShadowColor, setShadowDirection, setShadowVisible, unregisterAttributeConstraint

Methods inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

addAttributableOnSetListener, areAttributableEventsEnabled, disableAttributableEvents, enableAttributableEvents, getAttributes, getAttributesTree, removeAttributableOnSetListener, setAttributes, setAttributesTree

Methods inherited from interface com.tensegrity.generic.attribute.Attributable

getAttribute, getAttributeType, getAttributeValue, setAttribute, setAttributeValue

Methods inherited from interface com.tensegrity.graphics.interaction.BaseInteractable

getBoundingBox, getInteractionDescriptor, getMoveItem, hits, internalEnableSelection, internalSelect, internalSetSelected, isMovable, isSelectable, isSelected, mouseClick, mouseDown, mouseEnter, mouseExit, mouseUp, postActing, preActing, select, setMovable, setSelectable, setSelected, startAction, stopAction

Methods inherited from interface com.tensegrity.graphics.interaction.Interactable

calculateBoundingBox, isResizable, setResizable

Methods inherited from interface com.tensegrity.graphics.interaction.InteractionProvider

actAt, descriptorChanged, dismissFromInteractionCycle, getCurrentInteractionItemFor, getCursorID, getInteractionProviders, getSelection, getSelectionBoundingBox, hasMultiSelection, hasSelection, hasSubSelection, hitsAt, mouseClickAt, mouseDownAt, mouseMoveAt, mouseUpAt, postAction, preAction, select, selectAll, selectAt, selectContaining, selectSubsequent, setSelection, startActionAt, stopActionAt, unselect, unselect, unselectAll, unselectSubsequent

Field Detail

LANESTYLE_RECTANGLE

public static final int LANESTYLE_RECTANGLE

Different styles of the lanes.

See Also:

Constant Field Values

LANESTYLE_BEAM

public static final int LANESTYLE_BEAM

Different styles of the lanes.

See Also:

Constant Field Values

TITLE_POSITION_OUTSIDE_TOP_LEFT

public static final int TITLE_POSITION_OUTSIDE_TOP_LEFT

Constants for the layout of the title.

See Also:

Constant Field Values

TITLE_POSITION_OUTSIDE_TOP_RIGHT

public static final int TITLE_POSITION_OUTSIDE_TOP_RIGHT

Constants for the layout of the title.

See Also:

Constant Field Values

TITLE_POSITION_OUTSIDE_BOTTOM_LEFT

public static final int TITLE_POSITION_OUTSIDE_BOTTOM_LEFT

Constants for the layout of the title.

See Also:

Constant Field Values

TITLE_POSITION_OUTSIDE_BOTTOM_RIGHT

public static final int TITLE_POSITION_OUTSIDE_BOTTOM_RIGHT

Constants for the layout of the title.

See Also:

Constant Field Values

TITLE_POSITION_INSIDE_TOP_LEFT

public static final int TITLE_POSITION_INSIDE_TOP_LEFT

Constants for the layout of the title.

See Also:

Constant Field Values

TITLE_POSITION_INSIDE_TOP_RIGHT

public static final int TITLE_POSITION_INSIDE_TOP_RIGHT

Constants for the layout of the title.

See Also:

Constant Field Values

TITLE_POSITION_INSIDE_BOTTOM_LEFT

public static final int TITLE_POSITION_INSIDE_BOTTOM_LEFT

Constants for the layout of the title.

See Also:

Constant Field Values

TITLE_POSITION_INSIDE_BOTTOM_RIGHT

public static final int TITLE_POSITION_INSIDE_BOTTOM_RIGHT

Constants for the layout of the title.

See Also:

Constant Field Values

WATERMARK_POSITIONING_CENTERED

public static final int WATERMARK_POSITIONING_CENTERED

Position constants for the watermark.

See Also:

Constant Field Values

WATERMARK_POSITIONING_REPEATED

public static final int WATERMARK_POSITIONING_REPEATED

Position constants for the watermark.

See Also:

Constant Field Values

WATERMARK_POSITIONING_REPEATED_MARGINED

public static final int WATERMARK_POSITIONING_REPEATED_MARGINED

Position constants for the watermark.

See Also:

Constant Field Values

Method Detail

getLaneIndex

public int getLaneIndex()

Returns the index of the CompositeSwimLane. The index is relative to the CompositeSwimLanePool the swimlane belongs to.

Returns:

int the index of the CompositeSwimLane within the CompositeSwimLanePool

setLaneIndex

public void setLaneIndex(int index)

Sets the index of the CompositeSwimLane to the value given by index. The index should be relative to the CompositeSwimLanePool the swimlane belongs to.

NOTICE:
The index of the Composite>SwimLane is set by the framework so that in allmost every case there is no need to set it by yourself! Only when the CompositeSwimLane is not added to a CompositeSwimLanePool you have to set the index.

Parameters:

index - the index to set.

getLaneStyle

public int getLaneStyle()

Returns the set lane-style.

Returns:

the set lane-style.

setLaneStyle

public void setLaneStyle(int style)

Sets the lane-style. Valid values are: LANESTYLE_RECTANGLE and LANESTYLE_BEAM.

Parameters:

style - the lane-style to set.

getLaneWeight

public int getLaneWeight()

Returns the lane-weight.

Returns:

the lane-weight.

setLaneWeight

public void setLaneWeight(int weight)

Set the lane weight.

Parameters:

weight - the weight to set.

getTopMargin

public int getTopMargin()

Returns the top margin.

Returns:

the top margin.

getBottomMargin

public int getBottomMargin()

Returns the bottom margin.

Returns:

the bottom margin.

getLeftMargin

public int getLeftMargin()

Returns the left margin.

Returns:

the left margin.

getBackgroundStroke

public StrokeFormat getBackgroundStroke()

Returns the background StrokeFormat.

Returns:

the background StrokeFormat.

setBackgroundStroke

public void setBackgroundStroke(StrokeFormat stroke)

Set the StrokeFormat of the background.

Parameters:

stroke - the StrokeFormat to set for the background.

getBackgroundPaint

public PaintFormat getBackgroundPaint()

Returns the background PaintFormat.

Returns:

the background PaintFormat.

setBackgroundPaint

public void setBackgroundPaint(PaintFormat paint)

Set the PaintFormat of the background.

Parameters:

paint - the PaintFormat to set for the background.

getBeamArrowLength

public int getBeamArrowLength()

Returns the length of the beam arrows.

Returns:

the length of the beam arrows.

setBeamArrowLength

public void setBeamArrowLength(int beamarrowlength)

Set the length of the beam-arrow.

Parameters:

beamarrowlength - the desired length of the beam-arrow.

getTitleStroke

public StrokeFormat getTitleStroke()

Returns the StrokeFormat of the title.

Returns:

the StrokeFormat of the title.

setTitleStroke

public void setTitleStroke(StrokeFormat stroke)

Set the StrokeFormat of the title.

Parameters:

stroke - the StrokeFormat to set.

getTitlePaint

public PaintFormat getTitlePaint()

Returns the PaintFormat of the title.

Returns:

the PaintFormat of the title.

setTitlePaint

public void setTitlePaint(PaintFormat paint)

Set the PaintFormat of the title.

Parameters:

paint - the PaintFormat to set.

getTitleFont

public FontFormat getTitleFont()

Returns the FontFormat of the title.

Returns:

the FontFormat of the title.

setTitleFont

public void setTitleFont(FontFormat font)

Set the FontFormat of the title.

Parameters:

font - the FontFormat to set.

isTitleVisible

public boolean isTitleVisible()

Returns true, if the title is visible.

Returns:

true, if the title is visible.

setTitleVisible

public void setTitleVisible(boolean visible)

Set the title visible / invisible.

Parameters:

visible - true, if the title shall be visible.

getTitle

public java.lang.String getTitle()

Returns the set title.

Returns:

the set title.

setTitle

public void setTitle(java.lang.String text)

Sets the title to the given String.

Parameters:

text - the title to set.

getTitlePosition

public int getTitlePosition()

Returns the title position.

Returns:

the title position.

setTitlePosition

public void setTitlePosition(int position)

Sets the position of the title.

Parameters:

position - the position of the title.

getWatermarkFont

public FontFormat getWatermarkFont()

Returns the FontFormat of the watermark.

Returns:

the FontFormat of the watermark.

setWatermarkFont

public void setWatermarkFont(FontFormat font)

Sets the FontFormat of the watermark.

Parameters:

font - the FontFormat to set.

getWatermark

public java.lang.String getWatermark()

Returns the text of the waternmark.

Returns:

the text of the waternmark.

setWatermark

public void setWatermark(java.lang.String text)

Sets the text of the watermark.

Parameters:

text - the text of the watermark.

isWatermarkVisible

public boolean isWatermarkVisible()

Determines whether the watermark is visible.

Returns:

true, if the watermark is visible.

setWatermarkVisible

public void setWatermarkVisible(boolean visible)

Sets the watermark to visible / invisible.

Parameters:

visible - true, if the watermark shall be visible.

getWatermarkPositioning

public int getWatermarkPositioning()

Returns the position of the watermark.

Returns:

the position of the watermark.

setWatermarkPositioning

public void setWatermarkPositioning(int positioning)

Sets the position of the watermark.

Parameters:

positioning - the postion of the watermark.

getWatermarkRepetitionLength

public int getWatermarkRepetitionLength()

Returns the repetition-length of the watermark.

Returns:

the repetition-length of the watermark.

setWatermarkRepetitionLength

public void setWatermarkRepetitionLength(int repetitionlength)

Sets the repetition-length of the watermark.

Parameters:

repetitionlength - the length to set.