com.smartgwt.client.types
Enum KnobType

java.lang.Object
  extended by java.lang.Enum<KnobType>
      extended by com.smartgwt.client.types.KnobType
All Implemented Interfaces:
ValueEnum, java.io.Serializable, java.lang.Comparable<KnobType>

public enum KnobType
extends java.lang.Enum<KnobType>
implements ValueEnum

Entries for the knobs array. Each specified knobType will enable some UI allowing the user to manipulate the DrawItem directly.

NOTE: Not all knob types are supported by each DrawItem type. Refer to the DrawItem type's knobs attribute documentation for a list of the supported knob types.


Enum Constant Summary
CONTROLPOINT1
          Display a draggable control knob along with a DrawLine indicating the angle between controlPoint1 and the startPoint.
CONTROLPOINT2
          Display a draggable control knob along with a DrawLine indicating the angle between controlPoint2 and the endPoint.
ENDPOINT
          Control knob to manipulate endPoint.
MOVE
          Display a control knob for moving the item around.
RESIZE
          Display up to 4 control knobs at the corners specified by resizeKnobPoints, allowing the user to drag-resize the item.
STARTPOINT
          Control knob to manipulate startPoint.
 
Method Summary
 java.lang.String getValue()
           
static KnobType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static KnobType[] 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

RESIZE

public static final KnobType RESIZE
Display up to 4 control knobs at the corners specified by resizeKnobPoints, allowing the user to drag-resize the item.


MOVE

public static final KnobType MOVE
Display a control knob for moving the item around. See also moveKnobPoint and moveKnobOffset


STARTPOINT

public static final KnobType STARTPOINT
Control knob to manipulate startPoint.


ENDPOINT

public static final KnobType ENDPOINT
Control knob to manipulate endPoint.


CONTROLPOINT1

public static final KnobType CONTROLPOINT1
Display a draggable control knob along with a DrawLine indicating the angle between controlPoint1 and the startPoint. Dragging the knob will adjust controlPoint1.


CONTROLPOINT2

public static final KnobType CONTROLPOINT2
Display a draggable control knob along with a DrawLine indicating the angle between controlPoint2 and the endPoint. Dragging the knob will adjust controlPoint2.

Method Detail

values

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

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

valueOf

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

getValue

public java.lang.String getValue()
Specified by:
getValue in interface ValueEnum