org.jgraph.graph

Class GraphConstants

public class GraphConstants extends Object

A collection of well known or common attribute keys and methods to apply to an Map to get/set the properties in a typesafe manner. The following attributes and methods need special attention: removeAttributes, removeAll and value. RemoveAttributes and RemoveAll are not stored in a map, but remove the specified entries. The value entry of a propertyMap is always in sync with the userObject of a GraphCell. The isMoveable, isAutoSize and isSizeable are used indepedently (see http://sourceforge.net/forum/forum.php?thread_id=770111&forum_id=140880)
Field Summary
static StringABSOLUTEX
Key for the absoluteX attribute.
static StringABSOLUTEY
Key for the absoluteY attribute.
static intARROW_CIRCLE
Represents a circle decoration for the beginning or ending of edges.
static intARROW_CLASSIC
Represents a classic arrow decoration for the beginning or ending of edges.
static intARROW_DIAMOND
Represents a diamond decoration for the beginning or ending of edges.
static intARROW_DOUBLELINE
Represents a double line decoration for the beginning or ending of edges.
static intARROW_LINE
Represents a line decoration for the beginning or ending of edges.
static intARROW_NONE
Represents no decoration for the beginning or ending of edges.
static intARROW_SIMPLE
Represents a simple arrow decoration for the beginning or ending of edges.
static intARROW_TECHNICAL
Represents a technical arrow decoration for the beginning or ending of edges.
static StringAUTOSIZE
Key for the autosize attribute.
static StringBACKGROUND
Key for the background attribute.
static StringBEGINFILL
Key for the beginFill attribute.
static StringBEGINSIZE
Key for the beginSize attribute.
static StringBENDABLE
Key for the bendable attribute.
static StringBORDER
Key for the border attribute.
static StringBORDERCOLOR
Key for the bordercolor attribute.
static StringBOUNDS
Key for the bounds attribute.
static StringCHILDRENSELECTABLE
Key for the childrenSelectable attribute.
static StringCONNECTABLE
Key for the connectable attribute.
static StringCONSTRAINED
Key for the constrained attribute.
protected static float[]dash
Global Stroke To Highlight Selection
static StringDASHOFFSET
Key for the dashOffset attribute.
static StringDASHPATTERN
Key for the dashPattern attribute.
static intDEFAULTDECORATIONSIZE
Default decoration size.
static FontDEFAULTFONT
Default font is derived from UIManager.getDefaults().getFont("Label.font")
static intDEFAULTINSET
Default inset size.
static StringDISCONNECTABLE
Key for the disconnectable attribute.
static StringEDITABLE
Key for the editable attribute.
static StringENDFILL
Key for the endFill attribute.
static StringENDSIZE
Key for the endSize attribute.
static StringEXACTSEGMENTRELATIVE
Key for the labelEnabled attribute.
static StringEXTRALABELPOSITIONS
Key for the extraLabelPositions attribute.
static StringEXTRALABELS
Key for the extraLabels attribute.
static StringFONT
Key for the font attribute.
static StringFOREGROUND
Key for the foreground attribute.
static StringGRADIENTCOLOR
Key for the gradient attribute.
static StringGROUPOPAQUE
Key for the groupOpaque attribute.
static StringHORIZONTAL_ALIGNMENT
Key for the horizontalAlignment attribute.
static StringHORIZONTAL_TEXT_POSITION
Key for the horizontalTextPosition attribute.
static StringICON
Key for the icon attribute.
static StringINSET
Key for the inset attribute.
static StringLABELALONGEDGE
Key for the labelAlongEdge attribute.
static StringLABELENABLED
Key for the labelEnabled attribute.
static StringLABELPOSITION
Key for the labelposition attribute.
static StringLINEBEGIN
Key for the lineBegin attribute.
static StringLINECOLOR
Key for the linecolor attribute.
static StringLINEEND
Key for the lineEnd attribute.
static StringLINESTYLE
Key for the lineStyle attribute.
static StringLINEWIDTH
Key for the linewidth attribute.
static StringLINK
Key for the link attribute.
static StringMOVEABLE
Key for the moveable attribute.
static StringMOVEABLEAXIS
Key for the moveableAxis attribute.
static StringMOVEHIDDENCHILDREN
Key for the childrenSelectable attribute.
static StringOFFSET
Key for the offset attribute.
static StringOPAQUE
Key for the opaque attribute.
static intPERMILLE
100 percent unit for relative positioning.
static StringPOINTS
Key for the points attribute.
static StringREMOVEALL
Key for the removeAll attribute.
static StringREMOVEATTRIBUTES
Key for the removeAttributes attribute.
static StringREPLACEATTRIBUTES
Key for the replaceAttributes attribute.
static StringRESIZE
Key for the resize attribute.
static StringROUTING
Key for the routing attribute.
static Edge.RoutingROUTING_DEFAULT
The default routing that deals with loops.
static Edge.RoutingROUTING_SIMPLE
A simple routing.
static StringSELECTABLE
Key for the selectable attribute.
static StrokeSELECTION_STROKE
static StringSIZE
Key for the size attribute.
static StringSIZEABLE
Key for the sizeable attribute.
static StringSIZEABLEAXIS
Key for the sizeableAxis attribute.
static intSTYLE_BEZIER
Represents a bezier line style
static intSTYLE_ORTHOGONAL
Represents an orthogonal line style
static intSTYLE_SPLINE
Represents an spline line style
static StringVALUE
Key for the value attribute.
static StringVERTICAL_ALIGNMENT
Key for the verticalAlignment attribute.
static StringVERTICAL_TEXT_POSITION
Key for the verticalTextPosition attribute.
static intX_AXIS
Represents an bezier line style
static intY_AXIS
Represents an bezier line style
Method Summary
static MapcreateAttributes(Object cell, Object key, Object value)
Overloaded method that passes arguments on as arrays
static MapcreateAttributes(Object[] cells, Object key, Object value)
Overloaded method that passes arguments on as arrays
static MapcreateAttributes(Object[] cells, Object[] keys, Object[] values)
Returns a new (nested) map, from cells to attribute maps.
static MapcreateAttributes(Object[] elements, CellMapper cm)
Returns a new map, from cells to property maps.
static MapcreateAttributesFromModel(Object[] elements, GraphModel model)
static ColorgetBackground(Map map)
Returns the background attribute from the specified map.
static intgetBeginSize(Map map)
Returns the beginsize attribute from the specified map.
static BordergetBorder(Map map)
Returns the border attribute from the specified map.
static ColorgetBorderColor(Map map)
Returns the bordercolor attribute from the specified map.
static Rectangle2DgetBounds(Map map)
Returns the bounds attribute from the specified map.
static floatgetDashOffset(Map map)
Returns the dashoffset attribute from the specified map.
static float[]getDashPattern(Map map)
Returns the dashpattern attribute from the specified map.
static intgetEndSize(Map map)
Returns the endsize attribute from the specified map.
static Point2D[]getExtraLabelPositions(Map map)
Returns the extralabelpositions attribute from the specified map.
static Object[]getExtraLabels(Map map)
Returns the additional label objects from the specified map.Extra labels only work with edges currently.
static FontgetFont(Map map)
Returns the font for the specified attribute map.
static ColorgetForeground(Map map)
Returns the foreground attribute from the specified map.
static ColorgetGradientColor(Map map)
Returns the gradientcolor attribute from the specified map.
static intgetHorizontalAlignment(Map map)
Returns the horizontalalignment attribute from the specified map.
static intgetHorizontalTextPosition(Map map)
Returns the horizontaltextposition attribute from the specified map.
static IcongetIcon(Map map)
Returns the icon attribute from the specified map.
static intgetInset(Map map)
Returns the inset attribute from the specified map.
static Point2DgetLabelPosition(Map map)
Returns the label position attribute from the specified map.
static intgetLineBegin(Map map)
Returns the LINEBEGIN attribute from the specified map.
static ColorgetLineColor(Map map)
Returns the linecolor attribute from the specified map.
static intgetLineEnd(Map map)
Returns the LINEEND attribute from the specified map.
static intgetLineStyle(Map map)
Returns the linestyle attribute from the specified map.
static floatgetLineWidth(Map map)
Returns the linewidth attribute from the specified map.
static StringgetLink(Map map)
Returns the link for the specified attribute map.
static intgetMoveableAxis(Map map)
Returns the moveableaxis attribute from the specified map.
static Point2DgetOffset(Map map)
Returns the offset attribute from the specified map.
static ListgetPoints(Map map)
Returns the points attribute from the specified map.
static Object[]getRemoveAttributes(Map map)
Returns the attribute marked as for removal in the specified map.
static Edge.RoutinggetRouting(Map map)
Returns the routing attribute from the specified map.
static Edge.RoutinggetROUTING_DEFAULT()
static Edge.RoutinggetROUTING_SIMPLE()
static DimensiongetSize(Map map)
Returns the size attribute from the specified map.
static intgetSizeableAxis(Map map)
Returns the sizeableAxis attribute from the specified map.
static ObjectgetValue(Map map)
Returns the value attribute from the specified map.
static intgetVerticalAlignment(Map map)
Returns the verticalalignment attribute from the specified map.
static intgetVerticalTextPosition(Map map)
Returns the verticaltextposition attribute from the specified map.
static booleanisAbsoluteX(Map map)
Returns the absolutex attribute from the specified map.
static booleanisAbsoluteY(Map map)
Returns the absolutey attribute from the specified map.
static booleanisAutoSize(Map map)
Returns the autosize attribute from the specified map.
static booleanisBeginFill(Map map)
Returns the beginfill attribute from the specified map.
static booleanisBendable(Map map)
Returns the bendable attribute from the specified map.
static booleanisChildrenSelectable(Map map)
Returns the childrenselectable attribute from the specified map.
static booleanisConnectable(Map map)
Returns the connectable attribute from the specified map.
static booleanisConstrained(Map map)
Returns the constrained attribute from the specified map.
static booleanisDisconnectable(Map map)
Returns the disconnectable attribute from the specified map.
static booleanisEditable(Map map)
Returns the editable attribute from the specified map.
static booleanisEndFill(Map map)
Returns the endfill attribute from the specified map.
static booleanisExactSegmentLabel(Map map)
Returns whether the exact segment is worked out for placement of labels along edges for the specified cell.
static booleanisGroupOpaque(Map map)
Returns the opaque attribute from the specified map.
static booleanisLabelAlongEdge(Map map)
Returns the true if the label should be painted along the edge.
static booleanisLabelEnabled(Map map)
Returns whether the label is enabled for the specified cell.
static booleanisMoveable(Map map)
Returns the moveable attribute from the specified map.
static booleanisOpaque(Map map)
Returns the opaque attribute from the specified map.
static booleanisRemoveAll(Map map)
Returns the removeall attribute from the specified map.
static booleanisResize(Map map)
Returns the resize attribute from the specified map.
static booleanisSelectable(Map map)
Returns the selectable attribute from the specified map.
static booleanisSizeable(Map map)
Returns the sizeable attribute from the specified map.
static Mapmerge(Map change, Map target)
Merges the specified nested maps by adding all attributes in the change to the attributes for the cell in target, if the cell does not exist in target, then a new entry is added with all attributes from change.
static MapreplaceKeys(Map keyMap, Map map)
Replace the keys in map using keyMap
static voidsetAbsolute(Map map, boolean flag)
Sets the absolute attributes in the specified map to the specified value.
static voidsetAbsoluteX(Map map, boolean flag)
Sets the absolutex attribute in the specified map to the specified value.
static voidsetAbsoluteY(Map map, boolean flag)
Sets the absolutey attribute in the specified map to the specified value.
static voidsetAutoSize(Map map, boolean flag)
Sets the autosize attribute in the specified map to the specified value.
static voidsetBackground(Map map, Color value)
Sets the background attribute in the specified map to the specified value.
static voidsetBeginFill(Map map, boolean flag)
Sets the beginfill attribute in the specified map to the specified value.
static voidsetBeginSize(Map map, int style)
Sets the beginsize attribute in the specified map to the specified value.
static voidsetBendable(Map map, boolean flag)
Sets the bendable attribute in the specified map to the specified value.
static voidsetBorder(Map map, Border value)
Sets the border attribute in the specified map to the specified value.
static voidsetBorderColor(Map map, Color value)
Sets the bordercolor attribute in the specified map to the specified value.
static voidsetBounds(Map map, Rectangle2D bounds)
Sets the bounds attribute in the specified map to the specified value.
static voidsetChildrenSelectable(Map map, boolean flag)
Sets the childrenselectable attribute in the specified map to the specified value.
static voidsetConnectable(Map map, boolean flag)
Sets the connectable attribute in the specified map to the specified value.
static voidsetConstrained(Map map, boolean flag)
Sets the constrained attribute in the specified map to the specified value.
static voidsetDashOffset(Map map, float value)
Sets the dashoffset attribute in the specified map to the specified value.
static voidsetDashPattern(Map map, float[] value)
Sets the dashpattern attribute in the specified map to the specified value.
static voidsetDisconnectable(Map map, boolean flag)
Sets the disconnectable attribute in the specified map to the specified value.
static voidsetEditable(Map map, boolean flag)
Sets the editable attribute in the specified map to the specified value.
static voidsetEndFill(Map map, boolean flag)
Sets the endfill attribute in the specified map to the specified value.
static voidsetEndSize(Map map, int style)
Sets the endsize attribute in the specified map to the specified value.
static voidsetExactSegmentLabel(Map map, boolean flag)
Sets the exact segment attribute in the specified map to the specified value.
static voidsetExtraLabelPositions(Map map, Point2D[] positions)
Sets the labelpositions attribute in the specified map to the specified value.
static voidsetExtraLabels(Map map, Object[] definitions)
Sets the array of additional labels.
static voidsetFont(Map map, Font font)
Sets the value attribute in the specified map to the specified font value.
static voidsetForeground(Map map, Color value)
Sets the foregrund attribute in the specified map to the specified value.
static voidsetGradientColor(Map map, Color value)
Sets the gradientcolor attribute in the specified map to the specified value.
static voidsetGroupOpaque(Map map, boolean flag)
Sets the opaque attribute in the specified map to the specified value.
static voidsetHorizontalAlignment(Map map, int alignment)
This method set the position of the label in vertex cells, and takes aruguments of type SwingConstants (for JLabel) i.e.
static voidsetHorizontalTextPosition(Map map, int textPosition)
This method set the text of a label on vertext cell relative to image.
static voidsetIcon(Map map, Icon value)
Sets the icon attribute in the specified map to the specified value.
static voidsetInset(Map map, int width)
Sets the inset attribute in the specified map to the specified value.
static voidsetLabelAlongEdge(Map map, boolean flag)
Sets if the label should be painted along the edge.
static voidsetLabelEnabled(Map map, boolean flag)
Sets the label enabled attribute in the specified map to the specified value.
static voidsetLabelPosition(Map map, Point2D position)
Sets the label position attribute in the specified map to the specified value.
static voidsetLineBegin(Map map, int style)
Sets the LINEBEGIN attribute in the specified map to the specified value.
static voidsetLineColor(Map map, Color value)
Sets the linecolor attribute in the specified map to the specified value.
static voidsetLineEnd(Map map, int style)
Sets the LINEEND attribute in the specified map to the specified value.
static voidsetLineStyle(Map map, int style)
Sets the linestyle attribute in the specified map to the specified value.
static voidsetLineWidth(Map map, float width)
Sets the linewidth attribute in the specified map to the specified value.
static voidsetLink(Map map, String link)
Sets the link attribute in the specified map to the specified value.
static voidsetMoveable(Map map, boolean flag)
Sets the moveable attribute in the specified map to the specified value.
static voidsetMoveableAxis(Map map, int axis)
Sets the moveableaxis attribute in the specified map to the specified value.
static voidsetOffset(Map map, Point2D offset)
Sets the offset attribute in the specified map to the specified value.
static voidsetOpaque(Map map, boolean flag)
Sets the opaque attribute in the specified map to the specified value.
static voidsetPoints(Map map, List list)
Sets the points attribute in the specified map to the specified value.
static voidsetRemoveAll(Map map, boolean flag)
Sets the removeall attribute in the specified map to the specified value.
static voidsetRemoveAttributes(Map map, Object[] value)
Sets specific attributes are being marked for removal @ param map The transport map indicating the attribute removal @ param value The attributes to be removed
static voidsetResize(Map map, boolean flag)
Sets the resize attribute in the specified map to the specified value.
static voidsetRouting(Map map, Edge.Routing routing)
Sets the routing attribute in the specified map to the specified value.
static voidsetSelectable(Map map, boolean flag)
Sets the selectable attribute in the specified map to the specified value.
static voidsetSize(Map map, Dimension size)
Sets the size attribute in the specified map to the specified value.
static voidsetSizeable(Map map, boolean flag)
Sets the sizeable attribute in the specified map to the specified value.
static voidsetSizeableAxis(Map map, int axis)
Sets the sizeableAxis attribute in the specified map to the specified value.
static voidsetValue(Map map, Object value)
Sets the value attribute in the specified map to the specified value.
static voidsetVerticalAlignment(Map map, int alignment)
This method set the position of the label in vertex cells, and takes aruguments of type SwingConstants (for JLabel) i.e.
static voidsetVerticalTextPosition(Map map, int textPosition)
This method set the text of a label on vertext cell relative to image.

Field Detail

ABSOLUTEX

public static final String ABSOLUTEX
Key for the absoluteX attribute. Use instances of Boolean as values for this key.

ABSOLUTEY

public static final String ABSOLUTEY
Key for the absoluteY attribute. Use instances of Boolean as values for this key.

ARROW_CIRCLE

public static final int ARROW_CIRCLE
Represents a circle decoration for the beginning or ending of edges.

See Also: GraphConstants getLineBegin GraphConstants getLineEnd

ARROW_CLASSIC

public static final int ARROW_CLASSIC
Represents a classic arrow decoration for the beginning or ending of edges.

See Also: GraphConstants getLineBegin GraphConstants getLineEnd

ARROW_DIAMOND

public static final int ARROW_DIAMOND
Represents a diamond decoration for the beginning or ending of edges.

See Also: GraphConstants getLineBegin GraphConstants getLineEnd

ARROW_DOUBLELINE

public static final int ARROW_DOUBLELINE
Represents a double line decoration for the beginning or ending of edges.

See Also: GraphConstants getLineBegin GraphConstants getLineEnd

ARROW_LINE

public static final int ARROW_LINE
Represents a line decoration for the beginning or ending of edges.

See Also: GraphConstants getLineBegin GraphConstants getLineEnd

ARROW_NONE

public static final int ARROW_NONE
Represents no decoration for the beginning or ending of edges.

See Also: GraphConstants getLineBegin GraphConstants getLineEnd

ARROW_SIMPLE

public static final int ARROW_SIMPLE
Represents a simple arrow decoration for the beginning or ending of edges.

See Also: GraphConstants getLineBegin GraphConstants getLineEnd

ARROW_TECHNICAL

public static final int ARROW_TECHNICAL
Represents a technical arrow decoration for the beginning or ending of edges.

See Also: GraphConstants getLineBegin GraphConstants getLineEnd

AUTOSIZE

public static final String AUTOSIZE
Key for the autosize attribute. Use instances of Boolean as values for this key.

BACKGROUND

public static final String BACKGROUND
Key for the background attribute. Use instances of Color as values for this key.

BEGINFILL

public static final String BEGINFILL
Key for the beginFill attribute. Use instances of Integer as values for this key.

BEGINSIZE

public static final String BEGINSIZE
Key for the beginSize attribute. Use instances of Integer as values for this key.

BENDABLE

public static final String BENDABLE
Key for the bendable attribute. Use instances of Boolean as values for this key.

BORDER

public static final String BORDER
Key for the border attribute. Use instances of Border as values for this key. Optionally, you can set the global instance of LineBorder.

BORDERCOLOR

public static final String BORDERCOLOR
Key for the bordercolor attribute. Use instances of Color as values for this key.

BOUNDS

public static final String BOUNDS
Key for the bounds attribute. Use instances of Rectangle as values for this key.

CHILDRENSELECTABLE

public static final String CHILDRENSELECTABLE
Key for the childrenSelectable attribute. Use instances of Boolean as values for this key.

CONNECTABLE

public static final String CONNECTABLE
Key for the connectable attribute. Use instances of Boolean as values for this key.

CONSTRAINED

public static final String CONSTRAINED
Key for the constrained attribute. Use instances of Boolean as values for this key.

dash

protected static float[] dash
Global Stroke To Highlight Selection

DASHOFFSET

public static final String DASHOFFSET
Key for the dashOffset attribute. Use instances of float as values for this key.

DASHPATTERN

public static final String DASHPATTERN
Key for the dashPattern attribute. Use instances of float[] as values for this key.

DEFAULTDECORATIONSIZE

public static int DEFAULTDECORATIONSIZE
Default decoration size. Value is 0.

DEFAULTFONT

public static Font DEFAULTFONT
Default font is derived from UIManager.getDefaults().getFont("Label.font")

DEFAULTINSET

public static int DEFAULTINSET
Default inset size. Value is 0.

DISCONNECTABLE

public static final String DISCONNECTABLE
Key for the disconnectable attribute. Use instances of Boolean as values for this key.

EDITABLE

public static final String EDITABLE
Key for the editable attribute. Use instances of Boolean as values for this key.

ENDFILL

public static final String ENDFILL
Key for the endFill attribute. Use instances of Integer as values for this key.

ENDSIZE

public static final String ENDSIZE
Key for the endSize attribute. Use instances of Integer as values for this key.

EXACTSEGMENTRELATIVE

public static final String EXACTSEGMENTRELATIVE
Key for the labelEnabled attribute. Use instances of Boolean as values for this key.

EXTRALABELPOSITIONS

public static final String EXTRALABELPOSITIONS
Key for the extraLabelPositions attribute. Use arrays of Points as values for this key.

EXTRALABELS

public static final String EXTRALABELS
Key for the extraLabels attribute. Use arrays of Objects as values for this key, where the toString() methods of the objects provide the label text value.

FONT

public static final String FONT
Key for the font attribute. Use instances of Font as values for this key.

FOREGROUND

public static final String FOREGROUND
Key for the foreground attribute. Use instances of Color as values for this key.

GRADIENTCOLOR

public static final String GRADIENTCOLOR
Key for the gradient attribute. Use instances of Color as values for this key.

GROUPOPAQUE

public static final String GROUPOPAQUE
Key for the groupOpaque attribute. Use instances of Boolean as values for this key.

HORIZONTAL_ALIGNMENT

public static final String HORIZONTAL_ALIGNMENT
Key for the horizontalAlignment attribute. Use instances of Integer as values for this key. Constants defined in JLabel class. This Key/Value pair is for placment of label on vertex cell. Valid values would be JLabel.LEFT, JLabel.CENTER, JLabel.RIGHT

HORIZONTAL_TEXT_POSITION

public static final String HORIZONTAL_TEXT_POSITION
Key for the horizontalTextPosition attribute. Use instances of Integer as values for this key. Constants defined in JLabel class. This Key/Value pair affects text postion of label on vertex cell relative to image, the value is of type SwingConstant.

ICON

public static final String ICON
Key for the icon attribute. Use instances of Icon as values for this key.

INSET

public static final String INSET
Key for the inset attribute. Use instances of Integer as values for this key.

LABELALONGEDGE

public static final String LABELALONGEDGE
Key for the labelAlongEdge attribute. Use instances of Boolean as values for this key.

LABELENABLED

public static final String LABELENABLED
Key for the labelEnabled attribute. Use instances of Boolean as values for this key.

LABELPOSITION

public static final String LABELPOSITION
Key for the labelposition attribute. Use instances of Point as values for this key. This Key/Value pair is for position of text relative to edge cell, and has no effect on label in vertex cell.

LINEBEGIN

public static final String LINEBEGIN
Key for the lineBegin attribute. Use instances of Integer as values for this key. Constants defined in this class.

LINECOLOR

public static final String LINECOLOR
Key for the linecolor attribute. Use instances of Color as values for this key.

LINEEND

public static final String LINEEND
Key for the lineEnd attribute. Use instances of Integer as values for this key. Constants defined in this class.

LINESTYLE

public static final String LINESTYLE
Key for the lineStyle attribute. Use instances of Integer as values for this key. Constants defined in this class.

LINEWIDTH

public static final String LINEWIDTH
Key for the linewidth attribute. Use instances of Float as values for this key.

LINK

public static final String LINK
Key for the link attribute. Use instances of String as values for this key.

MOVEABLE

public static final String MOVEABLE
Key for the moveable attribute. Use instances of Boolean as values for this key.

MOVEABLEAXIS

public static final String MOVEABLEAXIS
Key for the moveableAxis attribute. This attribute contains an Integer value indicating along which axis a cell may be moved. Constants defined in this class.

MOVEHIDDENCHILDREN

public static final String MOVEHIDDENCHILDREN
Key for the childrenSelectable attribute. Use instances of Boolean as values for this key.

OFFSET

public static final String OFFSET
Key for the offset attribute. Use instances of Point as values for this key.

OPAQUE

public static final String OPAQUE
Key for the opaque attribute. Use instances of Boolean as values for this key.

PERMILLE

public static final int PERMILLE
100 percent unit for relative positioning. Current value is 1000.

POINTS

public static final String POINTS
Key for the points attribute. Use instances of List as values for this key. The list should contain Point instances.

REMOVEALL

public static final String REMOVEALL
Key for the removeAll attribute. This causes the receivers attributes to be replaced by the the map that contains this attribute.

REMOVEATTRIBUTES

public static final String REMOVEATTRIBUTES
Key for the removeAttributes attribute. This special attribute contains a list of attribute-keys which should be removed at the receiving views.

REPLACEATTRIBUTES

public static final String REPLACEATTRIBUTES
Key for the replaceAttributes attribute. This special attribute contains a Boolean instance indicating whether a map of attributes should replace the attributes of the receiving view.

RESIZE

public static final String RESIZE
Key for the resize attribute. Use instances of Boolean as values for this key.

ROUTING

public static final String ROUTING
Key for the routing attribute. Use instances of EdgeView.EdgeRouter as values for this key.

ROUTING_DEFAULT

public static Edge.Routing ROUTING_DEFAULT
The default routing that deals with loops. This is returned by getRouting if there is no routing assigned.

ROUTING_SIMPLE

public static final Edge.Routing ROUTING_SIMPLE
A simple routing.

SELECTABLE

public static final String SELECTABLE
Key for the selectable attribute. Use instances of Boolean as values for this key.

SELECTION_STROKE

public static Stroke SELECTION_STROKE

SIZE

public static final String SIZE
Key for the size attribute. Use instances of Dimension as values for this key.

SIZEABLE

public static final String SIZEABLE
Key for the sizeable attribute. Use instances of Boolean as values for this key.

SIZEABLEAXIS

public static final String SIZEABLEAXIS
Key for the sizeableAxis attribute. This attribute contains an Integer value representing which axis of a cell may be resized/scaled Constants defined in this class.

STYLE_BEZIER

public static final int STYLE_BEZIER
Represents a bezier line style

STYLE_ORTHOGONAL

public static final int STYLE_ORTHOGONAL
Represents an orthogonal line style

STYLE_SPLINE

public static final int STYLE_SPLINE
Represents an spline line style

VALUE

public static final String VALUE
Key for the value attribute. You can use any Object as a value for this key.

VERTICAL_ALIGNMENT

public static final String VERTICAL_ALIGNMENT
Key for the verticalAlignment attribute. Use instances of Integer as values for this key. Constants defined in JLabel class. This key value pair is for placment of label on vertex cell. Valid values would be JLabel.TOP, JLabel.CENTER, JLABEL.BOTTOM

VERTICAL_TEXT_POSITION

public static final String VERTICAL_TEXT_POSITION
Key for the verticalTextPosition attribute. Use instances of Integer as values for this key. Constants defined in JLabel class. This Key/Value pair affects text postion of label on vertex cell relative to image, the value is of type SwingConstant.

X_AXIS

public static final int X_AXIS
Represents an bezier line style

Y_AXIS

public static final int Y_AXIS
Represents an bezier line style

Method Detail

createAttributes

public static Map createAttributes(Object cell, Object key, Object value)
Overloaded method that passes arguments on as arrays

createAttributes

public static Map createAttributes(Object[] cells, Object key, Object value)
Overloaded method that passes arguments on as arrays

createAttributes

public static Map createAttributes(Object[] cells, Object[] keys, Object[] values)
Returns a new (nested) map, from cells to attribute maps. The attributes are populated with the (key, value)-pairs specified by the two given arrays. The keys and values parameters must match in size.

createAttributes

public static Map createAttributes(Object[] elements, CellMapper cm)
Returns a new map, from cells to property maps. The elements may be instances of CellView, in which case the cell view's corresponding cell is used as a key, and its attributes are used as a property map. In any other case, the element is considered as a cell and looked-up in the cell mapper to find the corresponding view. If a view is found, its attributes are cloned and used as a property map, along with the cell as a key.

Note: This method returns a map of maps! This is different from the createMap method, which creates a map, from keys to values. This method returns a map, from cells to maps, which in turn map from keys to values.

createAttributesFromModel

public static Map createAttributesFromModel(Object[] elements, GraphModel model)

getBackground

public static final Color getBackground(Map map)
Returns the background attribute from the specified map.

getBeginSize

public static final int getBeginSize(Map map)
Returns the beginsize attribute from the specified map.

getBorder

public static final Border getBorder(Map map)
Returns the border attribute from the specified map.

getBorderColor

public static final Color getBorderColor(Map map)
Returns the bordercolor attribute from the specified map.

getBounds

public static final Rectangle2D getBounds(Map map)
Returns the bounds attribute from the specified map. Note: The CellView interface offers a getBounds method!

getDashOffset

public static final float getDashOffset(Map map)
Returns the dashoffset attribute from the specified map.

getDashPattern

public static final float[] getDashPattern(Map map)
Returns the dashpattern attribute from the specified map.

getEndSize

public static final int getEndSize(Map map)
Returns the endsize attribute from the specified map.

getExtraLabelPositions

public static final Point2D[] getExtraLabelPositions(Map map)
Returns the extralabelpositions attribute from the specified map. Extra labels only work with edges currently.

getExtraLabels

public static final Object[] getExtraLabels(Map map)
Returns the additional label objects from the specified map.Extra labels only work with edges currently.

getFont

public static Font getFont(Map map)
Returns the font for the specified attribute map. Uses default font if no font is specified in the attribute map.

getForeground

public static final Color getForeground(Map map)
Returns the foreground attribute from the specified map.

getGradientColor

public static final Color getGradientColor(Map map)
Returns the gradientcolor attribute from the specified map.

getHorizontalAlignment

public static final int getHorizontalAlignment(Map map)
Returns the horizontalalignment attribute from the specified map.

getHorizontalTextPosition

public static final int getHorizontalTextPosition(Map map)
Returns the horizontaltextposition attribute from the specified map.

getIcon

public static final Icon getIcon(Map map)
Returns the icon attribute from the specified map.

getInset

public static final int getInset(Map map)
Returns the inset attribute from the specified map. Note: The CellView interface offers a getBounds method!

getLabelPosition

public static final Point2D getLabelPosition(Map map)
Returns the label position attribute from the specified map. The point is interpreted by the EdgeRenderer as follows:
x coordinate: the percentual position on the length of the edge in direction of the edge
y coordinate: the absolute offset, orthogonally to the edge

getLineBegin

public static final int getLineBegin(Map map)
Returns the LINEBEGIN attribute from the specified map. This attribute indicates what sort of decoration should be applied to the beginning of edges when they are rendered.

See Also: ARROW_NONE ARROW_CLASSIC ARROW_TECHNICAL ARROW_SIMPLE ARROW_CIRCLE ARROW_LINE ARROW_DOUBLELINE ARROW_DIAMOND

getLineColor

public static final Color getLineColor(Map map)
Returns the linecolor attribute from the specified map.

getLineEnd

public static final int getLineEnd(Map map)
Returns the LINEEND attribute from the specified map. This attribute indicates what sort of decoration should be applied to the ends of edges when they are rendered.

See Also: ARROW_NONE ARROW_CLASSIC ARROW_TECHNICAL ARROW_SIMPLE ARROW_CIRCLE ARROW_LINE ARROW_DOUBLELINE ARROW_DIAMOND

getLineStyle

public static final int getLineStyle(Map map)
Returns the linestyle attribute from the specified map.

getLineWidth

public static final float getLineWidth(Map map)
Returns the linewidth attribute from the specified map.

getLink

public static String getLink(Map map)
Returns the link for the specified attribute map.

getMoveableAxis

public static final int getMoveableAxis(Map map)
Returns the moveableaxis attribute from the specified map.

getOffset

public static final Point2D getOffset(Map map)
Returns the offset attribute from the specified map. The offset is the position of a port relative to its origin, note this attribute is only for ports.

getPoints

public static final List getPoints(Map map)
Returns the points attribute from the specified map.

See Also: GraphConstants

getRemoveAttributes

public static final Object[] getRemoveAttributes(Map map)
Returns the attribute marked as for removal in the specified map.

getRouting

public static final Edge.Routing getRouting(Map map)
Returns the routing attribute from the specified map.

getROUTING_DEFAULT

public static Edge.Routing getROUTING_DEFAULT()

Returns: Returns the ROUTING_SIMPLE.

getROUTING_SIMPLE

public static Edge.Routing getROUTING_SIMPLE()

Returns: Returns the ROUTING_SIMPLE.

getSize

public static final Dimension getSize(Map map)
Returns the size attribute from the specified map. Not currently used in JGraph. Use getBounds to set vertex bounds instead.

getSizeableAxis

public static final int getSizeableAxis(Map map)
Returns the sizeableAxis attribute from the specified map.

getValue

public static final Object getValue(Map map)
Returns the value attribute from the specified map. Only use for transport maps, not storage map since the value is removed from the final storage map

See Also: getValue

getVerticalAlignment

public static final int getVerticalAlignment(Map map)
Returns the verticalalignment attribute from the specified map.

getVerticalTextPosition

public static final int getVerticalTextPosition(Map map)
Returns the verticaltextposition attribute from the specified map.

isAbsoluteX

public static final boolean isAbsoluteX(Map map)
Returns the absolutex attribute from the specified map.

isAbsoluteY

public static final boolean isAbsoluteY(Map map)
Returns the absolutey attribute from the specified map.

isAutoSize

public static final boolean isAutoSize(Map map)
Returns the autosize attribute from the specified map.

isBeginFill

public static final boolean isBeginFill(Map map)
Returns the beginfill attribute from the specified map.

isBendable

public static final boolean isBendable(Map map)
Returns the bendable attribute from the specified map.

isChildrenSelectable

public static final boolean isChildrenSelectable(Map map)
Returns the childrenselectable attribute from the specified map.

isConnectable

public static final boolean isConnectable(Map map)
Returns the connectable attribute from the specified map.

isConstrained

public static final boolean isConstrained(Map map)
Returns the constrained attribute from the specified map.

isDisconnectable

public static final boolean isDisconnectable(Map map)
Returns the disconnectable attribute from the specified map.

isEditable

public static final boolean isEditable(Map map)
Returns the editable attribute from the specified map.

isEndFill

public static final boolean isEndFill(Map map)
Returns the endfill attribute from the specified map.

isExactSegmentLabel

public static boolean isExactSegmentLabel(Map map)
Returns whether the exact segment is worked out for placement of labels along edges for the specified cell.

Parameters: map the attribute map for the cell being tested for this condition.

Returns: whether or not exact segments should be calculated on this cell

isGroupOpaque

public static final boolean isGroupOpaque(Map map)
Returns the opaque attribute from the specified map.

isLabelAlongEdge

public static final boolean isLabelAlongEdge(Map map)
Returns the true if the label should be painted along the edge. Defaults to false.

isLabelEnabled

public static boolean isLabelEnabled(Map map)
Returns whether the label is enabled for the specified cell.

Parameters: map the attribute map for the cell being tested for this condition.

Returns: whether or not labels should be displayed on this cell

isMoveable

public static final boolean isMoveable(Map map)
Returns the moveable attribute from the specified map.

isOpaque

public static final boolean isOpaque(Map map)
Returns the opaque attribute from the specified map.

isRemoveAll

public static final boolean isRemoveAll(Map map)
Returns the removeall attribute from the specified map.

isResize

public static final boolean isResize(Map map)
Returns the resize attribute from the specified map.

isSelectable

public static final boolean isSelectable(Map map)
Returns the selectable attribute from the specified map.

See Also: GraphConstants

isSizeable

public static final boolean isSizeable(Map map)
Returns the sizeable attribute from the specified map.

merge

public static Map merge(Map change, Map target)
Merges the specified nested maps by adding all attributes in the change to the attributes for the cell in target, if the cell does not exist in target, then a new entry is added with all attributes from change. Returns the modified target map. Note: This method removes entries from change and adds entries to target in-place!

Returns: a map including all attributes from change merged with target

replaceKeys

public static Map replaceKeys(Map keyMap, Map map)
Replace the keys in map using keyMapmap must itself be a map, and is cloned using cloneMap.

setAbsolute

public static final void setAbsolute(Map map, boolean flag)
Sets the absolute attributes in the specified map to the specified value.

setAbsoluteX

public static final void setAbsoluteX(Map map, boolean flag)
Sets the absolutex attribute in the specified map to the specified value.

setAbsoluteY

public static final void setAbsoluteY(Map map, boolean flag)
Sets the absolutey attribute in the specified map to the specified value.

setAutoSize

public static final void setAutoSize(Map map, boolean flag)
Sets the autosize attribute in the specified map to the specified value.

setBackground

public static final void setBackground(Map map, Color value)
Sets the background attribute in the specified map to the specified value.

setBeginFill

public static final void setBeginFill(Map map, boolean flag)
Sets the beginfill attribute in the specified map to the specified value.

setBeginSize

public static final void setBeginSize(Map map, int style)
Sets the beginsize attribute in the specified map to the specified value.

setBendable

public static final void setBendable(Map map, boolean flag)
Sets the bendable attribute in the specified map to the specified value.

setBorder

public static final void setBorder(Map map, Border value)
Sets the border attribute in the specified map to the specified value.

setBorderColor

public static final void setBorderColor(Map map, Color value)
Sets the bordercolor attribute in the specified map to the specified value.

setBounds

public static final void setBounds(Map map, Rectangle2D bounds)
Sets the bounds attribute in the specified map to the specified value.

setChildrenSelectable

public static final void setChildrenSelectable(Map map, boolean flag)
Sets the childrenselectable attribute in the specified map to the specified value.

setConnectable

public static final void setConnectable(Map map, boolean flag)
Sets the connectable attribute in the specified map to the specified value.

setConstrained

public static final void setConstrained(Map map, boolean flag)
Sets the constrained attribute in the specified map to the specified value.

setDashOffset

public static final void setDashOffset(Map map, float value)
Sets the dashoffset attribute in the specified map to the specified value.

setDashPattern

public static final void setDashPattern(Map map, float[] value)
Sets the dashpattern attribute in the specified map to the specified value.

setDisconnectable

public static final void setDisconnectable(Map map, boolean flag)
Sets the disconnectable attribute in the specified map to the specified value.

setEditable

public static final void setEditable(Map map, boolean flag)
Sets the editable attribute in the specified map to the specified value.

setEndFill

public static final void setEndFill(Map map, boolean flag)
Sets the endfill attribute in the specified map to the specified value.

setEndSize

public static final void setEndSize(Map map, int style)
Sets the endsize attribute in the specified map to the specified value.

setExactSegmentLabel

public static void setExactSegmentLabel(Map map, boolean flag)
Sets the exact segment attribute in the specified map to the specified value.

Parameters: map The map to store the exact segment attribute in. flag The value to set the exact segment attribute to.

setExtraLabelPositions

public static final void setExtraLabelPositions(Map map, Point2D[] positions)
Sets the labelpositions attribute in the specified map to the specified value. The Point instance at a particular index corresponds to the object at the same index in the extralabels array attribute. Extra labels only work with edges currently.

See Also: getLabelPosition

setExtraLabels

public static final void setExtraLabels(Map map, Object[] definitions)
Sets the array of additional labels. The objects's toString methods are used to determine the actual label string. Extra labels only work with edges currently.

setFont

public static void setFont(Map map, Font font)
Sets the value attribute in the specified map to the specified font value.

Parameters: map The map to store the font attribute in. font The value to set the font attribute to.

setForeground

public static final void setForeground(Map map, Color value)
Sets the foregrund attribute in the specified map to the specified value.

setGradientColor

public static final void setGradientColor(Map map, Color value)
Sets the gradientcolor attribute in the specified map to the specified value.

setGroupOpaque

public static final void setGroupOpaque(Map map, boolean flag)
Sets the opaque attribute in the specified map to the specified value.

setHorizontalAlignment

public static final void setHorizontalAlignment(Map map, int alignment)
This method set the position of the label in vertex cells, and takes aruguments of type SwingConstants (for JLabel) i.e. JLabel.LEFT etc. Default is JLabel.CENTER. This method has no effect on edge cells.

setHorizontalTextPosition

public static final void setHorizontalTextPosition(Map map, int textPosition)
This method set the text of a label on vertext cell relative to image. See JLabel api. Default value is JLabel.CENTER.

setIcon

public static final void setIcon(Map map, Icon value)
Sets the icon attribute in the specified map to the specified value.

setInset

public static final void setInset(Map map, int width)
Sets the inset attribute in the specified map to the specified value.

setLabelAlongEdge

public static final void setLabelAlongEdge(Map map, boolean flag)
Sets if the label should be painted along the edge.

setLabelEnabled

public static void setLabelEnabled(Map map, boolean flag)
Sets the label enabled attribute in the specified map to the specified value.

Parameters: map The map to store the label enabled attribute in. flag The value to set the label enabled attribute to.

setLabelPosition

public static final void setLabelPosition(Map map, Point2D position)
Sets the label position attribute in the specified map to the specified value.

setLineBegin

public static final void setLineBegin(Map map, int style)
Sets the LINEBEGIN attribute in the specified map to the specified value. This attribute indicates what sort of decoration should be applied to the beginning of edges when they are rendered.

See Also: ARROW_NONE ARROW_CLASSIC ARROW_TECHNICAL ARROW_SIMPLE ARROW_CIRCLE ARROW_LINE ARROW_DOUBLELINE ARROW_DIAMOND

setLineColor

public static final void setLineColor(Map map, Color value)
Sets the linecolor attribute in the specified map to the specified value.

setLineEnd

public static final void setLineEnd(Map map, int style)
Sets the LINEEND attribute in the specified map to the specified value. This attribute indicates what sort of decoration should be applied to the ends of edges when they are rendered.

See Also: ARROW_NONE ARROW_CLASSIC ARROW_TECHNICAL ARROW_SIMPLE ARROW_CIRCLE ARROW_LINE ARROW_DOUBLELINE ARROW_DIAMOND

setLineStyle

public static final void setLineStyle(Map map, int style)
Sets the linestyle attribute in the specified map to the specified value.

setLineWidth

public static final void setLineWidth(Map map, float width)
Sets the linewidth attribute in the specified map to the specified value.

setLink

public static void setLink(Map map, String link)
Sets the link attribute in the specified map to the specified value.

Parameters: map The map to store the link attribute in. link The value to set the link attribute to.

setMoveable

public static final void setMoveable(Map map, boolean flag)
Sets the moveable attribute in the specified map to the specified value.

setMoveableAxis

public static final void setMoveableAxis(Map map, int axis)
Sets the moveableaxis attribute in the specified map to the specified value.

setOffset

public static final void setOffset(Map map, Point2D offset)
Sets the offset attribute in the specified map to the specified value. The offset is the position of a port relative to its origin, note this attribute is only for ports.

setOpaque

public static final void setOpaque(Map map, boolean flag)
Sets the opaque attribute in the specified map to the specified value.

setPoints

public static final void setPoints(Map map, List list)
Sets the points attribute in the specified map to the specified value. Points are literally the points where an edge is connected by two lines. The two defaults points are the start and end of the edge. For example, for an simple orthogonal edge there will be two extra points indicating where the two right-angled bends are. This attribute can only be applied to an edge.

setRemoveAll

public static final void setRemoveAll(Map map, boolean flag)
Sets the removeall attribute in the specified map to the specified value.

setRemoveAttributes

public static final void setRemoveAttributes(Map map, Object[] value)
Sets specific attributes are being marked for removal @ param map The transport map indicating the attribute removal @ param value The attributes to be removed

setResize

public static final void setResize(Map map, boolean flag)
Sets the resize attribute in the specified map to the specified value.

setRouting

public static final void setRouting(Map map, Edge.Routing routing)
Sets the routing attribute in the specified map to the specified value.

setSelectable

public static final void setSelectable(Map map, boolean flag)
Sets the selectable attribute in the specified map to the specified value. This detemines whether or not a cell may be selected. Vertices and edges may be selectable, not ports.

setSize

public static final void setSize(Map map, Dimension size)
Sets the size attribute in the specified map to the specified value. Not currently used in JGraph. Use setBounds to set vertex bounds instead.

setSizeable

public static final void setSizeable(Map map, boolean flag)
Sets the sizeable attribute in the specified map to the specified value.

setSizeableAxis

public static final void setSizeableAxis(Map map, int axis)
Sets the sizeableAxis attribute in the specified map to the specified value.

setValue

public static final void setValue(Map map, Object value)
Sets the value attribute in the specified map to the specified value.

setVerticalAlignment

public static final void setVerticalAlignment(Map map, int alignment)
This method set the position of the label in vertex cells, and takes aruguments of type SwingConstants (for JLabel) i.e. JLabel.TOP etc. Default value is JLabel.CENTER. This method has no effect on edge cells.

setVerticalTextPosition

public static final void setVerticalTextPosition(Map map, int textPosition)
This method set the text of a label on vertext cell relative to image. See JLabel api. Default value is JLabel.BOTTOM.
Copyright (C) 2001-2009 JGraph Ltd. All rights reserved.