org.eclipse.birt.chart.model.attribute
Enum TriggerFlow

java.lang.Object
  extended by java.lang.Enum<TriggerFlow>
      extended by org.eclipse.birt.chart.model.attribute.TriggerFlow
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TriggerFlow>, org.eclipse.emf.common.util.Enumerator

public enum TriggerFlow
extends java.lang.Enum<TriggerFlow>
implements org.eclipse.emf.common.util.Enumerator

A representation of the literals of the enumeration 'Trigger Flow', and utility methods for working with them. The TriggerFlow defines whether it reacts to the capturing or bubbling sequence Capture: the trigger�s action will be triggered in the capturing phase Bubble (default): the trigger�s action will be triggered in the bubbling phase BubbleAndStop: the trigger�s action will be triggered in the bubbling phase, and will stop the bubbling flow.

See Also:
AttributePackage.getTriggerFlow()

Enum Constant Summary
BUBBLE_AND_STOP_LITERAL
          The 'Bubble And Stop' literal object.
BUBBLE_LITERAL
          The 'Bubble' literal object.
CAPTURE_LITERAL
          The 'Capture' literal object.
 
Field Summary
static int BUBBLE
          The 'Bubble' literal value.
static int BUBBLE_AND_STOP
          The 'Bubble And Stop' literal value.
static int CAPTURE
          The 'Capture' literal value.
static java.util.List<TriggerFlow> VALUES
          A public read-only list of all the 'Trigger Flow' enumerators.
 
Method Summary
static TriggerFlow get(int value)
          Returns the 'Trigger Flow' literal with the specified integer value.
static TriggerFlow get(java.lang.String literal)
          Returns the 'Trigger Flow' literal with the specified literal value.
static TriggerFlow getByName(java.lang.String name)
          Returns the 'Trigger Flow' literal with the specified name.
 java.lang.String getLiteral()
           
 java.lang.String getName()
           
 int getValue()
           
 java.lang.String toString()
          Returns the literal value of the enumerator, which is its string representation.
static TriggerFlow valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static TriggerFlow[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CAPTURE_LITERAL

public static final TriggerFlow CAPTURE_LITERAL
The 'Capture' literal object.

See Also:
CAPTURE

BUBBLE_LITERAL

public static final TriggerFlow BUBBLE_LITERAL
The 'Bubble' literal object.

See Also:
BUBBLE

BUBBLE_AND_STOP_LITERAL

public static final TriggerFlow BUBBLE_AND_STOP_LITERAL
The 'Bubble And Stop' literal object.

See Also:
BUBBLE_AND_STOP
Field Detail

CAPTURE

public static final int CAPTURE
The 'Capture' literal value.

If the meaning of 'Capture' literal object isn't clear, there really should be more of a description here...

See Also:
CAPTURE_LITERAL, Constant Field Values

BUBBLE

public static final int BUBBLE
The 'Bubble' literal value.

If the meaning of 'Bubble' literal object isn't clear, there really should be more of a description here...

See Also:
BUBBLE_LITERAL, Constant Field Values

BUBBLE_AND_STOP

public static final int BUBBLE_AND_STOP
The 'Bubble And Stop' literal value.

If the meaning of 'Bubble And Stop' literal object isn't clear, there really should be more of a description here...

See Also:
BUBBLE_AND_STOP_LITERAL, Constant Field Values

VALUES

public static final java.util.List<TriggerFlow> VALUES
A public read-only list of all the 'Trigger Flow' enumerators.

Method Detail

values

public static final TriggerFlow[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(TriggerFlow c : TriggerFlow.values())
        System.out.println(c);

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

valueOf

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

get

public static TriggerFlow get(java.lang.String literal)
Returns the 'Trigger Flow' literal with the specified literal value.


getByName

public static TriggerFlow getByName(java.lang.String name)
Returns the 'Trigger Flow' literal with the specified name.


get

public static TriggerFlow get(int value)
Returns the 'Trigger Flow' literal with the specified integer value.


getValue

public int getValue()

Specified by:
getValue in interface org.eclipse.emf.common.util.Enumerator

getName

public java.lang.String getName()

Specified by:
getName in interface org.eclipse.emf.common.util.Enumerator

getLiteral

public java.lang.String getLiteral()

Specified by:
getLiteral in interface org.eclipse.emf.common.util.Enumerator

toString

public java.lang.String toString()
Returns the literal value of the enumerator, which is its string representation.

Overrides:
toString in class java.lang.Enum<TriggerFlow>


Copyright © 2005-2008 Actuate Corp. All rights reserved.