BasicVisualLexicon (Cytoscape Swing App API (swing-app-api) 3.7.0 API)

java.lang.Object
- org.cytoscape.view.presentation.property.BasicVisualLexicon

All Implemented Interfaces:

VisualLexicon
```
public class BasicVisualLexicon
extends Object
implements VisualLexicon
```
Basic Implementation of VisualLexicon.
Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
Module: presentation-api
To use this in your app, include the following dependency in your POM:
```
<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>presentation-api</artifactId>
</dependency>
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Range<Double>`	`ARBITRARY_DOUBLE_RANGE`
`protected static Range<String>`	`ARBITRARY_STRING_RANGE`
`static VisualProperty<Visualizable>`	`EDGE`
`static EdgeBendVisualProperty`	`EDGE_BEND` If Edge Bend is defined, edges will be rendered as straight or curved lines.
`static VisualProperty<String>`	`EDGE_LABEL` The text used for the edge label.
`static VisualProperty<Paint>`	`EDGE_LABEL_COLOR` TODO Documentation
`static VisualProperty<Font>`	`EDGE_LABEL_FONT_FACE` The font used for the edge label.
`static VisualProperty<Integer>`	`EDGE_LABEL_FONT_SIZE` The size of the font used for the edge label.
`static VisualProperty<Integer>`	`EDGE_LABEL_TRANSPARENCY` The opacity of the color of the edge label.
`static VisualProperty<Double>`	`EDGE_LABEL_WIDTH` TODO Documentation
`static VisualProperty<LineType>`	`EDGE_LINE_TYPE` The type of stoke used to render the line (solid, dashed, etc.)
`static VisualProperty<Paint>`	`EDGE_PAINT` The color of the whole edge (including the stroke and arrows) when it is selected or unselected.
`static VisualProperty<Boolean>`	`EDGE_SELECTED` TODO Documentation
`static VisualProperty<Paint>`	`EDGE_SELECTED_PAINT` The color of the whole edge (stroke and arrows) when selected.
`static VisualProperty<ArrowShape>`	`EDGE_SOURCE_ARROW_SHAPE` The shape of the arrow on the source node end of the edge.
`static VisualProperty<Double>`	`EDGE_SOURCE_ARROW_SIZE` TODO Documentation
`static VisualProperty<Paint>`	`EDGE_STROKE_SELECTED_PAINT` The color of the edge line when selected.
`static VisualProperty<Paint>`	`EDGE_STROKE_UNSELECTED_PAINT` The color of the edge line.
`static VisualProperty<ArrowShape>`	`EDGE_TARGET_ARROW_SHAPE` The shape of the arrow on the target node end of the edge.
`static VisualProperty<Double>`	`EDGE_TARGET_ARROW_SIZE` TODO Documentation
`static VisualProperty<String>`	`EDGE_TOOLTIP` The text of the tooltip that appears when a mouse hovers over the edge.
`static VisualProperty<Integer>`	`EDGE_TRANSPARENCY` The opacity of the of the edge.
`static VisualProperty<Paint>`	`EDGE_UNSELECTED_PAINT` The color of the whole edge (stroke and arrows) when it is not selected.
`static VisualProperty<Boolean>`	`EDGE_VISIBLE` Hides the edge if set to false.
`static VisualProperty<Double>`	`EDGE_WIDTH` The width of the edge line.
`protected static Color`	`MAX_COLOR`
`protected static Color`	`MIN_COLOR`
`static VisualProperty<Visualizable>`	`NETWORK`
`static VisualProperty<Paint>`	`NETWORK_BACKGROUND_PAINT` The background color of the network view.
`static VisualProperty<Double>`	`NETWORK_CENTER_X_LOCATION` The X location of network view center.
`static VisualProperty<Double>`	`NETWORK_CENTER_Y_LOCATION` The Y location of network view center.
`static VisualProperty<Double>`	`NETWORK_CENTER_Z_LOCATION` TODO Documentation
`static VisualProperty<Double>`	`NETWORK_DEPTH` TODO Documentation
`static VisualProperty<Double>`	`NETWORK_HEIGHT` The height of the network view.
`static VisualProperty<Double>`	`NETWORK_SCALE_FACTOR` The zoom level of the network view.
`static VisualProperty<Double>`	`NETWORK_SIZE` The size (width and height) of the network view.
`static VisualProperty<String>`	`NETWORK_TITLE` The title of the network view.
`static VisualProperty<Double>`	`NETWORK_WIDTH` The width of the network view.
`static VisualProperty<Visualizable>`	`NODE`
`static VisualProperty<LineType>`	`NODE_BORDER_LINE_TYPE` The type of line used for the border of the node.
`static VisualProperty<Paint>`	`NODE_BORDER_PAINT` The color of the border of the node.
`static VisualProperty<Integer>`	`NODE_BORDER_TRANSPARENCY` TODO Documentation
`static VisualProperty<Double>`	`NODE_BORDER_WIDTH` TODO Documentation
`static VisualProperty<Double>`	`NODE_DEPTH` TODO Documentation
`static VisualProperty<Paint>`	`NODE_FILL_COLOR` The color of the node.
`static VisualProperty<Double>`	`NODE_HEIGHT` The height of the node.
`static VisualProperty<String>`	`NODE_LABEL` The text used for the node label.
`static VisualProperty<Paint>`	`NODE_LABEL_COLOR` The color of the node label.
`static VisualProperty<Font>`	`NODE_LABEL_FONT_FACE` The font used for the node label.
`static VisualProperty<Integer>`	`NODE_LABEL_FONT_SIZE` The size of the font used for the node label.
`static VisualProperty<Integer>`	`NODE_LABEL_TRANSPARENCY` TODO Documentation
`static VisualProperty<Double>`	`NODE_LABEL_WIDTH` The maximum width of the node label.
`static VisualProperty<Boolean>`	`NODE_NESTED_NETWORK_IMAGE_VISIBLE` A boolean value that indicates whether a nested network should be visualized (assuming a nested network is present for the specified node).
`static VisualProperty<Integer>`	`NODE_OPACITY` See `NODE_TRANSPARENCY`
`static VisualProperty<Paint>`	`NODE_PAINT` The color of the whole node, including its border, label and selected paint.
`static VisualProperty<Boolean>`	`NODE_SELECTED` TODO Documentation
`static VisualProperty<Paint>`	`NODE_SELECTED_PAINT` TODO Documentation
`static VisualProperty<NodeShape>`	`NODE_SHAPE` The shape of the node.
`static VisualProperty<Double>`	`NODE_SIZE` The size of the node.
`static VisualProperty<String>`	`NODE_TOOLTIP` The text of the tooltip that appears when a mouse hovers over the node.
`static VisualProperty<Integer>`	`NODE_TRANSPARENCY` The opacity of the color of the node.
`static VisualProperty<Boolean>`	`NODE_VISIBLE` Hides the node if set to false.
`static VisualProperty<Double>`	`NODE_WIDTH` The width of the node.
`static VisualProperty<Double>`	`NODE_X_LOCATION` X location of the node.
`static VisualProperty<Double>`	`NODE_Y_LOCATION` Y location of the node.
`static VisualProperty<Double>`	`NODE_Z_LOCATION` Z location of the node.
`protected static Range<Double>`	`NONE_ZERO_POSITIVE_DOUBLE_RANGE`
`protected static Range<Paint>`	`PAINT_RANGE`
`protected VisualProperty<NullDataType>`	`rootVisualProperty` The Root of this tree.
`protected static Set<String>`	`STRING_SET`

Constructor Summary

Constructors
Constructor and Description

BasicVisualLexicon(VisualProperty<NullDataType> rootVisualProperty)
Constructor for VisualLexicon.

Constructors
Constructor and Description
`BasicVisualLexicon(VisualProperty<NullDataType> rootVisualProperty)` Constructor for VisualLexicon.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBendFactory(BendFactory bendFactory, Map<?,?> props)`
`protected void`	`addIdentifierMapping(Class<?> type, String id, VisualProperty<?> vp)`
`protected void`	`addVisualProperty(VisualProperty<?> vp, VisualProperty<?> parent)` Insert a `VisualProperty` to the tree.
`Collection<VisualProperty<?>>`	`getAllDescendants(VisualProperty<?> prop)` Get collection of visual properties for a given object type (node/edge/network).
`Set<VisualProperty<?>>`	`getAllVisualProperties()` Returns the Set of VisualPropertys supported by this Renderer.
`VisualProperty<NullDataType>`	`getRootVisualProperty()` Get root of this tree.
`<T> Set<T>`	`getSupportedValueRange(VisualProperty<T> vp)` Returns a filtered value range for a `VisualProperty` that uses a `DiscreteRange`.
`VisualLexiconNode`	`getVisualLexiconNode(VisualProperty<?> vp)` Get a tree node in for the given VisualProperty.
`boolean`	`isSupported(VisualProperty<?> vp)` Test the given Visual Property is supported in this Lexicon.
`VisualProperty<?>`	`lookup(Class<?> type, String id)` Returns the appropriate visual property for the descriptive string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - rootVisualProperty
```
protected final VisualProperty<NullDataType> rootVisualProperty
```
    The Root of this tree.
  - MIN_COLOR
```
protected static final Color MIN_COLOR
```
  - MAX_COLOR
```
protected static final Color MAX_COLOR
```
  - PAINT_RANGE
```
protected static final Range<Paint> PAINT_RANGE
```
  - STRING_SET
```
protected static final Set<String> STRING_SET
```
  - ARBITRARY_STRING_RANGE
```
protected static final Range<String> ARBITRARY_STRING_RANGE
```
  - ARBITRARY_DOUBLE_RANGE
```
protected static final Range<Double> ARBITRARY_DOUBLE_RANGE
```
  - NONE_ZERO_POSITIVE_DOUBLE_RANGE
```
protected static final Range<Double> NONE_ZERO_POSITIVE_DOUBLE_RANGE
```
  - NETWORK
```
public static final VisualProperty<Visualizable> NETWORK
```
  - NODE
```
public static final VisualProperty<Visualizable> NODE
```
  - EDGE
```
public static final VisualProperty<Visualizable> EDGE
```
  - NODE_PAINT
```
public static final VisualProperty<Paint> NODE_PAINT
```
    The color of the whole node, including its border, label and selected paint.
    Property Type: Color
    
    Property Range: A non-null color
  - NODE_FILL_COLOR
```
public static final VisualProperty<Paint> NODE_FILL_COLOR
```
    The color of the node.
    Property Type: Color
    
    Property Range: A non-null color
  - NODE_LABEL_COLOR
```
public static final VisualProperty<Paint> NODE_LABEL_COLOR
```
    The color of the node label.
    Property Type: Color
    
    Property Range: A non-null color
  - NODE_LABEL
```
public static final VisualProperty<String> NODE_LABEL
```
    The text used for the node label.
    Property Type: String
    
    Property Range: Any string
  - NODE_X_LOCATION
```
public static final VisualProperty<Double> NODE_X_LOCATION
```
    X location of the node. Default value of this will be ignored. The value will be used only when mapping function is defined.
    Property Type: Double
    
    Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY
  - NODE_Y_LOCATION
```
public static final VisualProperty<Double> NODE_Y_LOCATION
```
    Y location of the node. Default value of this will be ignored. The value will be used only when mapping function is defined.
    Property Type: Double
    
    Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY
  - NODE_SIZE
```
public static final VisualProperty<Double> NODE_SIZE
```
    The size of the node. Width and height will be equal. This property is mutually exclusive of Node Height and Node Width.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NODE_WIDTH
```
public static final VisualProperty<Double> NODE_WIDTH
```
    The width of the node. Width will be independent of height. This property is mutually exclusive of Node Size.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NODE_HEIGHT
```
public static final VisualProperty<Double> NODE_HEIGHT
```
    The height of the node. Height will be independent of width. This property is mutually exclusive of Node Size.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NODE_VISIBLE
```
public static final VisualProperty<Boolean> NODE_VISIBLE
```
    Hides the node if set to false. By default, this value is set to true.
    Property Type: Boolean
    
    Property Range: true or false
  - NODE_SELECTED
```
public static final VisualProperty<Boolean> NODE_SELECTED
```
    TODO Documentation
    Property Type: Boolean
    
    Property Range: true or false
  - NODE_NESTED_NETWORK_IMAGE_VISIBLE
```
public static final VisualProperty<Boolean> NODE_NESTED_NETWORK_IMAGE_VISIBLE
```
    A boolean value that indicates whether a nested network should be visualized (assuming a nested network is present for the specified node).
    Property Type: Boolean
    
    Property Range: true or false
  - NODE_LABEL_WIDTH
```
public static final VisualProperty<Double> NODE_LABEL_WIDTH
```
    The maximum width of the node label. If the node label is wider than the specified width, Cytoscape will automatically wrap the label on space characters. Cytoscape will not hyphenate words, meaning that if a single word (i.e. no spaces) is longer than maximum width, the word will be displayed beyond the maximum width.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NODE_SELECTED_PAINT
```
public static final VisualProperty<Paint> NODE_SELECTED_PAINT
```
    TODO Documentation
    Property Type: Color
    
    Property Range: A non-null color
  - NODE_BORDER_PAINT
```
public static final VisualProperty<Paint> NODE_BORDER_PAINT
```
    The color of the border of the node.
    Property Type: Color
    
    Property Range: A non-null color
  - NODE_BORDER_WIDTH
```
public static final VisualProperty<Double> NODE_BORDER_WIDTH
```
    TODO Documentation
    Property Type: Double
    
    Property Range: 0 <= value <= Double.POSITIVE_INFINITY
  - NODE_TOOLTIP
```
public static final VisualProperty<String> NODE_TOOLTIP
```
    The text of the tooltip that appears when a mouse hovers over the node.
    Property Type: String
    
    Property Range: Any string
  - NODE_LABEL_FONT_FACE
```
public static final VisualProperty<Font> NODE_LABEL_FONT_FACE
```
    The font used for the node label.
    Property Type: Font
    
    Property Range: Any font available in the local graphics environment
  - NODE_LABEL_FONT_SIZE
```
public static final VisualProperty<Integer> NODE_LABEL_FONT_SIZE
```
    The size of the font used for the node label.
    Property Type: Integer
    
    Property Range: 1 <= value <= Integer.MAX_VALUE
  - NODE_TRANSPARENCY
```
public static final VisualProperty<Integer> NODE_TRANSPARENCY
```
    The opacity of the color of the node. Zero means totally transparent, and 255 means totally opaque.
    Property Type: Integer
    
    Property Range: 0 <= value <= 255
  - NODE_OPACITY
```
public static final VisualProperty<Integer> NODE_OPACITY
```
    See NODE_TRANSPARENCY
  - NODE_BORDER_TRANSPARENCY
```
public static final VisualProperty<Integer> NODE_BORDER_TRANSPARENCY
```
    TODO Documentation
    Property Type: Integer
    
    Property Range: 0 <= value <= 255
  - NODE_LABEL_TRANSPARENCY
```
public static final VisualProperty<Integer> NODE_LABEL_TRANSPARENCY
```
    TODO Documentation
    Property Type: Integer
    
    Property Range: 0 <= value <= 255
  - NODE_SHAPE
```
public static final VisualProperty<NodeShape> NODE_SHAPE
```
    The shape of the node.
    Additional Details: NodeShapeVisualProperty
  - NODE_BORDER_LINE_TYPE
```
public static final VisualProperty<LineType> NODE_BORDER_LINE_TYPE
```
    The type of line used for the border of the node.
    Additional Details: LineTypeVisualProperty
  - EDGE_PAINT
```
public static final VisualProperty<Paint> EDGE_PAINT
```
    The color of the whole edge (including the stroke and arrows) when it is selected or unselected.
    Property Type: Color
    
    Property Range: A non-null color
  - EDGE_LABEL_COLOR
```
public static final VisualProperty<Paint> EDGE_LABEL_COLOR
```
    TODO Documentation
    Property Type: Color
    
    Property Range: A non-null color
  - EDGE_LABEL
```
public static final VisualProperty<String> EDGE_LABEL
```
    The text used for the edge label.
    Property Type: String
    
    Property Range: Any string
  - EDGE_WIDTH
```
public static final VisualProperty<Double> EDGE_WIDTH
```
    The width of the edge line.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - EDGE_VISIBLE
```
public static final VisualProperty<Boolean> EDGE_VISIBLE
```
    Hides the edge if set to false. By default, this value is set to true.
    Property Type: Boolean
    
    Property Range: true or false
  - EDGE_SELECTED
```
public static final VisualProperty<Boolean> EDGE_SELECTED
```
    TODO Documentation
    Property Type: Boolean
    
    Property Range: true or false
  - EDGE_LINE_TYPE
```
public static final VisualProperty<LineType> EDGE_LINE_TYPE
```
    The type of stoke used to render the line (solid, dashed, etc.)
    Additional Details: LineTypeVisualProperty
  - EDGE_TOOLTIP
```
public static final VisualProperty<String> EDGE_TOOLTIP
```
    The text of the tooltip that appears when a mouse hovers over the edge.
    Property Type: String
    
    Property Range: Any string
  - EDGE_LABEL_FONT_FACE
```
public static final VisualProperty<Font> EDGE_LABEL_FONT_FACE
```
    The font used for the edge label.
    Property Type: Font
    
    Property Range: Any font available in the local graphics environment
  - EDGE_LABEL_FONT_SIZE
```
public static final VisualProperty<Integer> EDGE_LABEL_FONT_SIZE
```
    The size of the font used for the edge label.
    Property Type: Integer
    
    Property Range: 1 <= value <= Integer.MAX_VALUE
  - EDGE_LABEL_TRANSPARENCY
```
public static final VisualProperty<Integer> EDGE_LABEL_TRANSPARENCY
```
    The opacity of the color of the edge label. Zero means totally transparent, and 255 means totally opaque.
    Property Type: Integer
    
    Property Range: 0 <= value <= 255
  - EDGE_SELECTED_PAINT
```
public static final VisualProperty<Paint> EDGE_SELECTED_PAINT
```
    The color of the whole edge (stroke and arrows) when selected.
    Property Type: Color
    
    Property Range: A non-null color
  - EDGE_UNSELECTED_PAINT
```
public static final VisualProperty<Paint> EDGE_UNSELECTED_PAINT
```
    The color of the whole edge (stroke and arrows) when it is not selected.
    Property Type: Color
    
    Property Range: A non-null color
  - EDGE_STROKE_SELECTED_PAINT
```
public static final VisualProperty<Paint> EDGE_STROKE_SELECTED_PAINT
```
    The color of the edge line when selected.
    Property Type: Color
    
    Property Range: A non-null color
  - EDGE_STROKE_UNSELECTED_PAINT
```
public static final VisualProperty<Paint> EDGE_STROKE_UNSELECTED_PAINT
```
    The color of the edge line.
    Property Type: Color
    
    Property Range: A non-null color
  - EDGE_TRANSPARENCY
```
public static final VisualProperty<Integer> EDGE_TRANSPARENCY
```
    The opacity of the of the edge. Zero means totally transparent, and 255 means totally opaque.
    Property Type: Integer
    
    Property Range: 0 <= value <= 255
  - EDGE_SOURCE_ARROW_SHAPE
```
public static final VisualProperty<ArrowShape> EDGE_SOURCE_ARROW_SHAPE
```
    The shape of the arrow on the source node end of the edge.
    Additional Details: ArrowShapeVisualProperty
  - EDGE_TARGET_ARROW_SHAPE
```
public static final VisualProperty<ArrowShape> EDGE_TARGET_ARROW_SHAPE
```
    The shape of the arrow on the target node end of the edge.
    Additional Details: ArrowShapeVisualProperty
  - EDGE_SOURCE_ARROW_SIZE
```
public static final VisualProperty<Double> EDGE_SOURCE_ARROW_SIZE
```
    TODO Documentation
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - EDGE_TARGET_ARROW_SIZE
```
public static final VisualProperty<Double> EDGE_TARGET_ARROW_SIZE
```
    TODO Documentation
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - EDGE_BEND
```
public static final EdgeBendVisualProperty EDGE_BEND
```
    If Edge Bend is defined, edges will be rendered as straight or curved lines. If this value is set to true, edges will be drawn as curved lines.
  - EDGE_LABEL_WIDTH
```
public static final VisualProperty<Double> EDGE_LABEL_WIDTH
```
    TODO Documentation
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NETWORK_SCALE_FACTOR
```
public static final VisualProperty<Double> NETWORK_SCALE_FACTOR
```
    The zoom level of the network view.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NETWORK_CENTER_X_LOCATION
```
public static final VisualProperty<Double> NETWORK_CENTER_X_LOCATION
```
    The X location of network view center.
    Property Type: Double
    
    Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY
  - NETWORK_CENTER_Y_LOCATION
```
public static final VisualProperty<Double> NETWORK_CENTER_Y_LOCATION
```
    The Y location of network view center.
    Property Type: Double
    
    Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY
  - NETWORK_SIZE
```
public static final VisualProperty<Double> NETWORK_SIZE
```
    The size (width and height) of the network view.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NETWORK_WIDTH
```
public static final VisualProperty<Double> NETWORK_WIDTH
```
    The width of the network view.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NETWORK_HEIGHT
```
public static final VisualProperty<Double> NETWORK_HEIGHT
```
    The height of the network view.
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NETWORK_TITLE
```
public static final VisualProperty<String> NETWORK_TITLE
```
    The title of the network view.
    Property Type: String
    
    Property Range: Any string
  - NETWORK_BACKGROUND_PAINT
```
public static final VisualProperty<Paint> NETWORK_BACKGROUND_PAINT
```
    The background color of the network view.
    Property Type: Color
    
    Property Range: A non-null color
  - NODE_Z_LOCATION
```
public static final VisualProperty<Double> NODE_Z_LOCATION
```
    Z location of the node. Default value of this will be ignored. The value will be used only when mapping function is defined.
    Property Type: Double
    
    Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY
  - NODE_DEPTH
```
public static final VisualProperty<Double> NODE_DEPTH
```
    TODO Documentation
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
  - NETWORK_CENTER_Z_LOCATION
```
public static final VisualProperty<Double> NETWORK_CENTER_Z_LOCATION
```
    TODO Documentation
    Property Type: Double
    
    Property Range: Double.NEGATIVE_INFINITY <= value <= Double.POSITIVE_INFINITY
  - NETWORK_DEPTH
```
public static final VisualProperty<Double> NETWORK_DEPTH
```
    TODO Documentation
    Property Type: Double
    
    Property Range: 0 < value <= Double.POSITIVE_INFINITY
- Constructor Detail
  - BasicVisualLexicon
```
public BasicVisualLexicon(VisualProperty<NullDataType> rootVisualProperty)
```
    Constructor for VisualLexicon. The parameters are required for all lexicons.
    
    Parameters:
    
    rootVisualProperty - Root of the visual property tree.
- Method Detail
  - addBendFactory
```
public final void addBendFactory(BendFactory bendFactory,
                                 Map<?,?> props)
```
  - getAllVisualProperties
```
public final Set<VisualProperty<?>> getAllVisualProperties()
```
    Description copied from interface: VisualLexicon
    
    Returns the Set of VisualPropertys supported by this Renderer.
    
    Specified by:
    
    getAllVisualProperties in interface VisualLexicon
    
    Returns:
    
    Set of all visual properties
  - getAllDescendants
```
public final Collection<VisualProperty<?>> getAllDescendants(VisualProperty<?> prop)
```
    Description copied from interface: VisualLexicon
    
    Get collection of visual properties for a given object type (node/edge/network).
    
    Specified by:
    
    getAllDescendants in interface VisualLexicon
    
    Parameters:
    
    prop - any visual property
    
    Returns:
    
    Collection of visual properties for the type.
  - getRootVisualProperty
```
public final VisualProperty<NullDataType> getRootVisualProperty()
```
    Description copied from interface: VisualLexicon
    
    Get root of this tree. To traverse this tree, use this node as the entry point.
    
    Specified by:
    
    getRootVisualProperty in interface VisualLexicon
    
    Returns:
    
    root node.
  - addVisualProperty
```
protected final void addVisualProperty(VisualProperty<?> vp,
                                       VisualProperty<?> parent)
```
    Insert a VisualProperty to the tree.
    
    Parameters:
    
    vp - the VisualProperty to insert in the tree.
    
    parent - the parent of the VisualProperty to insert.
  - getVisualLexiconNode
```
public final VisualLexiconNode getVisualLexiconNode(VisualProperty<?> vp)
```
    Description copied from interface: VisualLexicon
    
    Get a tree node in for the given VisualProperty.
    
    Specified by:
    
    getVisualLexiconNode in interface VisualLexicon
    
    Parameters:
    
    vp - target VisualProperty in this lexicon.
    
    Returns:
    
    tree node for the VisualProperty in this lexicon.
  - lookup
```
public final VisualProperty<?> lookup(Class<?> type,
                                      String id)
