to.etc.domui.component.ckeditor

Class CKEditor

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.InputNodeContainer

to.etc.domui.dom.html.TextArea

to.etc.domui.component.ckeditor.CKEditor

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IActionControl, IControl<String>, IHasChangeListener, IHasModifiedIndication, IHtmlInput, INativeChangeListener

public class CKEditor
extends TextArea

This represents a CKEditor instance.

Author:

Frits Jalvingh Created on Sep 30, 2008, Vladimir Mijic Refactored on Oct 07, 2011, Vladimir Mijic Refactored on Dec 07, 2013 - made it for CKEditor

Field Summary

Fields inherited from class to.etc.domui.dom.html.TextArea

HINT

Constructor Summary

Constructors

Constructor and Description
CKEditor()

Method Summary

Modifier and Type	Method and Description
boolean	acceptRequestParameter(String[] values)
void	appendfixSizeJS() Needed in cases when page layout is changed without resizing browser window.
void	componentHandleWebAction(RequestContextImpl ctx, String action) Handle WEBUI_CK_DOMUIIMAGE_ACTION activity on CKEditor customized commands that interacts with domui.
void	createContent() To create the editor we need to replace the core code.
IEditorFileSystem	getFileSystem()
IClicked<NodeBase>	getOnDomuiImageClicked()
IClicked<NodeBase>	getOnDomuiOddCharsClicked()
CKToolbarSet	getToolbarSet()
boolean	isToolbarStartExpanded()
void	onRemoveFromPage(Page p)
void	renderCancelImage()
void	renderCloseOddCharacters()
void	renderImageSelected(String url)
void	renderOddCharacters(String input)
void	setCssClass(String cssClass) Set the value for the "class" (css class) attribute.
void	setFileSystem(IEditorFileSystem fileSystem)
void	setHeight(String height)
void	setOnDomuiImageClicked(IClicked<NodeBase> onDomuiImageClicked)
void	setOnDomuiOddCharsClicked(IClicked<NodeBase> onDomuiOddCharsClicked)
void	setToolbarSet(CKToolbarSet toolbarSet)
void	setToolbarStartExpanded(boolean toolbarStartExpanded)
void	setWidth(String width)

Methods inherited from class to.etc.domui.dom.html.TextArea

create, getBindValue, getCols, getDisabledBecause, getMaxByteLength, getMaxLength, getRawValue, getRows, getValue, getValueSafe, hasError, isDisabled, isModified, setBindValue, setCols, setDisabled, setDisabledBecause, setMaxByteLength, setMaxLength, setModified, setReadOnly, setRows, setValue, visit

Methods inherited from class to.etc.domui.dom.html.InputNodeContainer

callOnValueChanged, getOnValueChanged, immediate, immediate, isImmediate, isMandatory, isReadOnly, setMandatory, setOnValueChanged

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, addBinding, addCssClass, addGlobalMessage, addNotificationListener, afterCreateContent, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebDataRequest, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setZIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface to.etc.domui.dom.html.INativeChangeListener

getOnValueChanged

Methods inherited from interface to.etc.domui.dom.html.IControl

getErrorLocation, isMandatory, isReadOnly, setErrorLocation, setMandatory

Methods inherited from interface to.etc.domui.dom.html.IActionControl

setTestID

Methods inherited from interface to.etc.domui.dom.html.IHasChangeListener

getOnValueChanged, setOnValueChanged

Methods inherited from interface to.etc.domui.dom.errors.INodeErrorDelegate

clearMessage, getMessage, setMessage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CKEditor

public CKEditor()

Method Detail

setCssClass

public final void setCssClass(@Nullable
                              String cssClass)

Description copied from class: NodeBase

Set the value for the "class" (css class) attribute. This can be null, or one or more class names separated by space.

Overrides:

setCssClass in class NodeBase

createContent

public void createContent()
                   throws Exception

To create the editor we need to replace the core code. We add a textarea having the ID and a special class (ui-ckeditor). This special class is an indicator to the submit logic that the textarea is a CKEditor instance. This causes it to use special logic to retrieve a value.

Overrides:

createContent in class NodeBase

Throws:

Exception

See Also:

NodeBase.createContent()

setWidth

public void setWidth(@Nullable
                     String width)

Overrides:

setWidth in class CssBase

setHeight

public void setHeight(@Nullable
                      String height)

Overrides:

setHeight in class CssBase

getToolbarSet

@Nonnull
public CKToolbarSet getToolbarSet()

setToolbarSet

public void setToolbarSet(@Nonnull
                          CKToolbarSet toolbarSet)

getFileSystem

@Nullable
public IEditorFileSystem getFileSystem()

setFileSystem

public void setFileSystem(@Nullable
                          IEditorFileSystem fileSystem)

componentHandleWebAction

public void componentHandleWebAction(@Nonnull
                                     RequestContextImpl ctx,
                                     @Nonnull
                                     String action)
                              throws Exception

Handle WEBUI_CK_DOMUIIMAGE_ACTION activity on CKEditor customized commands that interacts with domui. Handle WEBUI_CK_DOMUIODDCHAR_ACTION activity on CKEditor customized commands that interacts with domui.

Overrides:

componentHandleWebAction in class NodeBase

Throws:

Exception

See Also:

Div.componentHandleWebAction(to.etc.domui.server.RequestContextImpl, java.lang.String)

renderImageSelected

public void renderImageSelected(@Nonnull
                                String url)

renderCancelImage

public void renderCancelImage()

renderCloseOddCharacters

public void renderCloseOddCharacters()

renderOddCharacters

public void renderOddCharacters(@Nonnull
                                String input)

getOnDomuiImageClicked

@Nullable
public IClicked<NodeBase> getOnDomuiImageClicked()

setOnDomuiImageClicked

public void setOnDomuiImageClicked(@Nonnull
                                   IClicked<NodeBase> onDomuiImageClicked)

getOnDomuiOddCharsClicked

@Nullable
public IClicked<NodeBase> getOnDomuiOddCharsClicked()

setOnDomuiOddCharsClicked

public void setOnDomuiOddCharsClicked(@Nonnull
                                      IClicked<NodeBase> onDomuiOddCharsClicked)

isToolbarStartExpanded

public boolean isToolbarStartExpanded()

setToolbarStartExpanded

public void setToolbarStartExpanded(boolean toolbarStartExpanded)

acceptRequestParameter

public boolean acceptRequestParameter(@Nonnull
                                      String[] values)
                               throws Exception

Overrides:

acceptRequestParameter in class TextArea

Throws:

Exception

onRemoveFromPage

@OverridingMethodsMustInvokeSuper
public void onRemoveFromPage(Page p)

Overrides:

onRemoveFromPage in class NodeBase

appendfixSizeJS

public void appendfixSizeJS()

Needed in cases when page layout is changed without resizing browser window.