PreviewProperty (PreviewAPI 0.9.1 API)

java.lang.Object
- org.gephi.preview.api.PreviewProperty

```
public class PreviewProperty
extends Object
```
Define a (key, value) pair property attached to a PreviewProperties instance.
Preview properties are created by renderers to let users configure how items should be rendered. Each property should have a unique name and a type. Users should use the static createProperty() methods to create instances.
Static default property names are defined in this class to help renderers to reuse external properties and have cleaner code.
Properties can be grouped by categories, which default are PreviewProperty.CATEGORY_NODES, PreviewProperty.CATEGORY_EDGES, PreviewProperty.CATEGORY_NODE_LABELS, PreviewProperty.CATEGORY_EDGE_LABELS and PreviewProperty.CATEGORY_EDGE_ARROWS.

Author:

Mathieu Bastian

See Also:
Renderer.getProperties()

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ARROW_SIZE` Arrow `Float` property defining the arrow size.
`static String`	`BACKGROUND_COLOR` General `Color` property of the background color
`(package private) String`	`category`
`static String`	`CATEGORY_EDGE_ARROWS` Edge arrow category
`static String`	`CATEGORY_EDGE_LABELS` Edge Label category
`static String`	`CATEGORY_EDGES` Edge category
`static String`	`CATEGORY_NODE_LABELS` Node Label category
`static String`	`CATEGORY_NODES` Node category
`(package private) String[]`	`dependencies`
`(package private) String`	`description`
`static String`	`DIRECTED` General `Boolean` property which indicates wheter the graph is directed
`(package private) String`	`displayName`
`static String`	`EDGE_COLOR` Edge `EdgeColor` property defining the edge color.
`static String`	`EDGE_CURVED` Edge `Boolean` property whether to draw curved edges.
`static String`	`EDGE_LABEL_COLOR` Edge Label `DependantOriginalColor` property defining the color label.
`static String`	`EDGE_LABEL_FONT` Edge Label `Font` property defining edge label's font.
`static String`	`EDGE_LABEL_MAX_CHAR` Edge Label `Integer` property defining the maximum number of characters.
`static String`	`EDGE_LABEL_OUTLINE_COLOR` Edge Label Outline `DependantColor` property defining the outline color.
`static String`	`EDGE_LABEL_OUTLINE_OPACITY` Edge Label Outline `Float` property between 0-100 which defines the opacity.
`static String`	`EDGE_LABEL_OUTLINE_SIZE` Edge Label Outline `Float` property defining the outline size.
`static String`	`EDGE_LABEL_SHORTEN` Edge Label `Boolean` property defining whether the label is shortened.
`static String`	`EDGE_OPACITY` Edge `Float` property between 0-100 which defines the opacity.
`static String`	`EDGE_RADIUS` Edge `Float` property defining an extra distance between the node and the edge.
`static String`	`EDGE_RESCALE_WEIGHT` Edge `Boolean` property defining whether edge's weight should be rescaled between fixed bounds.
`static String`	`EDGE_THICKNESS` Edge `Float` property for the edge's thickness
`static String`	`MARGIN` General `Float` property in percentage (0-100) describing the margin size.
`static String`	`MOVING` General `Boolean` property set as `true` when the user is panning the canvas.
`(package private) String`	`name`
`static String`	`NODE_BORDER_COLOR` Node `DependantColor` property which defines the border color.
`static String`	`NODE_BORDER_WIDTH` Node `Float` property defining the node border size.
`static String`	`NODE_LABEL_BOX_COLOR`
`static String`	`NODE_LABEL_BOX_OPACITY`
`static String`	`NODE_LABEL_COLOR` Node Label `DependantOriginalColor` property defining the color label.
`static String`	`NODE_LABEL_FONT` Node Label `Font` property defining node label's font.
`static String`	`NODE_LABEL_MAX_CHAR` Node Label `Integer` property defining the maximum number of characters.
`static String`	`NODE_LABEL_OUTLINE_COLOR` Node Label Outline `DependantColor` property defining the outline color.
`static String`	`NODE_LABEL_OUTLINE_OPACITY` Node Label Outline `Float` property between 0-100 which defines the opacity.
`static String`	`NODE_LABEL_OUTLINE_SIZE` Node Label Outline `Float` property defining the outline size.
`static String`	`NODE_LABEL_PROPORTIONAL_SIZE` Node Label `Boolean` property defining whether to use node's size in label size calculation.
`static String`	`NODE_LABEL_SHORTEN` Node Label `Boolean` property defining whether the label is shortened.
`static String`	`NODE_LABEL_SHOW_BOX`
`static String`	`NODE_OPACITY` Node `Float` property between 0-100 which defines the opacity.
`static String`	`SHOW_EDGE_LABELS` Edge Label `Boolean` property defining whether to show edge labels.
`static String`	`SHOW_EDGES` Edge `Boolean` property defining whether to show edges.
`static String`	`SHOW_NODE_LABELS` Node Label `Boolean` property defining whether to show node labels.
`(package private) Object`	`source`
`(package private) Class`	`type`
`(package private) Object`	`value`
`static String`	`VISIBILITY_RATIO` General `Float` property which indicates the ratio of the visible graph used in preview.

Constructor Summary

Constructors
Constructor and Description
`PreviewProperty(Object source, String name, Class type, String displayName, String description, String category)`
`PreviewProperty(Object source, String name, Class type, String displayName, String description, String category, String[] dependencies)`

Method Summary

Methods
Modifier and Type	Method and Description
`static PreviewProperty`	`createProperty(Object source, String name)` Create a new preview property.
`static PreviewProperty`	`createProperty(Object source, String name, Class type)` Create a new preview property.
`static PreviewProperty`	`createProperty(Object source, String name, Class type, String displayName, String description, String category)` Create a new preview property.
`static PreviewProperty`	`createProperty(Object source, String name, Class type, String displayName, String description, String category, String... dependantProperties)` Create a new preview property.
`String`	`getCategory()` Returns the category of this property or `null` if not set.
`String`	`getDescription()` Returns the description of this property or `null` if not set.
`String`	`getDisplayName()` Returns the display name of this property or `null` if not set.
`String`	`getName()` Returns the (unique) name of this property.
`Object`	`getSource()` Returns the source object of this property.
`Class`	`getType()` Returns the type of this property.
`<T> T`	`getValue()` Returns the property value.
`PreviewProperty`	`setValue(Object value)` Sets this property value and return it.

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

- Field Detail
  - DIRECTED
```
public static final String DIRECTED
```
    General Boolean property which indicates wheter the graph is directed
    
    See Also:
    Constant Field Values
  - BACKGROUND_COLOR
```
public static final String BACKGROUND_COLOR
```
    General Color property of the background color
    
    See Also:
    Constant Field Values
  - VISIBILITY_RATIO
```
public static final String VISIBILITY_RATIO
```
    General Float property which indicates the ratio of the visible graph used in preview. For instance if 0.5 only 50% of nodes items are built.
    
    See Also:
    Constant Field Values
  - MARGIN
```
public static final String MARGIN
```
    General Float property in percentage (0-100) describing the margin size. For instance if the value is 4 the size of the margin is 4% of the total graph width.
    
    See Also:
    Constant Field Values
  - NODE_BORDER_WIDTH
```
public static final String NODE_BORDER_WIDTH
```
    Node Float property defining the node border size.
    
    See Also:
    Constant Field Values
  - NODE_BORDER_COLOR
```
public static final String NODE_BORDER_COLOR
```
    Node DependantColor property which defines the border color. A dependant color value is either the node's color or a custom color.
    
    See Also:
    Constant Field Values
  - NODE_OPACITY
```
public static final String NODE_OPACITY
```
    Node Float property between 0-100 which defines the opacity. 100 means opaque.
    
    See Also:
    Constant Field Values
  - SHOW_EDGES
```
public static final String SHOW_EDGES
```
    Edge Boolean property defining whether to show edges.
    
    See Also:
    Constant Field Values
  - EDGE_THICKNESS
```
public static final String EDGE_THICKNESS
```
    Edge Float property for the edge's thickness
    
    See Also:
    Constant Field Values
  - EDGE_CURVED
```
public static final String EDGE_CURVED
```
    Edge Boolean property whether to draw curved edges. A false value means straight edges.
    
    See Also:
    Constant Field Values
  - EDGE_COLOR
```
public static final String EDGE_COLOR
```
    Edge EdgeColor property defining the edge color. It could be the source's color, the target's color, a mixed color, the edge's original color or a custom color.
    
    See Also:
    Constant Field Values
  - EDGE_OPACITY
```
public static final String EDGE_OPACITY
```
    Edge Float property between 0-100 which defines the opacity. 100 means opaque.
    
    See Also:
    Constant Field Values
  - EDGE_RESCALE_WEIGHT
```
public static final String EDGE_RESCALE_WEIGHT
```
    Edge Boolean property defining whether edge's weight should be rescaled between fixed bounds.
    
    See Also:
    Constant Field Values
  - EDGE_RADIUS
```
public static final String EDGE_RADIUS
```
    Edge Float property defining an extra distance between the node and the edge.
    
    See Also:
    Constant Field Values
  - ARROW_SIZE
```
public static final String ARROW_SIZE
```
    Arrow Float property defining the arrow size.
    
    See Also:
    Constant Field Values
  - SHOW_NODE_LABELS
```
public static final String SHOW_NODE_LABELS
```
    Node Label Boolean property defining whether to show node labels.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_FONT
```
public static final String NODE_LABEL_FONT
```
    Node Label Font property defining node label's font.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_PROPORTIONAL_SIZE
```
public static final String NODE_LABEL_PROPORTIONAL_SIZE
```
    Node Label Boolean property defining whether to use node's size in label size calculation.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_COLOR
```
public static final String NODE_LABEL_COLOR
```
    Node Label DependantOriginalColor property defining the color label. The color could either be the node's color, the label original color if it has any or a custom color.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_SHORTEN
```
public static final String NODE_LABEL_SHORTEN
```
    Node Label Boolean property defining whether the label is shortened.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_MAX_CHAR
```
public static final String NODE_LABEL_MAX_CHAR
```
    Node Label Integer property defining the maximum number of characters.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_OUTLINE_SIZE
```
public static final String NODE_LABEL_OUTLINE_SIZE
```
    Node Label Outline Float property defining the outline size.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_OUTLINE_OPACITY
```
public static final String NODE_LABEL_OUTLINE_OPACITY
```
    Node Label Outline Float property between 0-100 which defines the opacity. 100 means opaque.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_OUTLINE_COLOR
```
public static final String NODE_LABEL_OUTLINE_COLOR
```
    Node Label Outline DependantColor property defining the outline color. The color can be the node's color or a custom color.
    
    See Also:
    Constant Field Values
  - NODE_LABEL_SHOW_BOX
```
public static final String NODE_LABEL_SHOW_BOX
```
    See Also:
    Constant Field Values
  - NODE_LABEL_BOX_COLOR
```
public static final String NODE_LABEL_BOX_COLOR
```
    See Also:
    Constant Field Values
  - NODE_LABEL_BOX_OPACITY
```
public static final String NODE_LABEL_BOX_OPACITY
```
    See Also:
    Constant Field Values
  - SHOW_EDGE_LABELS
```
public static final String SHOW_EDGE_LABELS
```
    Edge Label Boolean property defining whether to show edge labels.
    
    See Also:
    Constant Field Values
  - EDGE_LABEL_FONT
```
public static final String EDGE_LABEL_FONT
```
    Edge Label Font property defining edge label's font.
    
    See Also:
    Constant Field Values
  - EDGE_LABEL_COLOR
```
public static final String EDGE_LABEL_COLOR
```
    Edge Label DependantOriginalColor property defining the color label. The color could either be the edge's color, the label original color if it has any or a custom color.
    
    See Also:
    Constant Field Values
  - EDGE_LABEL_SHORTEN
```
public static final String EDGE_LABEL_SHORTEN
```
    Edge Label Boolean property defining whether the label is shortened.
    
    See Also:
    Constant Field Values
  - EDGE_LABEL_MAX_CHAR
```
public static final String EDGE_LABEL_MAX_CHAR
```
    Edge Label Integer property defining the maximum number of characters.
    
    See Also:
    Constant Field Values
  - EDGE_LABEL_OUTLINE_SIZE
```
public static final String EDGE_LABEL_OUTLINE_SIZE
```
    Edge Label Outline Float property defining the outline size.
    
    See Also:
    Constant Field Values
  - EDGE_LABEL_OUTLINE_OPACITY
```
public static final String EDGE_LABEL_OUTLINE_OPACITY
```
    Edge Label Outline Float property between 0-100 which defines the opacity. 100 means opaque.
    
    See Also:
    Constant Field Values
  - EDGE_LABEL_OUTLINE_COLOR
```
public static final String EDGE_LABEL_OUTLINE_COLOR
```
    Edge Label Outline DependantColor property defining the outline color. The color can be the edge's color or a custom color.
    
    See Also:
    Constant Field Values
  - MOVING
```
public static final String MOVING
```
    General Boolean property set as true when the user is panning the canvas. Helps to conditionally hide elements while moving to speed things up.
    
    See Also:
    Constant Field Values
  - CATEGORY_NODES
```
public static final String CATEGORY_NODES
```
    Node category
  - CATEGORY_EDGES
```
public static final String CATEGORY_EDGES
```
    Edge category
  - CATEGORY_NODE_LABELS
```
public static final String CATEGORY_NODE_LABELS
```
    Node Label category
  - CATEGORY_EDGE_LABELS
```
public static final String CATEGORY_EDGE_LABELS
```
    Edge Label category
  - CATEGORY_EDGE_ARROWS
```
public static final String CATEGORY_EDGE_ARROWS
```
    Edge arrow category
  - name
```
final String name
```
  - displayName
```
final String displayName
```
  - description
```
final String description
```
  - source
```
final Object source
```
  - category
```
final String category
```
  - type
```
final Class type
```
  - value
```
Object value
```
  - dependencies
```
String[] dependencies
```
- Constructor Detail
  - PreviewProperty
```
PreviewProperty(Object source,
               String name,
               Class type,
               String displayName,
               String description,
               String category)
