com.extjs.gxt.ui.client.widget.form

Class HtmlEditor

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.extjs.gxt.ui.client.widget.Component

com.extjs.gxt.ui.client.widget.BoxComponent

com.extjs.gxt.ui.client.widget.form.Field<String>

com.extjs.gxt.ui.client.widget.form.HtmlEditor

All Implemented Interfaces:

com.extjs.gxt.ui.client.event.Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

public class HtmlEditor
extends com.extjs.gxt.ui.client.widget.form.Field<String>

Provides a lightweight HTML Editor component.

Note: The focus/blur and validation marking functionality inherited from Field is NOT supported by this editor.

An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within any element that has display set to 'none' can cause problems in Safari and Firefox due to their default iframe reloading bugs.

Events:

BeforeSync : HtmlEditorEvent(htmlEditor, change)

Fires before the iframe editor is updated with content from the textarea.

• htmlEditor : this
• change : true for edit mode

Sync : HtmlEditorEvent(htmlEditor, change)

Fires when the iframe editor is updated with content from the textarea.

• htmlEditor : this
• change : true for edit mode

EditModeChange : HtmlEditorEvent(htmlEditor, change)

Fires when the editor switches edit modes.

• htmlEditor : this
• change : true for edit mode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HtmlEditor.EventHandler
class	HtmlEditor.HtmlEditorImages
class	HtmlEditor.HtmlEditorMessages
protected class	HtmlEditor.rte

Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.Field

com.extjs.gxt.ui.client.widget.form.Field.FieldImages, com.extjs.gxt.ui.client.widget.form.Field.FieldMessages

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gwt.user.client.ui.RichTextArea.FontSize	activeFontSize
protected com.extjs.gxt.ui.client.widget.button.Button	backcolor
protected com.extjs.gxt.ui.client.widget.button.ToggleButton	bold
protected com.extjs.gxt.ui.client.event.SelectionListener<com.extjs.gxt.ui.client.event.ButtonEvent>	btnListener
protected com.extjs.gxt.ui.client.widget.button.Button	decreasefontsize
protected List<com.google.gwt.user.client.ui.RichTextArea.FontSize>	fontSizesConstants
protected com.extjs.gxt.ui.client.widget.button.Button	forecolor
protected HtmlEditor.EventHandler	handler
protected com.google.gwt.user.client.ui.impl.RichTextAreaImpl	impl
protected com.extjs.gxt.ui.client.widget.button.Button	increasefontsize
protected com.extjs.gxt.ui.client.widget.button.ToggleButton	italic
protected com.extjs.gxt.ui.client.widget.button.Button	justifyCenter
protected com.extjs.gxt.ui.client.widget.button.Button	justifyLeft
protected com.extjs.gxt.ui.client.widget.button.Button	justifyRight
protected com.extjs.gxt.ui.client.widget.button.Button	link
protected com.extjs.gxt.ui.client.widget.button.Button	ol
protected HtmlEditor.rte	rte
protected com.extjs.gxt.ui.client.widget.button.ToggleButton	sourceEdit
protected com.extjs.gxt.ui.client.widget.toolbar.ToolBar	tb
protected El	textarea
protected com.extjs.gxt.ui.client.widget.button.Button	ul
protected com.extjs.gxt.ui.client.widget.button.ToggleButton	underline

Fields inherited from class com.extjs.gxt.ui.client.widget.form.Field

autoValidate, emptyText, errorIcon, fieldStyle, focusStyle, focusValue, forceInvalidText, hasFocus, images, invalidStyle, messages, name, originalValue, preventMark, propertyEditor, readOnly, readOnlyFieldStyle, validationDelay, validationTask, value

Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width

Fields inherited from class com.extjs.gxt.ui.client.widget.Component

afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
HtmlEditor()

Method Summary

