Class GraphConstants

Method Details

• 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)

• replaceKeys

  public static Map replaceKeys(Map keyMap, Map map)

  Replace the keys in map using keyMap</code, which maps from old to new keys. The value in map must itself be a map, and is cloned using cloneMap.

• 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

• 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.

• 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.

• 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

• getRemoveAttributes

  public static final Object[] getRemoveAttributes(Map map)

  Returns the attribute marked as for removal in the specified map.

• setMoveableAxis

  public static final void setMoveableAxis(Map map, int axis)

  Sets the moveableaxis attribute in the specified map to the specified value.

• getMoveableAxis

  public static final int getMoveableAxis(Map map)

  Returns the moveableaxis attribute from the specified map.

• setSizeableAxis

  public static final void setSizeableAxis(Map map, int axis)

  Sets the sizeableAxis attribute in the specified map to the specified value.

• getSizeableAxis

  public static final int getSizeableAxis(Map map)

  Returns the sizeableAxis attribute from the specified map.

• setIcon

  public static final void setIcon(Map map, Icon value)

  Sets the icon attribute in the specified map to the specified value.

• getIcon

  public static final Icon getIcon(Map map)

  Returns the icon attribute from the specified map.

• setOpaque

  public static final void setOpaque(Map map, boolean flag)

  Sets the opaque attribute in the specified map to the specified value.

• isOpaque

  public static final boolean isOpaque(Map map)

  Returns the opaque attribute from the specified map.

• setGroupOpaque

  public static final void setGroupOpaque(Map map, boolean flag)

  Sets the opaque attribute in the specified map to the specified value.

• isGroupOpaque

  public static final boolean isGroupOpaque(Map map)

  Returns the opaque attribute from the specified map.

• setBorder

  public static final void setBorder(Map map, Border value)

  Sets the border attribute in the specified map to the specified value.

• getBorder

  public static final Border getBorder(Map map)

  Returns the border attribute from the specified map.

• setLineColor

  public static final void setLineColor(Map map, Color value)

  Sets the linecolor attribute in the specified map to the specified value.

• getLineColor

  public static final Color getLineColor(Map map)

  Returns the linecolor attribute from the specified map.

• setBorderColor

  public static final void setBorderColor(Map map, Color value)

  Sets the bordercolor attribute in the specified map to the specified value.

• getBorderColor

  public static final Color getBorderColor(Map map)

  Returns the bordercolor attribute from the specified map.

• setLineWidth

  public static final void setLineWidth(Map map, float width)

  Sets the linewidth attribute in the specified map to the specified value.

• getLineWidth

  public static final float getLineWidth(Map map)

  Returns the linewidth attribute from the specified map.

• setForeground

  public static final void setForeground(Map map, Color value)

  Sets the foregrund attribute in the specified map to the specified value.

• getForeground

  public static final Color getForeground(Map map)

  Returns the foreground attribute from the specified map.

• setBackground

  public static final void setBackground(Map map, Color value)

  Sets the background attribute in the specified map to the specified value.

• getBackground

  public static final Color getBackground(Map map)

  Returns the background attribute from the specified map.

• setGradientColor

  public static final void setGradientColor(Map map, Color value)

  Sets the gradientcolor attribute in the specified map to the specified value.

• getGradientColor

  public static final Color getGradientColor(Map map)

  Returns the gradientcolor attribute from the specified map.

• 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.

• getVerticalAlignment

  public static final int getVerticalAlignment(Map map)

  Returns the verticalalignment attribute from the specified map.

• 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.

• getHorizontalAlignment

  public static final int getHorizontalAlignment(Map map)

  Returns the horizontalalignment attribute from the specified map.

• 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.

• getVerticalTextPosition

  public static final int getVerticalTextPosition(Map map)

  Returns the verticaltextposition attribute from the specified map.

• 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.

• getHorizontalTextPosition

  public static final int getHorizontalTextPosition(Map map)

  Returns the horizontaltextposition attribute from the specified map.

• setDashPattern

  public static final void setDashPattern(Map map, float[] value)

  Sets the dashpattern attribute in the specified map to the specified value.

• getDashPattern

  public static final float[] getDashPattern(Map map)

  Returns the dashpattern attribute from the specified map.

• setDashOffset

  public static final void setDashOffset(Map map, float value)

  Sets the dashoffset attribute in the specified map to the specified value.

• getDashOffset

  public static final float getDashOffset(Map map)

  Returns the dashoffset attribute from the specified map.

• setLineStyle

  public static final void setLineStyle(Map map, int style)

  Sets the linestyle attribute in the specified map to the specified value.

• getLineStyle

  public static final int getLineStyle(Map map)

  Returns the linestyle attribute from the specified map.

• setBeginSize

  public static final void setBeginSize(Map map, int style)

  Sets the beginsize attribute in the specified map to the specified value.

• getBeginSize

  public static final int getBeginSize(Map map)

  Returns the beginsize attribute from the specified map.

• setEndSize

  public static final void setEndSize(Map map, int style)

  Sets the endsize attribute in the specified map to the specified value.

• getEndSize

  public static final int getEndSize(Map map)

  Returns the endsize attribute from the specified map.

• 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

• 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

• 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

• 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

• setValue

  public static final void setValue(Map map, Object value)

  Sets the value attribute in the specified map to the specified value.

• 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:

  • GraphModel.getValue(Object)

• setLabelPosition

  public static final void setLabelPosition(Map map, Point2D position)

  Sets the label position attribute in the specified map to the specified value.

• 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

• 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.

• getExtraLabels

  public static final Object[] getExtraLabels(Map map)

  Returns the additional label objects from the specified map.Extra labels only work with edges currently.

• 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(Map)