```
  - PreviewProperty
```
PreviewProperty(Object source,
               String name,
               Class type,
               String displayName,
               String description,
               String category,
               String[] dependencies)
```
- Method Detail
  - createProperty
```
public static PreviewProperty createProperty(Object source,
                             String name)
```
    Create a new preview property. The name should be unique.
    
    Parameters:
    source - the property source, for instance the renderer
    name - the property's name
    
    Returns:
    a new preview property
  - createProperty
```
public static PreviewProperty createProperty(Object source,
                             String name,
                             Class type)
```
    Create a new preview property. The name should be unique. If the type is different from basic types (Integer, Float, Double, String, Boolean or Color) make sure to implement a PropertyEditor and register it:
```
PropertyEditorManager.registerEditor(MyType.class, MyTypePropertyEditor.class);
```
    Parameters:
    source - the property source, for instance the renderer
    name - the property's name
    type - the property's value type
    
    Returns:
    a new preview property
  - createProperty
```
public static PreviewProperty createProperty(Object source,
                             String name,
                             Class type,
                             String displayName,
                             String description,
                             String category)
```
    Create a new preview property. The name should be unique. If the type is different from basic types (Integer, Float, Double, String, Boolean or Color) make sure to implement a PropertyEditor and register it:
```
PropertyEditorManager.registerEditor(MyType.class, MyTypePropertyEditor.class);
```
    The category can be one of the default categories:
    - PreviewProperty.CATEGORY_NODES
    - PreviewProperty.CATEGORY_EDGES
    - PreviewProperty.CATEGORY_NODE_LABELS
    - PreviewProperty.CATEGORY_EDGE_LABELS
    - PreviewProperty.CATEGORY_EDGE_ARROWS
    Parameters:
    source - the property source, for instance the renderer
    name - the property's name
    type - the property's value type
    displayName - the property's display name
    description - the property's description
    category - the property's category
    
    Returns:
    a new preview property
  - createProperty
```
public static PreviewProperty createProperty(Object source,
                             String name,
                             Class type,
                             String displayName,
                             String description,
                             String category,
                             String... dependantProperties)