Modifier and Type	Method and Description
protected void	afterRender()
protected com.extjs.gxt.ui.client.widget.button.Button	createButton(com.google.gwt.user.client.ui.AbstractImagePrototype icon, String tt, String toolTipTitle)
protected com.extjs.gxt.ui.client.widget.button.Button	createColorButton(com.google.gwt.user.client.ui.AbstractImagePrototype icon, String toolTip, String toolTipTitle, com.extjs.gxt.ui.client.event.Listener<com.extjs.gxt.ui.client.event.ComponentEvent> listener)
protected com.extjs.gxt.ui.client.widget.button.ToggleButton	createToggleButton(com.google.gwt.user.client.ui.AbstractImagePrototype icon, String tt, String toolTipTitle)
protected void	doAttachChildren()
protected void	doDetachChildren()
com.google.gwt.user.client.ui.RichTextArea.BasicFormatter	getBasicFormatter() Gets the basic rich text formatting interface.
com.google.gwt.user.client.ui.RichTextArea.ExtendedFormatter	getExtendedFormatter() Gets the full rich text formatting interface.
HtmlEditor.HtmlEditorImages	getImages()
protected El	getInputEl()
HtmlEditor.HtmlEditorMessages	getMessages()
String	getRawValue()
boolean	isEnableAlignments()
boolean	isEnableColors()
boolean	isEnableFont()
boolean	isEnableFontSize()
boolean	isEnableFormat()
boolean	isEnableLinks()
boolean	isEnableLists()
boolean	isShowToolbar()
boolean	isSourceEditMode()
protected void	onAttach()
protected void	onBlur(com.extjs.gxt.ui.client.event.ComponentEvent ce)
protected void	onDisable()
protected void	onEditorKeyDown(com.google.gwt.event.dom.client.KeyDownEvent e)
protected void	onEnable()
protected void	onFocus(com.extjs.gxt.ui.client.event.ComponentEvent ce)
protected void	onRender(com.google.gwt.user.client.Element target, int index)
protected void	onResize(int width, int height)
void	pushValue()
void	setEnableAlignments(boolean enableAlignments)
void	setEnableColors(boolean enableColors)
void	setEnableFont(boolean enableFont)
void	setEnableFontSize(boolean enableFontSize)
void	setEnableFormat(boolean enableFormat)
void	setEnableLinks(boolean enableLinks)
void	setEnableLists(boolean enableLists)
protected void	setHighContrastImage(com.extjs.gxt.ui.client.widget.button.Button btn, String image)
void	setRawValue(String value)
void	setShowToolbar(boolean showToolbar)
void	setSourceEditMode(boolean mode)
protected void	setupToolbar()
void	setValue(String value)
void	syncValue()
protected void	toggleSourceEditMode()
protected void	updateStatus()
boolean	validate(boolean silent)

Methods inherited from class com.extjs.gxt.ui.client.widget.form.Field

addInputStyleName, addKeyListener, alignErrorIcon, clear, clearInvalid, createComponentEvent, findLabelElement, fireChangeEvent, fireKey, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getLabelSeparator, getLabelStyle, getMessageTarget, getName, getOriginalValue, getPropertyEditor, getStyleEl, getValidateOnBlur, getValidationDelay, getValue, initValue, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, isValid, markInvalid, onClick, onComponentEvent, onDetach, onHide, onKeyDown, onKeyPress, onKeyUp, onShow, removeInputStyleName, removeKeyListener, reset, setAutoValidate, setEmptyText, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setInputStyleAttribute, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setName, setOriginalValue, setPropertyEditor, setReadOnly, setTabIndex, setValidateOnBlur, setValidationDelay, updateOriginalValue, validate, validateValue

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onBrowserEvent, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, resolvePotentialElement, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object

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

Field Detail

activeFontSize

protected com.google.gwt.user.client.ui.RichTextArea.FontSize activeFontSize

backcolor

protected com.extjs.gxt.ui.client.widget.button.Button backcolor

bold

protected com.extjs.gxt.ui.client.widget.button.ToggleButton bold

btnListener

protected com.extjs.gxt.ui.client.event.SelectionListener<com.extjs.gxt.ui.client.event.ButtonEvent> btnListener

decreasefontsize

protected com.extjs.gxt.ui.client.widget.button.Button decreasefontsize

fontSizesConstants

protected List<com.google.gwt.user.client.ui.RichTextArea.FontSize> fontSizesConstants

forecolor

protected com.extjs.gxt.ui.client.widget.button.Button forecolor

handler

protected HtmlEditor.EventHandler handler

impl

protected com.google.gwt.user.client.ui.impl.RichTextAreaImpl impl

increasefontsize

protected com.extjs.gxt.ui.client.widget.button.Button increasefontsize

italic

protected com.extjs.gxt.ui.client.widget.button.ToggleButton italic

justifyCenter

protected com.extjs.gxt.ui.client.widget.button.Button justifyCenter

justifyLeft

protected com.extjs.gxt.ui.client.widget.button.Button justifyLeft

justifyRight

protected com.extjs.gxt.ui.client.widget.button.Button justifyRight

link

protected com.extjs.gxt.ui.client.widget.button.Button link

ol

protected com.extjs.gxt.ui.client.widget.button.Button ol

rte

protected HtmlEditor.rte rte

sourceEdit

protected com.extjs.gxt.ui.client.widget.button.ToggleButton sourceEdit

tb

protected com.extjs.gxt.ui.client.widget.toolbar.ToolBar tb

textarea

protected El textarea

ul

protected com.extjs.gxt.ui.client.widget.button.Button ul

underline

protected com.extjs.gxt.ui.client.widget.button.ToggleButton underline

Constructor Detail

HtmlEditor

public HtmlEditor()

Method Detail

getBasicFormatter

public com.google.gwt.user.client.ui.RichTextArea.BasicFormatter getBasicFormatter()

Gets the basic rich text formatting interface.

Returns:

null if basic formatting is not supported

getExtendedFormatter

public com.google.gwt.user.client.ui.RichTextArea.ExtendedFormatter getExtendedFormatter()

Gets the full rich text formatting interface.

Returns:

null if full formatting is not supported

getImages

public HtmlEditor.HtmlEditorImages getImages()

Overrides:

getImages in class com.extjs.gxt.ui.client.widget.form.Field<String>

getMessages

public HtmlEditor.HtmlEditorMessages getMessages()

Overrides:

getMessages in class com.extjs.gxt.ui.client.widget.form.Field<String>

getRawValue

public String getRawValue()

Overrides:

getRawValue in class com.extjs.gxt.ui.client.widget.form.Field<String>

isEnableAlignments

public boolean isEnableAlignments()

isEnableColors

public boolean isEnableColors()

isEnableFont

public boolean isEnableFont()

isEnableFontSize

public boolean isEnableFontSize()

isEnableFormat

public boolean isEnableFormat()

isEnableLinks

public boolean isEnableLinks()

isEnableLists

public boolean isEnableLists()

isShowToolbar

public boolean isShowToolbar()

isSourceEditMode

public boolean isSourceEditMode()

pushValue

public void pushValue()

setEnableAlignments

public void setEnableAlignments(boolean enableAlignments)

setEnableColors

public void setEnableColors(boolean enableColors)

setEnableFont

public void setEnableFont(boolean enableFont)

setEnableFontSize

public void setEnableFontSize(boolean enableFontSize)

setEnableFormat

public void setEnableFormat(boolean enableFormat)

setEnableLinks

public void setEnableLinks(boolean enableLinks)

setEnableLists

public void setEnableLists(boolean enableLists)

setRawValue

public void setRawValue(String value)

Overrides:

setRawValue in class com.extjs.gxt.ui.client.widget.form.Field<String>

setShowToolbar

public void setShowToolbar(boolean showToolbar)

setSourceEditMode

public void setSourceEditMode(boolean mode)

setValue

public void setValue(String value)

Overrides:

setValue in class com.extjs.gxt.ui.client.widget.form.Field<String>

syncValue

public void syncValue()

validate

public boolean validate(boolean silent)

Overrides:

validate in class com.extjs.gxt.ui.client.widget.form.Field<String>

afterRender

protected void afterRender()

Overrides:

afterRender in class com.extjs.gxt.ui.client.widget.form.Field<String>

createButton

protected com.extjs.gxt.ui.client.widget.button.Button createButton(com.google.gwt.user.client.ui.AbstractImagePrototype icon,
                                                                    String tt,
                                                                    String toolTipTitle)

createColorButton

protected com.extjs.gxt.ui.client.widget.button.Button createColorButton(com.google.gwt.user.client.ui.AbstractImagePrototype icon,
                                                                         String toolTip,
                                                                         String toolTipTitle,
                                                                         com.extjs.gxt.ui.client.event.Listener<com.extjs.gxt.ui.client.event.ComponentEvent> listener)

createToggleButton

protected com.extjs.gxt.ui.client.widget.button.ToggleButton createToggleButton(com.google.gwt.user.client.ui.AbstractImagePrototype icon,
                                                                                String tt,
                                                                                String toolTipTitle)

doAttachChildren

protected void doAttachChildren()

Overrides:

doAttachChildren in class com.extjs.gxt.ui.client.widget.Component

doDetachChildren

protected void doDetachChildren()

Overrides:

doDetachChildren in class com.extjs.gxt.ui.client.widget.form.Field<String>

getInputEl

protected El getInputEl()

Overrides:

getInputEl in class com.extjs.gxt.ui.client.widget.form.Field<String>

onAttach

protected void onAttach()

Overrides:

onAttach in class com.extjs.gxt.ui.client.widget.Component

onBlur

protected void onBlur(com.extjs.gxt.ui.client.event.ComponentEvent ce)

Overrides:

onBlur in class com.extjs.gxt.ui.client.widget.form.Field<String>

onDisable

protected void onDisable()

Overrides:

onDisable in class com.extjs.gxt.ui.client.widget.form.Field<String>

onEditorKeyDown

protected void onEditorKeyDown(com.google.gwt.event.dom.client.KeyDownEvent e)

onEnable

protected void onEnable()

Overrides:

onEnable in class com.extjs.gxt.ui.client.widget.form.Field<String>

onFocus

protected void onFocus(com.extjs.gxt.ui.client.event.ComponentEvent ce)

Overrides:

onFocus in class com.extjs.gxt.ui.client.widget.form.Field<String>

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)

Overrides:

onRender in class com.extjs.gxt.ui.client.widget.form.Field<String>

onResize

protected void onResize(int width,
                        int height)

Overrides:

onResize in class com.extjs.gxt.ui.client.widget.form.Field<String>

setHighContrastImage

protected void setHighContrastImage(com.extjs.gxt.ui.client.widget.button.Button btn,
                                    String image)

setupToolbar

protected void setupToolbar()

toggleSourceEditMode

protected void toggleSourceEditMode()

updateStatus

protected void updateStatus()