net.sf.latexdraw.glib.models.interfaces
Enum IArrow.ArrowStyle

java.lang.Object
  extended by java.lang.Enum<IArrow.ArrowStyle>
      extended by net.sf.latexdraw.glib.models.interfaces.IArrow.ArrowStyle
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<IArrow.ArrowStyle>
Enclosing interface:
IArrow

public static enum IArrow.ArrowStyle
extends java.lang.Enum<IArrow.ArrowStyle>


Enum Constant Summary
BAR_END
           
BAR_IN
           
CIRCLE_END
           
CIRCLE_IN
           
DISK_END
           
DISK_IN
           
LEFT_ARROW
           
LEFT_DBLE_ARROW
           
LEFT_ROUND_BRACKET
           
LEFT_SQUARE_BRACKET
           
NONE
           
RIGHT_ARROW
           
RIGHT_DBLE_ARROW
           
RIGHT_ROUND_BRACKET
           
RIGHT_SQUARE_BRACKET
           
ROUND_END
           
ROUND_IN
           
SQUARE_END
           
 
Method Summary
static IArrow.ArrowStyle getArrowStyle(java.lang.String token)
           
abstract  IArrow.ArrowStyle getOppositeArrowStyle()
           
abstract  java.lang.String getPSTToken()
           
 boolean isArrow()
           
 boolean isBar()
           
 boolean isCircleDisk()
           
 boolean isRightStyle()
           
 boolean isRoundBracket()
           
 boolean isSameKind(IArrow.ArrowStyle style)
           
 boolean isSquareBracket()
           
 boolean needsLineReduction()
           
static IArrow.ArrowStyle valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static IArrow.ArrowStyle[] 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 IArrow.ArrowStyle NONE

LEFT_ARROW

public static final IArrow.ArrowStyle LEFT_ARROW

RIGHT_ARROW

public static final IArrow.ArrowStyle RIGHT_ARROW

RIGHT_DBLE_ARROW

public static final IArrow.ArrowStyle RIGHT_DBLE_ARROW

LEFT_DBLE_ARROW

public static final IArrow.ArrowStyle LEFT_DBLE_ARROW

BAR_END

public static final IArrow.ArrowStyle BAR_END

BAR_IN

public static final IArrow.ArrowStyle BAR_IN

LEFT_SQUARE_BRACKET

public static final IArrow.ArrowStyle LEFT_SQUARE_BRACKET

RIGHT_SQUARE_BRACKET

public static final IArrow.ArrowStyle RIGHT_SQUARE_BRACKET

LEFT_ROUND_BRACKET

public static final IArrow.ArrowStyle LEFT_ROUND_BRACKET

RIGHT_ROUND_BRACKET

public static final IArrow.ArrowStyle RIGHT_ROUND_BRACKET

CIRCLE_END

public static final IArrow.ArrowStyle CIRCLE_END

CIRCLE_IN

public static final IArrow.ArrowStyle CIRCLE_IN

DISK_END

public static final IArrow.ArrowStyle DISK_END

DISK_IN

public static final IArrow.ArrowStyle DISK_IN

ROUND_END

public static final IArrow.ArrowStyle ROUND_END

ROUND_IN

public static final IArrow.ArrowStyle ROUND_IN

SQUARE_END

public static final IArrow.ArrowStyle SQUARE_END
Method Detail

values

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

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

valueOf

public static IArrow.ArrowStyle valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getOppositeArrowStyle

public abstract IArrow.ArrowStyle getOppositeArrowStyle()
Returns:
The opposite arrow of the current one.
Since:
3.0

getPSTToken

public abstract java.lang.String getPSTToken()
Returns:
The PSTricks token of the arrow style.
Since:
3.0

isBar

public boolean isBar()
Returns:
True if the style is a bar.
Since:
3.0

isArrow

public boolean isArrow()
Returns:
True if the style is an arrow.
Since:
3.0

isRoundBracket

public boolean isRoundBracket()
Returns:
True if the style is a round bracket.
Since:
3.0

isSquareBracket

public boolean isSquareBracket()
Returns:
True if the style is a square bracket.
Since:
3.0

isCircleDisk

public boolean isCircleDisk()
Returns:
True if the style is a circle or a disk.
Since:
3.0

isRightStyle

public boolean isRightStyle()
Returns:
True if the style is a style for right arrows.
Since:
3.0

isSameKind

public boolean isSameKind(IArrow.ArrowStyle style)
Parameters:
style - The style to test.
Returns:
True if the given style and the calling style are of the same kind (e.g. both are circles or disks).
Since:
3.0

needsLineReduction

public boolean needsLineReduction()
Returns:
True if the current arrow style need its line to be reduced. For instance the arrow style requires its line to be smaller. The width of the arrow can be used in complement to reduce the line.
Since:
3.0

getArrowStyle

public static IArrow.ArrowStyle getArrowStyle(java.lang.String token)
Parameters:
token - The PST token or the name of the style to get (e.g. NONE.toString()).
Returns:
The arrow style corresponding to the given PST token or the style name (or null).
Since:
3.0