Cytoscape 2.8.0 API

cytoscape.visual
Enum ArrowShape

java.lang.Object
  extended by java.lang.Enum<ArrowShape>
      extended by cytoscape.visual.ArrowShape
All Implemented Interfaces:
Serializable, Comparable<ArrowShape>

public enum ArrowShape
extends Enum<ArrowShape>

Defines arrow shapes.
This replaces constants defined in Arrow.java.

Since:
Cytoscape 2.5
Author:
kono

Enum Constant Summary
ARROW
           
CIRCLE
           
DELTA
           
DIAMOND
           
HALF_ARROW_BOTTOM
           
HALF_ARROW_TOP
           
NONE
           
T
           
 
Method Summary
static ArrowShape getArrowShape(int ginyType)
          DOCUMENT ME!
 int getGinyArrow()
          Returns arrow type in GINY.
 String getGinyName()
          Returns name of arrow shape.
static Map<Object,Icon> getIconSet()
          DOCUMENT ME!
 String getName()
          DOCUMENT ME!
 String[] getPossibleGinyNames()
           
 int[] getPossibleGinyTypes()
           
 Shape getShape()
          DOCUMENT ME!
static ArrowShape parseArrowText(String text)
           
 boolean renderEdgeWithArrow()
          A method that helps render the arrow shape icon properly.
static ArrowShape valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ArrowShape[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
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

NONE

public static final ArrowShape NONE

DIAMOND

public static final ArrowShape DIAMOND

DELTA

public static final ArrowShape DELTA

ARROW

public static final ArrowShape ARROW

T

public static final ArrowShape T

CIRCLE

public static final ArrowShape CIRCLE

HALF_ARROW_TOP

public static final ArrowShape HALF_ARROW_TOP

HALF_ARROW_BOTTOM

public static final ArrowShape HALF_ARROW_BOTTOM
Method Detail

values

public static ArrowShape[] 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 (ArrowShape c : ArrowShape.values())
    System.out.println(c);

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

valueOf

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

getGinyArrow

public int getGinyArrow()
Returns arrow type in GINY.

Returns:

getGinyName

public String getGinyName()
Returns name of arrow shape.

Returns:

getName

public String getName()
DOCUMENT ME!

Returns:
DOCUMENT ME!

parseArrowText

public static ArrowShape parseArrowText(String text)
Parameters:
text -
Returns:

getPossibleGinyNames

public String[] getPossibleGinyNames()

getPossibleGinyTypes

public int[] getPossibleGinyTypes()

getArrowShape

public static ArrowShape getArrowShape(int ginyType)
DOCUMENT ME!

Parameters:
ginyType - DOCUMENT ME!
Returns:
DOCUMENT ME!

getShape

public Shape getShape()
DOCUMENT ME!

Returns:
DOCUMENT ME!

renderEdgeWithArrow

public boolean renderEdgeWithArrow()
A method that helps render the arrow shape icon properly.


getIconSet

public static Map<Object,Icon> getIconSet()
DOCUMENT ME!

Parameters:
size - DOCUMENT ME!
Returns:
DOCUMENT ME!

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.