Package org.adempiere.webui.editor

Class WChosenboxListEditor

java.lang.Object

org.adempiere.webui.editor.WEditor

org.adempiere.webui.editor.WChosenboxListEditor

All Implemented Interfaces:

PropertyChangeListener, EventListener, IInputValidator, ContextMenuListener, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>

public class WChosenboxListEditor
extends WEditor
implements ContextMenuListener

Default editor for DisplayType.ChosenMultipleSelectionList and DisplayType.ChosenMultipleSelectionTable.
Implemented with ChosenSearchBox component.

Author:

hengsin

Nested Class Summary

Nested classes/interfaces inherited from class org.adempiere.webui.editor.WEditor

WEditor.DynamicDisplayListener

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	LISTENER_EVENTS

Fields inherited from class org.adempiere.webui.editor.WEditor

component, gridField, gridTab, IDEMPIERE_EDITOR_ATTR, INIT_EDIT_EVENT, label, listeners, mandatory, MAX_DISPLAY_LENGTH, popupMenu, readOnly, tableEditor

Constructor Summary

Constructors

Constructor	Description
WChosenboxListEditor(String columnName, boolean mandatory, boolean isReadOnly, boolean isUpdateable, Lookup lookup)
WChosenboxListEditor(String columnName, boolean mandatory, boolean isReadOnly, boolean isUpdateable, Lookup lookup, boolean autocomplete)
WChosenboxListEditor(GridField gridField)
WChosenboxListEditor(GridField gridField, boolean tableEditor, IEditorConfiguration editorConfiguration)
WChosenboxListEditor(Lookup lookup, String label, String description, boolean mandatory, boolean readonly, boolean updateable)	Constructor for use if a grid field is unavailable
WChosenboxListEditor(Lookup lookup, String label, String description, boolean mandatory, boolean readonly, boolean updateable, boolean autocomplete)

Method Summary

Modifier and Type	Method	Description
protected void	actionRefresh()	Action for re-query menu. Refresh lookup
void	dynamicDisplay(Properties ctx)	Dynamic update of component state
ChosenSearchBox	getComponent()
String	getDisplay()
String[]	getEvents()
Lookup	getLookup()
Object	getValue()
boolean	isReadWrite()
void	onEvent(org.zkoss.zk.ui.event.Event event)
void	onMenu(ContextMenuEvent evt)	On context menu event
protected void	refreshLookup()	refresh lookup list
void	setReadWrite(boolean readWrite)
void	setValue(Object value)	Set editor value

Methods inherited from class org.adempiere.webui.editor.WEditor

addChangeLogMenu, addDynamicDisplayListener, addTextEditorMenu, addValueChangeListener, applyFieldStyles, applyLabelStyles, buildStyle, cleanColumnName, dynamicDisplay, fillHorizontal, fireValueChange, focusNext, getColumnName, getDescription, getDisplayComponent, getDisplayTextForGridView, getDisplayTextForGridView, getGridField, getLabel, getPopupMenu, getStyleEvaluatee, getValidInput, isComponentOfEditor, isMandatory, isMandatoryStyle, isNullOrEmpty, isProcessParameter, isSearchable, isShowPreference, isValid, isVisible, isZoomable, propertyChange, removeDynamicDisplayListener, removeValuechangeListener, setBackground, setBackground, setChangeEventWhenEditing, setColumnName, setComponent, setFieldStyle, setGridTab, setLabelStyle, setMandatory, setProcessParameter, setTableEditor, setValidInput, setVisible, setVisible, showMenu, toString, updateLabelStyle, updateStyle, updateStyle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

LISTENER_EVENTS

public static final String[] LISTENER_EVENTS

Constructor Details

WChosenboxListEditor

public WChosenboxListEditor(GridField gridField)

Parameters:

gridField -

WChosenboxListEditor

public WChosenboxListEditor(GridField gridField,
 boolean tableEditor,
 IEditorConfiguration editorConfiguration)

Parameters:

gridField -

tableEditor -

editorConfiguration -

WChosenboxListEditor

public WChosenboxListEditor(Lookup lookup,
 String label,
 String description,
 boolean mandatory,
 boolean readonly,
 boolean updateable)

Constructor for use if a grid field is unavailable

Parameters:

lookup - Store of selectable data

label - field label

description - description of component

mandatory - whether field is mandatory

readonly - whether or not the editor is read only

updateable - whether the editor contents can be changed

WChosenboxListEditor

public WChosenboxListEditor(Lookup lookup,
 String label,
 String description,
 boolean mandatory,
 boolean readonly,
 boolean updateable,
 boolean autocomplete)

Parameters:

lookup -

label -

description -

mandatory -

readonly -

updateable -

autocomplete -

WChosenboxListEditor

public WChosenboxListEditor(String columnName,
 boolean mandatory,
 boolean isReadOnly,
 boolean isUpdateable,
 Lookup lookup)

Parameters:

columnName -

mandatory -

isReadOnly -

isUpdateable -

lookup -

WChosenboxListEditor

public WChosenboxListEditor(String columnName,
 boolean mandatory,
 boolean isReadOnly,
 boolean isUpdateable,
 Lookup lookup,
 boolean autocomplete)

Parameters:

columnName -

mandatory -

isReadOnly -

isUpdateable -

lookup -

autocomplete -

Method Details

refreshLookup

protected void refreshLookup()

refresh lookup list

getDisplay

public String getDisplay()

Specified by:

getDisplay in class WEditor

Returns:

comma separated name list of selected records

getValue

public Object getValue()

Specified by:

getValue in class WEditor

Returns:

Object, current value of editor

setValue

public void setValue(Object value)

Description copied from class: WEditor

Set editor value

Specified by:

setValue in class WEditor

Parameters:

value - comma separated value list of selected records

getComponent

public ChosenSearchBox getComponent()

Overrides:

getComponent in class WEditor

Returns:

Component

isReadWrite

public boolean isReadWrite()

Specified by:

isReadWrite in class WEditor

Returns:

true if editable

setReadWrite

public void setReadWrite(boolean readWrite)

Specified by:

setReadWrite in class WEditor

onEvent

public void onEvent(org.zkoss.zk.ui.event.Event event)

Specified by:

onEvent in interface org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>

Parameters:

event -

getEvents

public String[] getEvents()

Overrides:

getEvents in class WEditor

Returns:

list of WEditor.component events that this editor will listen to

actionRefresh

protected void actionRefresh()

Action for re-query menu.
Refresh lookup

getLookup

public Lookup getLookup()

Returns:

Lookup

onMenu

public void onMenu(ContextMenuEvent evt)

Description copied from interface: ContextMenuListener

On context menu event

Specified by:

onMenu in interface ContextMenuListener

dynamicDisplay

public void dynamicDisplay(Properties ctx)

Description copied from class: WEditor

Dynamic update of component state

Overrides:

dynamicDisplay in class WEditor