com.smartgwt.client.types
Enum KnobType

java.lang.Object
  java.lang.Enum<KnobType>
      com.smartgwt.client.types.KnobType

All Implemented Interfaces:

ValueEnum, Serializable, Comparable<KnobType>

public enum KnobType
extends Enum<KnobType>
implements ValueEnum

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

Enum Constant Summary

CONTROLPOINT1
Applies to DrawCurve only. Display a draggable control knob along with a drawLine indicating angle between controlPoint1 and startPoint for this drawCurve.

CONTROLPOINT2
Applies to DrawCurve only. Display a draggable control knob along with a drawLine indicating angle between controlPoint2 and endPoint for this drawCurve.

ENDPOINT
Applies to DrawLine, DrawCurve and DrawLinePath. Control knob to manipulate endPoint.

MOVE
Applies to DrawRect, DrawOval, DrawLine, and DrawLinePath. Display a control knob for moving the item around.

RESIZE
Applies to DrawRect and DrawOval. Display up to 4 control knobs at the corners specified by resizeKnobPoints, allowing the user to drag-resize the item.

STARTPOINT
Applies to DrawLine DrawCurve and DrawLinePath. Control knob to manipulate startPoint.

Method Summary

String	getValue()
static KnobType	valueOf(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

Applies to DrawRect and DrawOval. 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

Applies to DrawRect, DrawOval, DrawLine, and DrawLinePath. Display a control knob for moving the item around. See also moveKnobPoint and moveKnobOffset

STARTPOINT

public static final KnobType STARTPOINT

Applies to DrawLine DrawCurve and DrawLinePath. Control knob to manipulate startPoint.

ENDPOINT

public static final KnobType ENDPOINT

Applies to DrawLine, DrawCurve and DrawLinePath. Control knob to manipulate endPoint.

CONTROLPOINT1

public static final KnobType CONTROLPOINT1

Applies to DrawCurve only. Display a draggable control knob along with a drawLine indicating angle between controlPoint1 and startPoint for this drawCurve. Dragging the knob will adjust controlPoint1

CONTROLPOINT2

public static final KnobType CONTROLPOINT2

Applies to DrawCurve only. Display a draggable control knob along with a drawLine indicating angle between controlPoint2 and endPoint for this drawCurve. 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(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

getValue

public String getValue()

Specified by:

getValue in interface ValueEnum