Package org.adempiere.webui.editor

Class WHtmlEditor

java.lang.Object

org.adempiere.webui.editor.WEditor

org.adempiere.webui.editor.WHtmlEditor

All Implemented Interfaces:

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

public class WHtmlEditor
extends WEditor
implements ContextMenuListener

Default editor for html (AD_Field.IsHtml=Y) text display type (String, PrinterName, Text, TextLong and Memo).
Implemented with Html component and html editor dialog (WTextEditorDialog) to show and edit HTML content.

Author:

muriloht (muriloht@devcoffee.com.br, http://www.devcoffee.com.br)

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
WHtmlEditor(GridField gridField)
WHtmlEditor(GridField gridField, boolean tableEditor, IEditorConfiguration editorConfiguration)

Method Summary

Modifier and Type	Method	Description
org.zkoss.zul.Div	getComponent()
String	getDisplay()
org.zkoss.zk.ui.Component	getDisplayComponent()	Return component use for display mode in ADTabpanel grid view (GridTabRowRenderer) or custom editor of WListItemRenderer. For GridTabRowRenderer, only Html is supported and will use content from WEditor.getDisplayTextForGridView(GridRowCtx, Object). For WListItemRenderer, Html, Label and InputElement is supported. Return null to use the default of ADTabpanel or WListbox. Note: because each row must has one instance of this component, don't reuse, must always create new instance.
String	getDisplayTextForGridView(Object value)
Object	getValue()
boolean	isMandatory()
boolean	isReadWrite()
void	onEvent(org.zkoss.zk.ui.event.Event event)
void	onMenu(ContextMenuEvent evt)	On context menu event
void	setMandatory(boolean mandatory)	Set whether the editor represents a mandatory field.
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, dynamicDisplay, fillHorizontal, fireValueChange, focusNext, getColumnName, getDescription, getDisplayTextForGridView, getEvents, getGridField, getLabel, getPopupMenu, getStyleEvaluatee, getValidInput, isComponentOfEditor, isMandatoryStyle, isNullOrEmpty, isProcessParameter, isSearchable, isShowPreference, isValid, isVisible, isZoomable, propertyChange, removeDynamicDisplayListener, removeValuechangeListener, setBackground, setBackground, setChangeEventWhenEditing, setColumnName, setComponent, setFieldStyle, setGridTab, setLabelStyle, 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

WHtmlEditor

public WHtmlEditor(GridField gridField)

Parameters:

gridField -

WHtmlEditor

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

Parameters:

gridField -

tableEditor -

editorConfiguration -

Method Details

getComponent

public org.zkoss.zul.Div getComponent()

Overrides:

getComponent in class WEditor

Returns:

Component

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

isMandatory

public boolean isMandatory()

Overrides:

isMandatory in class WEditor

Returns:

true if field is mandatory

setMandatory

public void setMandatory(boolean mandatory)

Description copied from class: WEditor

Set whether the editor represents a mandatory field.

Overrides:

setMandatory in class WEditor

Parameters:

mandatory - whether the field is mandatory

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

setValue

public void setValue(Object value)

Description copied from class: WEditor

Set editor value

Specified by:

setValue in class WEditor

getDisplayTextForGridView

public String getDisplayTextForGridView(Object value)

Overrides:

getDisplayTextForGridView in class WEditor

Returns:

display text for grid view, for consumption by WEditor.getDisplayComponent()

getDisplayComponent

public org.zkoss.zk.ui.Component getDisplayComponent()

Description copied from class: WEditor

Return component use for display mode in ADTabpanel grid view (GridTabRowRenderer) or custom editor of WListItemRenderer.
For GridTabRowRenderer, only Html is supported and will use content from WEditor.getDisplayTextForGridView(GridRowCtx, Object).
For WListItemRenderer, Html, Label and InputElement is supported.
Return null to use the default of ADTabpanel or WListbox.
Note: because each row must has one instance of this component, don't reuse, must always create new instance.

Overrides:

getDisplayComponent in class WEditor

Returns:

Display Component

onMenu

public void onMenu(ContextMenuEvent evt)

Description copied from interface: ContextMenuListener

On context menu event

Specified by:

onMenu in interface ContextMenuListener

onEvent

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

Specified by:

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

Throws:

Exception