gwt.material.design.addins.client.richeditor

Class MaterialRichEditor

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

gwt.material.design.client.base.MaterialWidget

gwt.material.design.client.base.AbstractValueWidget<String>

gwt.material.design.addins.client.richeditor.MaterialRichEditor

All Implemented Interfaces:

com.google.gwt.editor.client.Editor<String>, com.google.gwt.editor.client.HasEditorErrors<String>, com.google.gwt.editor.client.LeafValueEditor<String>, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<String>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, HasPasteHandlers, gwt.material.design.client.base.error.HasErrorHandler, gwt.material.design.client.base.HasAllDragAndDropHandlers, gwt.material.design.client.base.HasBorder, gwt.material.design.client.base.HasCenterOn, gwt.material.design.client.base.HasCircle, gwt.material.design.client.base.HasColors, gwt.material.design.client.base.HasDataAttributes, gwt.material.design.client.base.HasDepth, gwt.material.design.client.base.HasDimension, gwt.material.design.client.base.HasDraggableHandlers, gwt.material.design.client.base.HasDroppableHandlers, gwt.material.design.client.base.HasError, gwt.material.design.client.base.HasFlexbox, gwt.material.design.client.base.HasFloat, gwt.material.design.client.base.HasFontSize, gwt.material.design.client.base.HasFontWeight, gwt.material.design.client.base.HasGrid, gwt.material.design.client.base.HasHideOn, gwt.material.design.client.base.HasHoverable, gwt.material.design.client.base.HasId, gwt.material.design.client.base.HasInitialClasses, gwt.material.design.client.base.HasInlineStyle, gwt.material.design.client.base.HasInteractionHandlers, gwt.material.design.client.base.HasOpacity, gwt.material.design.client.base.HasOrientation, gwt.material.design.client.base.HasOrientationChangeHandler, gwt.material.design.client.base.HasPlaceholder, gwt.material.design.client.base.HasReload, gwt.material.design.client.base.HasScrollspy, gwt.material.design.client.base.HasSeparator, gwt.material.design.client.base.HasShadow, gwt.material.design.client.base.HasShowOn, gwt.material.design.client.base.HasTextAlign, gwt.material.design.client.base.HasTooltip, gwt.material.design.client.base.HasTransform, gwt.material.design.client.base.HasVerticalAlign, gwt.material.design.client.base.HasWaves, gwt.material.design.client.base.JsLoader, gwt.material.design.client.base.validator.HasValidators<String>, gwt.material.design.client.base.validator.ValidationChangedEvent.HasValidationChangedHandlers, Iterable<com.google.gwt.user.client.ui.Widget>

public class MaterialRichEditor
extends gwt.material.design.client.base.AbstractValueWidget<String>
implements gwt.material.design.client.base.JsLoader, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, HasPasteHandlers, gwt.material.design.client.base.HasPlaceholder, com.google.gwt.user.client.ui.HasHTML

Provides a great Rich Editor with amazing options built with Material Design Look and Feel

XML Namespace Declaration

 
 xmlns:ma='urn:import:gwt.material.design.addins.client'
 
 

UiBinder Usage:

 
 <ma:MaterialRichEditor placeholder="Type anything in here..."/>
 
 

Author:

kevzlou7979

See Also:

Material Rich Editor, 1.2.1

Nested Class Summary

Nested classes/interfaces inherited from class gwt.material.design.client.base.MaterialWidget

gwt.material.design.client.base.MaterialWidget.Feature

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

Nested classes/interfaces inherited from interface com.google.gwt.editor.client.Editor

com.google.gwt.editor.client.Editor.Ignore, com.google.gwt.editor.client.Editor.Path

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class gwt.material.design.client.base.MaterialWidget

$this

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
MaterialRichEditor()
MaterialRichEditor(String placeholder)
MaterialRichEditor(String placeholder, String value)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addPasteHandler(PasteEvent.PasteHandler handler)
protected void	adjustFullScreen(gwt.material.design.client.ui.MaterialModal modal)
protected void	adjustNestedModals(gwt.material.design.client.ui.MaterialModal modal)
protected void	checkContainer()
void	clear()
ToolbarButton[]	getCkMediaOptions()
ToolbarButton[]	getColorOptions()
gwt.material.design.jquery.client.api.JQueryElement	getEditor()
ToolbarButton[]	getFontOptions()
String	getHeight()
ToolbarButton[]	getHeightOptions()
String	getHTML()
protected String	getHTMLCode(com.google.gwt.dom.client.Element e)
ToolbarButton[]	getMiscOptions()
ToolbarButton[]	getParaOptions()
String	getPlaceholder()
ToolbarButton[]	getStyleOptions()
String	getText()
ToolbarButton[]	getUndoOptions()
String	getValue()
protected void	insertText(com.google.gwt.dom.client.Element e, String text) Insert custom text inside the note zone.
void	insertText(String text) Insert custom text inside the note zone.
boolean	isAirMode()
boolean	isDisableDragAndDrop() Check if the dnd for rich editor is enabled / disabled
void	load()
protected void	onLoad()
protected void	onUnload()
protected void	pasteHTML(com.google.gwt.dom.client.Element e, String html) Insert custom HTML inside the note zone.
void	pasteHTML(String html) Insert custom HTML inside the note zone.
void	reload()
void	reset() Reset the Rich Editor component
void	setAirMode(boolean airMode)
void	setCkMediaOptions(ToolbarButton... ckMediaOptions)
void	setColorOptions(ToolbarButton... colorOptions)
void	setDisableDragAndDrop(boolean disableDragAndDrop) If true, disable the ability to drag and drop items to rich editor
void	setFontOptions(ToolbarButton... fontOptions)
void	setHeightOptions(ToolbarButton... heightOptions)
void	setHTML(String html)
protected void	setHTMLCode(com.google.gwt.dom.client.Element e, String html)
void	setMiscOptions(ToolbarButton... miscOptions)
void	setParaOptions(ToolbarButton... paraOptions)
void	setPlaceholder(String placeholder)
void	setStyleOptions(ToolbarButton... styleOptions)
void	setText(String text)
void	setUndoOptions(ToolbarButton... undoOptions)
void	setValue(String value, boolean fireEvents)
void	unload()