```
    Description copied from interface: VisualLexicon
    
    Returns the appropriate visual property for the descriptive string. The string is generally expected to be descriptive identifier from a file format (e.g. XGMML, GML) that can be mapped to a VisualProperty by the implementer of the VisualLexicon. This method will return null if no match is found.
    
    Specified by:
    
    lookup in interface VisualLexicon
    
    Parameters:
    
    type - The type of the visual property sought, which should (in general) be CyNode.class, CyEdge.class, or CyNetwork.class.
    
    id - A string identifying a particular visual property.
    
    Returns:
    
    A VisualProperty identified by the input string or null if no match is found.
  - isSupported
```
public boolean isSupported(VisualProperty<?> vp)
```
    Description copied from interface: VisualLexicon
    
    Test the given Visual Property is supported in this Lexicon.
    
    Specified by:
    
    isSupported in interface VisualLexicon
    
    Parameters:
    
    vp - visual property to be tested.
    
    Returns:
    
    true if this lexicon supports the given vp.
  - getSupportedValueRange
```
public <T> Set<T> getSupportedValueRange(VisualProperty<T> vp)
```
    Description copied from interface: VisualLexicon
    
    Returns a filtered value range for a VisualProperty that uses a DiscreteRange. VisualLexicons may override this method to remove or add values to a DiscreteRange for a built-in VisualProperty from BasicVisualLexicon.
    
    Specified by:
    
    getSupportedValueRange in interface VisualLexicon
    
    Parameters:
    
    vp - VisualProperty where vp.getRange().isDiscrete() == true
  - addIdentifierMapping
```
protected final void addIdentifierMapping(Class<?> type,
                                          String id,
                                          VisualProperty<?> vp)
