cytoscape.visual
Enum VisualPropertyType

java.lang.Object
  java.lang.Enum<VisualPropertyType>
      cytoscape.visual.VisualPropertyType

All Implemented Interfaces:

Serializable, Comparable<VisualPropertyType>

public enum VisualPropertyType
extends Enum<VisualPropertyType>

Enum for calculator types.
This will replace public constants defined in VizMapperUI class.
This Enum defines visual attributes used in Cytoscape.

Since:

Cytoscape 2.5

Version:

0.5

Author:

kono

Enum Constant Summary

EDGE_COLOR

EDGE_FONT_FACE

EDGE_FONT_SIZE

EDGE_LABEL

EDGE_LABEL_COLOR

EDGE_LABEL_OPACITY

EDGE_LABEL_POSITION

EDGE_LINE_STYLE

EDGE_LINE_WIDTH

EDGE_LINETYPE

EDGE_OPACITY

EDGE_SRCARROW

EDGE_SRCARROW_COLOR

EDGE_SRCARROW_OPACITY

EDGE_SRCARROW_SHAPE

EDGE_TGTARROW

EDGE_TGTARROW_COLOR

EDGE_TGTARROW_OPACITY

EDGE_TGTARROW_SHAPE

EDGE_TOOLTIP

NODE_BORDER_COLOR

NODE_BORDER_OPACITY

NODE_FILL_COLOR

NODE_FONT_FACE

NODE_FONT_SIZE

NODE_HEIGHT

NODE_LABEL

NODE_LABEL_COLOR

NODE_LABEL_OPACITY

NODE_LABEL_POSITION

NODE_LINE_STYLE

NODE_LINE_WIDTH

NODE_LINETYPE

NODE_OPACITY

NODE_SHAPE

NODE_SIZE

NODE_TOOLTIP

NODE_WIDTH

Method Summary

String	getBypassAttrName() DOCUMENT ME!
Calculator	getCurrentCalculator(VisualStyle style) Gets the current calculator for the visual attribute for this type and the specified visual style.
Class	getDataType() DOCUMENT ME!
Object	getDefault(VisualStyle style) Gets the current default value for this type in the specified visual style.
String	getDefaultPropertyKey(String baseKey) DOCUMENT ME!
String	getDefaultPropertyLabel() DOCUMENT ME!
static List<VisualPropertyType>	getEdgeVisualPropertyList() DOCUMENT ME!
String	getName() DOCUMENT ME!
static List<VisualPropertyType>	getNodeVisualPropertyList() DOCUMENT ME!
String	getPropertyLabel() Returns string used as property label in VS prop file.
byte	getType() Deprecated. Will be removed 5/2008
ValueParser	getValueParser()
static VisualPropertyType	getVisualPorpertyType(byte type) Deprecated. Will be removed 5/2008.
VisualProperty	getVisualProperty() Returns the VisualProperty object associated with this enum.
boolean	isAllowed() Indicates whether or not we should be using this property for normal operations.
boolean	isNodeProp() Check this visual property is for node or not.
void	setCurrentCalculator(VisualStyle style, Calculator c) Sets the current calculator for the visual attribute for this type and the specified visual style.
void	setDefault(VisualStyle style, Object c) Sets the default value for the visual attribute for this type in the specified visual style.
Object	showContinuousEditor() Display continuous value editor.
Object	showDiscreteEditor() Display discrete value editor for this visual property.
static VisualPropertyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static VisualPropertyType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NODE_FILL_COLOR

public static final VisualPropertyType NODE_FILL_COLOR

NODE_BORDER_COLOR

public static final VisualPropertyType NODE_BORDER_COLOR

NODE_LINETYPE

public static final VisualPropertyType NODE_LINETYPE

NODE_SHAPE

public static final VisualPropertyType NODE_SHAPE

NODE_SIZE

public static final VisualPropertyType NODE_SIZE

NODE_WIDTH

public static final VisualPropertyType NODE_WIDTH

NODE_HEIGHT

public static final VisualPropertyType NODE_HEIGHT

NODE_LABEL

public static final VisualPropertyType NODE_LABEL

NODE_FONT_FACE

public static final VisualPropertyType NODE_FONT_FACE

NODE_FONT_SIZE

public static final VisualPropertyType NODE_FONT_SIZE

NODE_LABEL_COLOR

public static final VisualPropertyType NODE_LABEL_COLOR

NODE_TOOLTIP

public static final VisualPropertyType NODE_TOOLTIP

NODE_LABEL_POSITION

public static final VisualPropertyType NODE_LABEL_POSITION

EDGE_COLOR

public static final VisualPropertyType EDGE_COLOR

EDGE_LINETYPE

public static final VisualPropertyType EDGE_LINETYPE

EDGE_SRCARROW

public static final VisualPropertyType EDGE_SRCARROW

EDGE_TGTARROW

public static final VisualPropertyType EDGE_TGTARROW

EDGE_LABEL

public static final VisualPropertyType EDGE_LABEL

EDGE_FONT_FACE

public static final VisualPropertyType EDGE_FONT_FACE

EDGE_FONT_SIZE

public static final VisualPropertyType EDGE_FONT_SIZE

EDGE_LABEL_COLOR

public static final VisualPropertyType EDGE_LABEL_COLOR

EDGE_TOOLTIP

public static final VisualPropertyType EDGE_TOOLTIP

NODE_LINE_WIDTH

public static final VisualPropertyType NODE_LINE_WIDTH

EDGE_LINE_WIDTH

public static final VisualPropertyType EDGE_LINE_WIDTH

NODE_LINE_STYLE

public static final VisualPropertyType NODE_LINE_STYLE

EDGE_LINE_STYLE

public static final VisualPropertyType EDGE_LINE_STYLE

EDGE_SRCARROW_SHAPE

public static final VisualPropertyType EDGE_SRCARROW_SHAPE

EDGE_TGTARROW_SHAPE

public static final VisualPropertyType EDGE_TGTARROW_SHAPE

EDGE_SRCARROW_COLOR

public static final VisualPropertyType EDGE_SRCARROW_COLOR

EDGE_TGTARROW_COLOR

public static final VisualPropertyType EDGE_TGTARROW_COLOR

NODE_OPACITY

public static final VisualPropertyType NODE_OPACITY

EDGE_OPACITY

public static final VisualPropertyType EDGE_OPACITY

NODE_LABEL_OPACITY

public static final VisualPropertyType NODE_LABEL_OPACITY

EDGE_LABEL_OPACITY

public static final VisualPropertyType EDGE_LABEL_OPACITY

NODE_BORDER_OPACITY

public static final VisualPropertyType NODE_BORDER_OPACITY

EDGE_SRCARROW_OPACITY

public static final VisualPropertyType EDGE_SRCARROW_OPACITY

EDGE_TGTARROW_OPACITY

public static final VisualPropertyType EDGE_TGTARROW_OPACITY

EDGE_LABEL_POSITION

public static final VisualPropertyType EDGE_LABEL_POSITION

Method Detail

values

public static final VisualPropertyType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(VisualPropertyType c : VisualPropertyType.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static VisualPropertyType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

getName

public String getName()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getPropertyLabel

public String getPropertyLabel()

Returns string used as property label in VS prop file.

Returns:

getBypassAttrName

public String getBypassAttrName()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getDefaultPropertyLabel

public String getDefaultPropertyLabel()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getDefaultPropertyKey

public String getDefaultPropertyKey(String baseKey)

DOCUMENT ME!

Parameters:

baseKey - DOCUMENT ME!

Returns:

DOCUMENT ME!

getType

@Deprecated
public byte getType()

Deprecated. Will be removed 5/2008

Return position in thie enum as byte.
Will be used as type. DO NOT USE THIS. This is only for backward compatibility.
Replace your "byte" with is emum!

Returns:

byte type

getVisualPorpertyType

@Deprecated
public static VisualPropertyType getVisualPorpertyType(byte type)

Deprecated. Will be removed 5/2008.

DO NOT USE THIS. This is only for backward compatibility.

Parameters:

type -

Returns:

getDataType

public Class getDataType()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isNodeProp

public boolean isNodeProp()

Check this visual property is for node or not.

Returns:

true if vp is for node.

isAllowed

public boolean isAllowed()

Indicates whether or not we should be using this property for normal operations. If this is false, that means the property either hasn't been implemented or has been deprecated. This is primarily used to build lists of properties that we can display to users.

getNodeVisualPropertyList

public static List<VisualPropertyType> getNodeVisualPropertyList()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getEdgeVisualPropertyList

public static List<VisualPropertyType> getEdgeVisualPropertyList()

DOCUMENT ME!

Returns:

DOCUMENT ME!

showDiscreteEditor

public Object showDiscreteEditor()
                          throws Exception

Display discrete value editor for this visual property.

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

showContinuousEditor

public Object showContinuousEditor()
                            throws Exception

Display continuous value editor.

Continuous editor always update mapping automatically, so there is no return value.

Throws:

Exception - DOCUMENT ME!

getVisualProperty

public VisualProperty getVisualProperty()

Returns the VisualProperty object associated with this enum.

getDefault

public Object getDefault(VisualStyle style)

Gets the current default value for this type in the specified visual style. Returns null if the style is null.

Parameters:

style - The visual style we want to get the default for.

Returns:

the default object for this type and the specified style.

setDefault

public void setDefault(VisualStyle style,
                       Object c)

Sets the default value for the visual attribute for this type in the specified visual style. No-op if either arg is null.

Parameters:

style - The visual style to be set.

c - The new default value.

getCurrentCalculator

public Calculator getCurrentCalculator(VisualStyle style)

Gets the current calculator for the visual attribute for this type and the specified visual style. This may be null if no calculator is currently specified. Returns null if the style is null.

Parameters:

style - The style we're getting the calculator for.

Returns:

the current calculator for this style and type

setCurrentCalculator

public void setCurrentCalculator(VisualStyle style,
                                 Calculator c)

Sets the current calculator for the visual attribute for this type and the specified visual style. If the new calculator is null, then the calculator for this type will be removed. This method does nothing if the first argument specifying the visual style is null.

Parameters:

style - The style to set the calculator for.

c - The calculator to set.

getValueParser

public ValueParser getValueParser()