```
    Create a new preview property. The name should be unique. If the type is different from basic types (Integer, Float, Double, String, Boolean or Color) make sure to implement a PropertyEditor and register it:
```
PropertyEditorManager.registerEditor(MyType.class, MyTypePropertyEditor.class);
```
    The category can be one of the default categories:
    - PreviewProperty.CATEGORY_NODES
    - PreviewProperty.CATEGORY_EDGES
    - PreviewProperty.CATEGORY_NODE_LABELS
    - PreviewProperty.CATEGORY_EDGE_LABELS
    - PreviewProperty.CATEGORY_EDGE_ARROWS
    The dependantProperties list is used to automatically disable the property if the dependant property is not selected. The dependant properties need to be Boolean type.
    Parameters:
    source - the property source, for instance the renderer
    name - the property's name
    type - the property's value type
    displayName - the property's display name
    description - the property's description
    category - the property's category
    dependantProperties - a list of boolean properties this property depend on
    
    Returns:
    a new preview property
  - getValue
```
public <T> T getValue()
```
    Returns the property value.
    
    Type Parameters:
    T - the return type
    
    Returns:
    the property value or null
  - setValue
```
public PreviewProperty setValue(Object value)
```
    Sets this property value and return it. The value can be null.
    
    Parameters:
    value - the value to be set
    
    Returns:
    this property instance
  - getName
```
public String getName()
```
    Returns the (unique) name of this property.
    
    Returns:
    the property's name
  - getType
```
public Class getType()
```
    Returns the type of this property.
    
    Returns:
    this property's type
  - getDisplayName
```
public String getDisplayName()
```
    Returns the display name of this property or null if not set.
    
    Returns:
    this property's display name or null
  - getDescription
```
public String getDescription()
```
    Returns the description of this property or null if not set.
    
    Returns:
    this property's description or null
  - getSource
```
public Object getSource()
```
    Returns the source object of this property.
    
    Returns:
    this property's source object
  - getCategory
```
public String getCategory()
```
    Returns the category of this property or null if not set.
    
    Returns:
    this property's category or null

Class PreviewProperty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIRECTED

BACKGROUND_COLOR

VISIBILITY_RATIO

MARGIN

NODE_BORDER_WIDTH

NODE_BORDER_COLOR

NODE_OPACITY

SHOW_EDGES

EDGE_THICKNESS

EDGE_CURVED

EDGE_COLOR

EDGE_OPACITY

EDGE_RESCALE_WEIGHT

EDGE_RADIUS

ARROW_SIZE

SHOW_NODE_LABELS

NODE_LABEL_FONT

NODE_LABEL_PROPORTIONAL_SIZE

NODE_LABEL_COLOR

NODE_LABEL_SHORTEN

NODE_LABEL_MAX_CHAR

NODE_LABEL_OUTLINE_SIZE

NODE_LABEL_OUTLINE_OPACITY

NODE_LABEL_OUTLINE_COLOR

NODE_LABEL_SHOW_BOX

NODE_LABEL_BOX_COLOR

NODE_LABEL_BOX_OPACITY

SHOW_EDGE_LABELS

EDGE_LABEL_FONT

EDGE_LABEL_COLOR

EDGE_LABEL_SHORTEN

EDGE_LABEL_MAX_CHAR

EDGE_LABEL_OUTLINE_SIZE

EDGE_LABEL_OUTLINE_OPACITY

EDGE_LABEL_OUTLINE_COLOR

MOVING

CATEGORY_NODES

CATEGORY_EDGES

CATEGORY_NODE_LABELS

CATEGORY_EDGE_LABELS

CATEGORY_EDGE_ARROWS

name

displayName

description

source

category

type

value

dependencies

Constructor Detail

PreviewProperty

PreviewProperty

Method Detail

createProperty

createProperty

createProperty

createProperty

getValue

setValue

getName

getType

getDisplayName

getDescription

getSource

getCategory