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, ContextMenuListener, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>

public class WHtmlEditor
extends WEditor
implements ContextMenuListener

HTML Editor

Implementation of an editor to show HTML content

Based on contribution from

Version:

$Id: WHTMLEditor.java, v1.0 11/11/2014 20:25:06, muriloht Exp $

Author:

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

Field Summary

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

component, gridField, gridTab, 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 value in grid view mode in non edit status if return null, a label will replace.
String	getDisplayTextForGridView(Object value)
Object	getValue()
boolean	isMandatory()
boolean	isReadWrite()
void	onEvent(org.zkoss.zk.ui.event.Event event)
void	onMenu(ContextMenuEvent evt)
void	setMandatory(boolean mandatory)	Set whether the editor represents a mandatory field.
void	setReadWrite(boolean readWrite)
void	setValue(Object value)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

WHtmlEditor

public WHtmlEditor(GridField gridField)

Parameters:

gridField -

WHtmlEditor

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

Parameters:

gridField -

tableEditor -

editorConfiguration -

Method Detail

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

isMandatory

public boolean isMandatory()

Overrides:

isMandatory in class WEditor

Returns:

boolean

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:

editable

setReadWrite

public void setReadWrite(boolean readWrite)

Specified by:

setReadWrite in class WEditor

setValue

public void setValue(Object value)

Specified by:

setValue in class WEditor

getDisplayTextForGridView

public String getDisplayTextForGridView(Object value)

Overrides:

getDisplayTextForGridView in class WEditor

getDisplayComponent

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

Description copied from class: WEditor

return component use for display value in grid view mode in non edit status if return null, a label will replace. because each row must has one instance of this component, don't cache it. just create new instance

Overrides:

getDisplayComponent in class WEditor

Returns:

onMenu

public void onMenu(ContextMenuEvent evt)

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