Package com.microstrategy.web.blocks
Enum BlockListElement.ListAction
- java.lang.Object
-
- java.lang.Enum<BlockListElement.ListAction>
-
- com.microstrategy.web.blocks.BlockListElement.ListAction
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<BlockListElement.ListAction>
- Enclosing class:
- BlockListElement
public static enum BlockListElement.ListAction extends java.lang.Enum<BlockListElement.ListAction>
This enumeration defines the types of actions that may be associated with a BlockListElement when it is added to a BlockList. Valid values include:prepend
: Inserts the BlockListElement before the first element of the list.append
: Adds the BlockListElement to the end of the list.insert
: Inserts the BlockListElement before an existing element in the list.add
: Adds the BlockListElement after an existing element of the list.replace
: Adds the BlockListElement to the list at the index of an existing element of the list.delete
: Deletes the BlockListElement of an existing element in the list.
- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static BlockListElement.ListAction
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static BlockListElement.ListAction[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
prepend
public static final BlockListElement.ListAction prepend
-
append
public static final BlockListElement.ListAction append
-
insert
public static final BlockListElement.ListAction insert
-
add
public static final BlockListElement.ListAction add
-
replace
public static final BlockListElement.ListAction replace
-
delete
public static final BlockListElement.ListAction delete
-
-
Method Detail
-
values
public static BlockListElement.ListAction[] 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 (BlockListElement.ListAction c : BlockListElement.ListAction.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static BlockListElement.ListAction 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 namejava.lang.NullPointerException
- if the argument is null
-
-