BrightSide Workbench Full Report + Source Code
org.zkoss.zk.ui.event.SelectEvent_506 Class Reference
Inheritance diagram for org.zkoss.zk.ui.event.SelectEvent_506:
Collaboration diagram for org.zkoss.zk.ui.event.SelectEvent_506:

Public Member Functions

 SelectEvent_506 (String name, Component target, Set selectedItems)
 
 SelectEvent_506 (String name, Component target, Set selectedItems, Component ref)
 
 SelectEvent_506 (String name, Component target, Set selectedItems, Component ref, int keys)
 
final Set getSelectedItems ()
 
Component getReference ()
 
final int getKeys ()
 

Static Public Member Functions

static final SelectEvent_506 getSelectEvent (AuRequest request)
 

Static Public Attributes

static final int ALT_KEY = MouseEvent.ALT_KEY
 
static final int CTRL_KEY = MouseEvent.CTRL_KEY
 
static final int SHIFT_KEY = MouseEvent.SHIFT_KEY
 

Detailed Description

Represents an event cause by user's the list selection is changed at the client.

Author
tomyeh

Definition at line 36 of file SelectEvent_506.java.

Constructor & Destructor Documentation

◆ SelectEvent_506() [1/3]

org.zkoss.zk.ui.event.SelectEvent_506.SelectEvent_506 ( String  name,
Component  target,
Set  selectedItems 
)

Constructs a selection event.

Parameters
selectedItemsa set of items that shall be selected.

Definition at line 79 of file SelectEvent_506.java.

79  {
80  this(name, target, selectedItems, null, 0);
81  }
Here is the caller graph for this function:

◆ SelectEvent_506() [2/3]

org.zkoss.zk.ui.event.SelectEvent_506.SelectEvent_506 ( String  name,
Component  target,
Set  selectedItems,
Component  ref 
)

Constructs a selection event.

Parameters
selectedItemsa set of items that shall be selected.

Definition at line 86 of file SelectEvent_506.java.

87  {
88  this(name, target, selectedItems, ref, 0);
89  }

◆ SelectEvent_506() [3/3]

org.zkoss.zk.ui.event.SelectEvent_506.SelectEvent_506 ( String  name,
Component  target,
Set  selectedItems,
Component  ref,
int  keys 
)

Constructs a selection event.

Parameters
selectedItemsa set of items that shall be selected.
keysa combination of CTRL_KEY, SHIFT_KEY and ALT_KEY.
Since
3.6.0

Definition at line 96 of file SelectEvent_506.java.

97  {
98  super(name, target);
99  _selectedItems = selectedItems != null ?
100  selectedItems: Collections.EMPTY_SET;
101  _ref = ref;
102  _keys = keys;
103  }

Member Function Documentation

◆ getKeys()

final int org.zkoss.zk.ui.event.SelectEvent_506.getKeys ( )

Returns what keys were pressed when the mouse is clicked, or 0 if none of them was pressed. It is a combination of CTRL_KEY, SHIFT_KEY and ALT_KEY.

Since
3.6.0

Definition at line 127 of file SelectEvent_506.java.

127  {
128  return _keys;
129  }

◆ getReference()

Component org.zkoss.zk.ui.event.SelectEvent_506.getReference ( )

Returns the reference item that is the component causing the onSelect event(select or deselect) to be fired.

It is null, if the onSelect event is not caused by listbox or tree or combobox. Note: if not multiple, the getReference is the same with the first item of getSelectedItems.

Since
3.0.2

Definition at line 117 of file SelectEvent_506.java.

117  {
118  return _ref;
119  }

◆ getSelectedItems()

final Set org.zkoss.zk.ui.event.SelectEvent_506.getSelectedItems ( )

Returns the selected items (never null).

Definition at line 106 of file SelectEvent_506.java.

106  {
107  return _selectedItems;
108  }

◆ getSelectEvent()

static final SelectEvent_506 org.zkoss.zk.ui.event.SelectEvent_506.getSelectEvent ( AuRequest  request)
static

Converts an AU request to a select event.

Since
5.0.0

Definition at line 57 of file SelectEvent_506.java.

57  {
58  final Map data = request.getData();
59  final Desktop desktop = request.getDesktop();
60  Object obj = data.get("items");
61  if(obj instanceof String) {
62  String tmp = (String) data.get("items");
63  JSONArray ja = new JSONArray();
64  ja.add(tmp.replaceAll("^\\[\"", "")
65  .replaceAll("\"\\]$", "")
66  .replaceAll("^\\[", "")
67  .replaceAll("\\]$", ""));
68  data.put("items", ja);
69  }
70  return new SelectEvent_506(request.getCommand(), request.getComponent(),
71  AuRequests.convertToItems(desktop, (List)data.get("items")),
72  desktop.getComponentByUuidIfAny((String)data.get("reference")),
73  AuRequests.parseKeys(data));
74  }
SelectEvent_506(String name, Component target, Set selectedItems)
Here is the call graph for this function:

Member Data Documentation

◆ ALT_KEY

final int org.zkoss.zk.ui.event.SelectEvent_506.ALT_KEY = MouseEvent.ALT_KEY
static

Indicates whether the Alt key is pressed. It might be returned as part of getKeys.

Definition at line 44 of file SelectEvent_506.java.

◆ CTRL_KEY

final int org.zkoss.zk.ui.event.SelectEvent_506.CTRL_KEY = MouseEvent.CTRL_KEY
static

Indicates whether the Ctrl key is pressed. It might be returned as part of getKeys.

Definition at line 48 of file SelectEvent_506.java.

◆ SHIFT_KEY

final int org.zkoss.zk.ui.event.SelectEvent_506.SHIFT_KEY = MouseEvent.SHIFT_KEY
static

Indicates whether the Shift key is pressed. It might be returned as part of getKeys.

Definition at line 52 of file SelectEvent_506.java.


The documentation for this class was generated from the following file: