Package org.zkoss.stateless.action.data
Class SelectData
- java.lang.Object
-
- org.zkoss.stateless.action.data.SelectData
-
- All Implemented Interfaces:
java.io.Serializable
,ActionData
public class SelectData extends java.lang.Object implements ActionData
Represents an action is triggered by a user to do a list selection being changed at the client.- Author:
- jumperchen
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SelectData(java.util.Map data)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getKeys()
Returns what keys were pressed when the mouse is clicked, or 0 if none of them was pressed.int
getReference()
Returns the reference item that is the component causing the onSelect event(select or deselect) to be fired.java.util.List<java.lang.Integer>
getReferencePath()
Returns the reference item path that is the component causing the onSelect event(select or deselect) to be fired, such asITree
Note: if not multiple, thegetReferencePath()
is the same with the first item ofgetSelectionPaths()
.java.util.List<java.lang.Integer>
getSelectedItems()
Returns the selected items (never null).java.util.List<java.util.List<java.lang.Integer>>
getSelectionPaths()
Returns the selected paths ofITree
(never null).
-
-
-
Field Detail
-
ALT_KEY
public static final int ALT_KEY
Indicates whether the Alt key is pressed. It might be returned as part ofgetKeys()
.- See Also:
- Constant Field Values
-
CTRL_KEY
public static final int CTRL_KEY
Indicates whether the Ctrl key is pressed. It might be returned as part ofgetKeys()
.- See Also:
- Constant Field Values
-
SHIFT_KEY
public static final int SHIFT_KEY
Indicates whether the Shift key is pressed. It might be returned as part ofgetKeys()
.- See Also:
- Constant Field Values
-
-
Method Detail
-
getSelectedItems
public java.util.List<java.lang.Integer> getSelectedItems()
Returns the selected items (never null).
-
getSelectionPaths
public java.util.List<java.util.List<java.lang.Integer>> getSelectionPaths()
Returns the selected paths ofITree
(never null).
-
getReference
public int getReference()
Returns the reference item that is the component causing the onSelect event(select or deselect) to be fired. Note: if not multiple, thegetReference()
is the same with the first item ofgetSelectedItems()
.
-
getReferencePath
public java.util.List<java.lang.Integer> getReferencePath()
Returns the reference item path that is the component causing the onSelect event(select or deselect) to be fired, such asITree
Note: if not multiple, thegetReferencePath()
is the same with the first item ofgetSelectionPaths()
.
-
getKeys
public final int getKeys()
-
-