Package org.adempiere.webui.editor

Class WStringEditor

java.lang.Object

org.adempiere.webui.editor.WEditor

org.adempiere.webui.editor.WStringEditor

All Implemented Interfaces:

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

Direct Known Subclasses:

WJsonEditor, WPasswordEditor, WUnknownEditor

public class WStringEditor
extends WEditor
implements ContextMenuListener

Default editor for text display type (String, PrinterName, Text, TextLong and Memo).
Implemented with Textbox or Combobox (AD_Field.IsAutocomplete=Y) component and WTextEditorDialog dialog.

Author:

Ashley G Ramdass

Nested Class Summary

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

WEditor.DynamicDisplayListener

Field Summary

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
WStringEditor()	Default constructor
WStringEditor(String columnName, boolean mandatory, boolean isReadOnly, boolean isUpdateable, int displayLength, int fieldLength, String wVFormat, String obscureType)
WStringEditor(GridField gridField)
WStringEditor(GridField gridField, boolean tableEditor)
WStringEditor(GridField gridField, boolean tableEditor, IEditorConfiguration editorConfiguration)

Method Summary

Modifier and Type	Method	Description
void	actionRefresh()	Refresh auto complete combo
void	dynamicDisplay()	Dynamic update of component state
org.zkoss.zul.Textbox	getComponent()
String	getDisplay()
String[]	getEvents()
Object	getValue()
boolean	isReadWrite()
void	onEvent(org.zkoss.zk.ui.event.Event event)
void	onMenu(ContextMenuEvent evt)	On context menu event
void	setReadWrite(boolean readWrite)
protected void	setTypePassword(boolean password)	Set type of textbox to password or text
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

Constructor Details

WStringEditor

public WStringEditor()

Default constructor

WStringEditor

public WStringEditor(GridField gridField)

Parameters:

gridField -

WStringEditor

public WStringEditor(GridField gridField,
 boolean tableEditor)

Parameters:

gridField -

tableEditor -

WStringEditor

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

Parameters:

gridField -

tableEditor -

editorConfiguration -

WStringEditor

public WStringEditor(String columnName,
 boolean mandatory,
 boolean isReadOnly,
 boolean isUpdateable,
 int displayLength,
 int fieldLength,
 String wVFormat,
 String obscureType)

Parameters:

columnName -

mandatory -

isReadOnly -

isUpdateable -

displayLength -

fieldLength -

wVFormat -

obscureType -

Method Details

getComponent

public org.zkoss.zul.Textbox 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>

getDisplay

public String getDisplay()

Specified by:

getDisplay in class WEditor

Returns:

display text

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

setTypePassword

protected void setTypePassword(boolean password)

Set type of textbox to password or text

Parameters:

password - true to set type to password

getEvents

public String[] getEvents()

Overrides:

getEvents in class WEditor

Returns:

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

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()

Description copied from class: WEditor

Dynamic update of component state

Overrides:

dynamicDisplay in class WEditor

actionRefresh

public void actionRefresh()

Refresh auto complete combo