cytoscape.visual
Enum NodeShape

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

All Implemented Interfaces:

Serializable, Comparable<NodeShape>

public enum NodeShape
extends Enum<NodeShape>

Since:

Cytoscape 2.5

Version:

0.7

Author:

kono

Enum Constant Summary

DIAMOND

ELLIPSE

HEXAGON

OCTAGON

PARALLELOGRAM

RECT

RECT_3D

ROUND_RECT

TRAPEZOID

TRAPEZOID_2

TRIANGLE

VEE

Method Summary

int	getGinyShape() Get GINY shape as integer.
static Map<Object,Icon>	getIconSet() DOCUMENT ME!
static NodeShape	getNodeShape(int ginyShape) Convert from Giny shape to Cytoscape NodeShape enum.
static String	getNodeShapeText(NodeShape shape) DOCUMENT ME!
Shape	getShape() Returns a Shape object for the NodeShape in question.
String	getShapeName() Get name of the shape.
boolean	isSupported() If the shape is supported by rendering engine, return true. Otherwise, return false.
static boolean	isValidShape(NodeShape type) DOCUMENT ME!
static NodeShape	parseNodeShapeText(String text) DOCUMENT ME!
static NodeShape	valueOf(String name) Returns the enum constant of this type with the specified name.
static NodeShape[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static String[]	valuesAsString() DOCUMENT ME!

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RECT

public static final NodeShape RECT

ROUND_RECT

public static final NodeShape ROUND_RECT

RECT_3D

public static final NodeShape RECT_3D

TRAPEZOID

public static final NodeShape TRAPEZOID

TRAPEZOID_2

public static final NodeShape TRAPEZOID_2

TRIANGLE

public static final NodeShape TRIANGLE

PARALLELOGRAM

public static final NodeShape PARALLELOGRAM

DIAMOND

public static final NodeShape DIAMOND

ELLIPSE

public static final NodeShape ELLIPSE

HEXAGON

public static final NodeShape HEXAGON

OCTAGON

public static final NodeShape OCTAGON

VEE

public static final NodeShape VEE

Method Detail

values

public static NodeShape[] values()

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

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

Returns:

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

valueOf

public static NodeShape 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

NullPointerException - if the argument is null

isSupported

public boolean isSupported()

If the shape is supported by rendering engine, return true.
Otherwise, return false.

Returns:

parseNodeShapeText

public static NodeShape parseNodeShapeText(String text)

DOCUMENT ME!

Parameters:

text - DOCUMENT ME!

Returns:

DOCUMENT ME!

valuesAsString

public static String[] valuesAsString()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getShapeName

public String getShapeName()

Get name of the shape.

Returns:

DOCUMENT ME!

isValidShape

public static boolean isValidShape(NodeShape type)

DOCUMENT ME!

Parameters:

type - DOCUMENT ME!

Returns:

DOCUMENT ME!

getNodeShapeText

public static String getNodeShapeText(NodeShape shape)

DOCUMENT ME!

Parameters:

shape - DOCUMENT ME!

Returns:

DOCUMENT ME!

getGinyShape

public int getGinyShape()

Get GINY shape as integer.

Returns:

Giny shape as integer.

getNodeShape

public static NodeShape getNodeShape(int ginyShape)

Convert from Giny shape to Cytoscape NodeShape enum.

Parameters:

ginyShape -

Returns:

getShape

public Shape getShape()

Returns a Shape object for the NodeShape in question.

getIconSet

public static Map<Object,Icon> getIconSet()

DOCUMENT ME!

Returns:

DOCUMENT ME!