```
    Parameters:
    
    type -
    
    id -
    
    vp -

Class BasicVisualLexicon

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rootVisualProperty

MIN_COLOR

MAX_COLOR

PAINT_RANGE

STRING_SET

ARBITRARY_STRING_RANGE

ARBITRARY_DOUBLE_RANGE

NONE_ZERO_POSITIVE_DOUBLE_RANGE

NETWORK

NODE

EDGE

NODE_PAINT

NODE_FILL_COLOR

NODE_LABEL_COLOR

NODE_LABEL

NODE_X_LOCATION

NODE_Y_LOCATION

NODE_SIZE

NODE_WIDTH

NODE_HEIGHT

NODE_VISIBLE

NODE_SELECTED

NODE_NESTED_NETWORK_IMAGE_VISIBLE

NODE_LABEL_WIDTH

NODE_SELECTED_PAINT

NODE_BORDER_PAINT

NODE_BORDER_WIDTH

NODE_TOOLTIP

NODE_LABEL_FONT_FACE

NODE_LABEL_FONT_SIZE

NODE_TRANSPARENCY

NODE_OPACITY

NODE_BORDER_TRANSPARENCY

NODE_LABEL_TRANSPARENCY

NODE_SHAPE

NODE_BORDER_LINE_TYPE

EDGE_PAINT

EDGE_LABEL_COLOR

EDGE_LABEL

EDGE_WIDTH

EDGE_VISIBLE

EDGE_SELECTED

EDGE_LINE_TYPE

EDGE_TOOLTIP

EDGE_LABEL_FONT_FACE

EDGE_LABEL_FONT_SIZE

EDGE_LABEL_TRANSPARENCY

EDGE_SELECTED_PAINT

EDGE_UNSELECTED_PAINT

EDGE_STROKE_SELECTED_PAINT

EDGE_STROKE_UNSELECTED_PAINT

EDGE_TRANSPARENCY

EDGE_SOURCE_ARROW_SHAPE

EDGE_TARGET_ARROW_SHAPE

EDGE_SOURCE_ARROW_SIZE

EDGE_TARGET_ARROW_SIZE

EDGE_BEND

EDGE_LABEL_WIDTH

NETWORK_SCALE_FACTOR

NETWORK_CENTER_X_LOCATION

NETWORK_CENTER_Y_LOCATION

NETWORK_SIZE

NETWORK_WIDTH

NETWORK_HEIGHT

NETWORK_TITLE

NETWORK_BACKGROUND_PAINT

NODE_Z_LOCATION

NODE_DEPTH

NETWORK_CENTER_Z_LOCATION

NETWORK_DEPTH

Constructor Detail

BasicVisualLexicon

Method Detail

addBendFactory