• getExtraLabelPositions

  public static final Point2D[] getExtraLabelPositions(Map map)

  Returns the extralabelpositions attribute from the specified map. Extra labels only work with edges currently.

• setLabelAlongEdge

  public static final void setLabelAlongEdge(Map map, boolean flag)

  Sets if the label should be painted along the edge.

• isLabelAlongEdge

  public static final boolean isLabelAlongEdge(Map map)

  Returns the true if the label should be painted along the edge. Defaults to false.

• setEditable

  public static final void setEditable(Map map, boolean flag)

  Sets the editable attribute in the specified map to the specified value.

• isEditable

  public static final boolean isEditable(Map map)

  Returns the editable attribute from the specified map.

• setMoveable

  public static final void setMoveable(Map map, boolean flag)

  Sets the moveable attribute in the specified map to the specified value.

• isMoveable

  public static final boolean isMoveable(Map map)

  Returns the moveable attribute from the specified map.

• setSizeable

  public static final void setSizeable(Map map, boolean flag)

  Sets the sizeable attribute in the specified map to the specified value.

• isSizeable

  public static final boolean isSizeable(Map map)

  Returns the sizeable attribute from the specified map.

• setAutoSize

  public static final void setAutoSize(Map map, boolean flag)

  Sets the autosize attribute in the specified map to the specified value.

• isAutoSize

  public static final boolean isAutoSize(Map map)

  Returns the autosize attribute from the specified map.

• setResize

  public static final void setResize(Map map, boolean flag)

  Sets the resize attribute in the specified map to the specified value.

• isResize

  public static final boolean isResize(Map map)

  Returns the resize attribute from the specified map.

• setConstrained

  public static final void setConstrained(Map map, boolean flag)

  Sets the constrained attribute in the specified map to the specified value.

• isConstrained

  public static final boolean isConstrained(Map map)

  Returns the constrained attribute from the specified map.

• 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.

• isSelectable

  public static final boolean isSelectable(Map map)

  Returns the selectable attribute from the specified map.

  See Also:

  • setSelectable(Map, boolean)

• setChildrenSelectable

  public static final void setChildrenSelectable(Map map, boolean flag)

  Sets the childrenselectable attribute in the specified map to the specified value.

• isChildrenSelectable

  public static final boolean isChildrenSelectable(Map map)

  Returns the childrenselectable attribute from the specified map.

• setBendable

  public static final void setBendable(Map map, boolean flag)

  Sets the bendable attribute in the specified map to the specified value.

• isBendable

  public static final boolean isBendable(Map map)

  Returns the bendable attribute from the specified map.

• setConnectable

  public static final void setConnectable(Map map, boolean flag)

  Sets the connectable attribute in the specified map to the specified value.

• isConnectable

  public static final boolean isConnectable(Map map)

  Returns the connectable attribute from the specified map.

• setDisconnectable

  public static final void setDisconnectable(Map map, boolean flag)

  Sets the disconnectable attribute in the specified map to the specified value.

• isDisconnectable

  public static final boolean isDisconnectable(Map map)

  Returns the disconnectable attribute from the specified map.

• 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.

• getPoints

  public static final List getPoints(Map map)

  Returns the points attribute from the specified map.

  See Also:

  • setPoints(Map, java.util.List)

• setRouting

  public static final void setRouting(Map map, Edge.Routing routing)

  Sets the routing attribute in the specified map to the specified value.

• getRouting

  public static final Edge.Routing getRouting(Map map)

  Returns the routing attribute from the specified map.

• setBounds

  public static final void setBounds(Map map, Rectangle2D bounds)

  Sets the bounds attribute in the specified map to the specified value.

• getBounds

  public static final Rectangle2D getBounds(Map map)

  Returns the bounds attribute from the specified map. Note: The CellView interface offers a getBounds method!

• setInset

  public static final void setInset(Map map, int width)

  Sets the inset attribute in the specified map to the specified value.

• getInset

  public static final int getInset(Map map)

  Returns the inset attribute from the specified map. Note: The CellView interface offers a getBounds method!

• 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.

• 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.

• 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.

• 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.

• setBeginFill

  public static final void setBeginFill(Map map, boolean flag)

  Sets the beginfill attribute in the specified map to the specified value.

• isBeginFill

  public static final boolean isBeginFill(Map map)

  Returns the beginfill attribute from the specified map.

• setEndFill

  public static final void setEndFill(Map map, boolean flag)

  Sets the endfill attribute in the specified map to the specified value.

• isEndFill

  public static final boolean isEndFill(Map map)

  Returns the endfill attribute from the specified map.

• setAbsolute

  public static final void setAbsolute(Map map, boolean flag)

  Sets the absolute attributes 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.

• isAbsoluteY

  public static final boolean isAbsoluteY(Map map)

  Returns the absolutey attribute from the specified map.

• setAbsoluteX

  public static final void setAbsoluteX(Map map, boolean flag)

  Sets the absolutex attribute in the specified map to the specified value.

• isAbsoluteX

  public static final boolean isAbsoluteX(Map map)

  Returns the absolutex attribute from the specified map.

• setRemoveAll

  public static final void setRemoveAll(Map map, boolean flag)

  Sets the removeall attribute in the specified map to the specified value.

• isRemoveAll

  public static final boolean isRemoveAll(Map map)

  Returns the removeall attribute from the specified map.

• getROUTING_SIMPLE

  public static Edge.Routing getROUTING_SIMPLE()

  Returns:

  Returns the ROUTING_SIMPLE.

• getROUTING_DEFAULT

  public static Edge.Routing getROUTING_DEFAULT()

  Returns:

  Returns the ROUTING_SIMPLE.

• 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.

• getLink

  public static String getLink(Map map)

  Returns the link for the specified attribute map.

• 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.

• 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

• 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.

• 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