Methods inherited from class gwt.material.design.client.base.AbstractValueWidget

addValidationChangedHandler, addValidator, addValueChangeHandler, clearErrorOrSuccess, createBlankValidator, getErrorHandler, getErrorHandlerMixin, getErrorHandlerType, getErrorMixin, getValidatorMixin, isAllowBlank, isValidateOnBlur, removeValidator, setAllowBlank, setError, setErrorHandler, setErrorHandlerType, setHelperText, setSuccess, setupBlurValidation, setValidateOnBlur, setValidators, setValue, setValue, showErrors, validate, validate

Methods inherited from class gwt.material.design.client.base.MaterialWidget

$this, add, add, addAttachHandler, addBlurHandler, addClickHandler, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragLeaveHandler, addDragMoveHandler, addDragOverHandler, addDragStartHandler, addDropActivateHandler, addDropDeactivateHandler, addDropHandler, addFocusHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addOrientationChangeHandler, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, body, clearActiveClass, enableFeature, getBackfaceVisibility, getBackgroundColor, getBorder, getBorderBottom, getBorderLeft, getBorderMixin, getBorderRadius, getBorderRight, getBorderTop, getCenterOn, getCenterOnMixin, getChildren, getChildrenList, getCircleMixin, getColorsMixin, getDataAttribute, getDepth, getDimensionMixin, getEnabledMixin, getFlexboxMixin, getFloat, getFloatMixin, getFocusableMixin, getFontSize, getFontSizeMixin, getFontWeight, getFontWeightMixin, getGridMixin, getHandlerRegistry, getHideOn, getHideOnMixin, getHoverableMixin, getId, getIdMixin, getInitialClasses, getLayoutPosition, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpacity, getOrientation, getOrientationMixin, getPerspective, getPerspectiveOrigin, getScrollspy, getScrollspyMixin, getSeparatorMixin, getShadow, getShadowMixin, getShowOn, getShowOnMixin, getTabIndex, getTextAlign, getTextAlignMixin, getTextColor, getTooltip, getTooltipDelayMs, getTooltipHTML, getTooltipMixin, getTooltipPosition, getTransform, getTransformMixin, getTransformOrigin, getTransformStyle, getTruncateMixin, getVerticalAlign, getVerticalAlignMixin, getWaves, getWavesMixin, getWidth, insert, insert, isCircle, isDetectOrientation, isEnabled, isFeatureEnabled, isHoverable, isSeparator, isTruncate, registerHandler, removeHandler, setAccessKey, setBackfaceVisibility, setBackgroundColor, setBorder, setBorderBottom, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBottom, setCenterOn, setCircle, setClass, setDataAttribute, setDepth, setDetectOrientation, setDisplay, setEnabled, setFlex, setFlexAlignContent, setFlexAlignItems, setFlexAlignSelf, setFlexBasis, setFlexDirection, setFlexGrow, setFlexJustifyContent, setFlexOrder, setFlexShrink, setFlexWrap, setFloat, setFocus, setFontSize, setFontSize, setFontWeight, setGrid, setGwtDisplay, setHideOn, setHoverable, setId, setInitialClasses, setLayoutPosition, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOffset, setOpacity, setOrientation, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPerspective, setPerspectiveOrigin, setRight, setScrollspy, setSeparator, setShadow, setShowOn, setStyle, setTabIndex, setTextAlign, setTextColor, setTooltip, setTooltipDelayMs, setTooltipHTML, setTooltipPosition, setTop, setTransform, setTransformOrigin, setTransformStyle, setTransition, setTruncate, setVerticalAlign, setVisibility, setWaves, stopTouchStartEvent, window

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, remove, remove

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

add, adopt, doAttachChildren, doDetachChildren, orphan, remove

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, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.logical.shared.HasValueChangeHandlers

addValueChangeHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface gwt.material.design.client.base.HasFlexbox

setVisible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MaterialRichEditor

public MaterialRichEditor()

MaterialRichEditor

public MaterialRichEditor(String placeholder)

MaterialRichEditor

public MaterialRichEditor(String placeholder,
                          String value)

Method Detail

onLoad

protected void onLoad()

Overrides:

onLoad in class gwt.material.design.client.base.MaterialWidget

load

public void load()

Specified by:

load in interface gwt.material.design.client.base.JsLoader

onUnload

protected void onUnload()

Overrides:

onUnload in class gwt.material.design.client.base.MaterialWidget

unload

public void unload()

Specified by:

unload in interface gwt.material.design.client.base.JsLoader

reload

public void reload()

Specified by:

reload in interface gwt.material.design.client.base.HasReload

getStyleOptions

public ToolbarButton[] getStyleOptions()

setStyleOptions

public void setStyleOptions(ToolbarButton... styleOptions)

getFontOptions

public ToolbarButton[] getFontOptions()

setFontOptions

public void setFontOptions(ToolbarButton... fontOptions)

getColorOptions

public ToolbarButton[] getColorOptions()

setColorOptions

public void setColorOptions(ToolbarButton... colorOptions)

getUndoOptions

public ToolbarButton[] getUndoOptions()

setUndoOptions

public void setUndoOptions(ToolbarButton... undoOptions)

getCkMediaOptions

public ToolbarButton[] getCkMediaOptions()

setCkMediaOptions

public void setCkMediaOptions(ToolbarButton... ckMediaOptions)

getMiscOptions

public ToolbarButton[] getMiscOptions()

setMiscOptions

public void setMiscOptions(ToolbarButton... miscOptions)

getParaOptions

public ToolbarButton[] getParaOptions()

setParaOptions

public void setParaOptions(ToolbarButton... paraOptions)

getHeightOptions

public ToolbarButton[] getHeightOptions()

setHeightOptions

public void setHeightOptions(ToolbarButton... heightOptions)

checkContainer

protected void checkContainer()

adjustNestedModals

protected void adjustNestedModals(gwt.material.design.client.ui.MaterialModal modal)

adjustFullScreen

protected void adjustFullScreen(gwt.material.design.client.ui.MaterialModal modal)

getEditor

public gwt.material.design.jquery.client.api.JQueryElement getEditor()

insertText

public void insertText(String text)

Insert custom text inside the note zone.

insertText

protected void insertText(com.google.gwt.dom.client.Element e,
                          String text)

Insert custom text inside the note zone.

pasteHTML

public void pasteHTML(String html)

Insert custom HTML inside the note zone.

pasteHTML

protected void pasteHTML(com.google.gwt.dom.client.Element e,
                         String html)

Insert custom HTML inside the note zone.

reset

public void reset()

Reset the Rich Editor component

Specified by:

reset in interface gwt.material.design.client.base.validator.HasValidators<String>

Overrides:

reset in class gwt.material.design.client.base.AbstractValueWidget<String>

clear

public void clear()

Specified by:

clear in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

clear in class com.google.gwt.user.client.ui.Panel

isAirMode

public boolean isAirMode()

setAirMode

public void setAirMode(boolean airMode)

isDisableDragAndDrop

public boolean isDisableDragAndDrop()

Check if the dnd for rich editor is enabled / disabled

setDisableDragAndDrop

public void setDisableDragAndDrop(boolean disableDragAndDrop)

If true, disable the ability to drag and drop items to rich editor

getPlaceholder

public String getPlaceholder()

Specified by:

getPlaceholder in interface gwt.material.design.client.base.HasPlaceholder

setPlaceholder

public void setPlaceholder(String placeholder)

Specified by:

setPlaceholder in interface gwt.material.design.client.base.HasPlaceholder

getHeight

public String getHeight()

getHTML

public String getHTML()

Specified by:

getHTML in interface com.google.gwt.user.client.ui.HasHTML

setHTML

public void setHTML(String html)

Specified by:

setHTML in interface com.google.gwt.user.client.ui.HasHTML

getText

public String getText()

Specified by:

getText in interface com.google.gwt.user.client.ui.HasText

setText

public void setText(String text)

Specified by:

setText in interface com.google.gwt.user.client.ui.HasText

getHTMLCode

protected String getHTMLCode(com.google.gwt.dom.client.Element e)

setHTMLCode

protected void setHTMLCode(com.google.gwt.dom.client.Element e,
                           String html)

getValue

public String getValue()

Specified by:

getValue in interface com.google.gwt.user.client.TakesValue<String>

Specified by:

getValue in interface com.google.gwt.user.client.ui.HasValue<String>

setValue

public void setValue(String value,
                     boolean fireEvents)

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<String>

Overrides:

setValue in class gwt.material.design.client.base.AbstractValueWidget<String>

addPasteHandler

public com.google.gwt.event.shared.HandlerRegistration addPasteHandler(PasteEvent.PasteHandler handler)

Specified by:

addPasteHandler in interface HasPasteHandlers