Class RichTextEditor
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,HasClickHandlers,HasDoubleClickHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers,HasMembersChangedHandlers
The HTML generated from this component may vary by browser, and, as with any HTML value created on the client, we recommend values be sanitized on the server before storing and displaying to other users.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()voiddoWarn()Display a warning if Rich Text Editing is not fully supported in this browser.The prompt for the built-inalignCentercontrol.The prompt for the built-inalignLeftcontrol.The prompt for the built-inalignRightcontrol.The prompt for the built-inbackgroundColorcontrol.The prompt for the built-inboldSelectioncontrol.The prompt for the built-incolorcontrol.The prompt for the built-incopySelectioncontrol.The prompt for the built-incutSelectioncontrol.The edit canvas created automatically for this RichTextEditor.Background color for theedit canvas.ValueMap of CSS fontName properties to font name titles to display in the font selector for theFONTSELECTORcontrol.Thecom.smartgwt.client.types.AutoChildSelectItemused for choosing the font to apply to the current selection.The prompt for the built-infont selector.ValueMap of CSS font size property values to font size titles to display in the font size selector for theFONTSIZESELECTORcontrol.Thecom.smartgwt.client.types.AutoChildSelectItemused for choosing the font-size to apply to the current selection.The prompt for the built-infont-size selector.The prompt for the built-inindentcontrol.The prompt for the built-initalicSelectioncontrol.The prompt for the built-injustifycontrol.Dialog shown when the"listProperties" controlis pressed.The prompt for the built-inlistPropertiescontrol.The warning message displayed in a dialog when a user tries to configure a list without first putting the cursor in an appropriate place.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.booleanIf the user presses the "Tab" key, should focus be taken from this editor? If set tofalsea "Tab" keypress will cause a Tab character to be inserted into the text, and focus will be left in the edit area.static RichTextEditorgetOrCreateRef(JavaScriptObject jsObj) The prompt for the built-inorderedListcontrol.The prompt for the built-inoutdentcontrol.The prompt for the built-inpasteSelectioncontrol.The prompt for the built-instrikethroughSelectioncontrol.When true, applies style attributes in markup instead of presentation elements.Layout used to contain all of thetoolbarAutoChildren that contain thecontrolGroups.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.The background color for the toolbar.The prompt for the built-inunderlineSelectioncontrol.The prompt for the built-inunorderedListcontrol.Should this editor use a separate IFRAME with special cross-browser support for editing HTML content? In Smart GWT versions 13.0 and later, this feature is switched off on account of better modern browser support for contentEditable containers.getValue()Initial value for the edit area.Does this browser support the full RichTextEditor feature set.setAlignCenterPrompt(String alignCenterPrompt) The prompt for the built-inalignCentercontrol.setAlignLeftPrompt(String alignLeftPrompt) The prompt for the built-inalignLeftcontrol.setAlignRightPrompt(String alignRightPrompt) The prompt for the built-inalignRightcontrol.setBackgroundColorPrompt(String backgroundColorPrompt) The prompt for the built-inbackgroundColorcontrol.setBoldSelectionPrompt(String boldSelectionPrompt) The prompt for the built-inboldSelectioncontrol.setBulletControls(ControlName... bulletControls) Default HTML list control group.voidsetBulletControls(Object... bulletControls) Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setBulletControls(ControlName... bulletControls)setColorControls(ControlName... colorControls) Control group for modifying text color / background color.voidsetColorControls(Object... colorControls) Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setColorControls(ControlName... colorControls)setColorPrompt(String colorPrompt) The prompt for the built-incolorcontrol.voidsetControlGroups(Object... controlGroups) An array of control groups specifying which groups of controls should be included in the editor tool area.voidsetControlGroups(String... controlGroups) An array of control group names specifying which groups of controls should be included in the editor tool area.setCopySelectionPrompt(String copySelectionPrompt) The prompt for the built-incopySelectioncontrol.setCutSelectionPrompt(String cutSelectionPrompt) The prompt for the built-incutSelectioncontrol.static voidsetDefaultProperties(RichTextEditor richTextEditorProperties) Class level method to set the default properties of this class.setEditAreaBackgroundColor(String editAreaBackgroundColor) Background color for theedit canvas.setFontControls(ControlName... fontControls) Default font control group.voidsetFontControls(Object... fontControls) Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setFontControls(ControlName... fontControls)voidsetFontNames(LinkedHashMap<String, String> fontNames) ValueMap of CSS fontName properties to font name titles to display in the font selector for theFONTSELECTORcontrol.setFontSelectorPrompt(String fontSelectorPrompt) The prompt for the built-infont selector.voidsetFontSizes(LinkedHashMap<String, String> fontSizes) ValueMap of CSS font size property values to font size titles to display in the font size selector for theFONTSIZESELECTORcontrol.setFontSizeSelectorPrompt(String fontSizeSelectorPrompt) The prompt for the built-infont-size selector.setFormatControls(ControlName... formatControls) Default text formatting control group.voidsetFormatControls(Object... formatControls) Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setFormatControls(ControlName... formatControls)setIndentPrompt(String indentPrompt) The prompt for the built-inindentcontrol.setItalicSelectionPrompt(String italicSelectionPrompt) The prompt for the built-initalicSelectioncontrol.setJustifyPrompt(String justifyPrompt) The prompt for the built-injustifycontrol.setListPropertiesPrompt(String listPropertiesPrompt) The prompt for the built-inlistPropertiescontrol.setListPropertiesWarningText(String listPropertiesWarningText) The warning message displayed in a dialog when a user tries to configure a list without first putting the cursor in an appropriate place.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setMoveFocusOnTab(boolean moveFocusOnTab) If the user presses the "Tab" key, should focus be taken from this editor? If set tofalsea "Tab" keypress will cause a Tab character to be inserted into the text, and focus will be left in the edit area.setOrderedListPrompt(String orderedListPrompt) The prompt for the built-inorderedListcontrol.setOutdentPrompt(String outdentPrompt) The prompt for the built-inoutdentcontrol.setPasteSelectionPrompt(String pasteSelectionPrompt) The prompt for the built-inpasteSelectioncontrol.setStrikethroughSelectionPrompt(String strikethroughSelectionPrompt) The prompt for the built-instrikethroughSelectioncontrol.setStyleControls(ControlName... styleControls) Default text styling control group.voidsetStyleControls(Object... styleControls) Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setStyleControls(ControlName... styleControls)setStyleWithCSS(Boolean styleWithCSS) When true, applies style attributes in markup instead of presentation elements.setToolbarBackgroundColor(String toolbarBackgroundColor) The background color for the toolbar.setUnderlineSelectionPrompt(String underlineSelectionPrompt) The prompt for the built-inunderlineSelectioncontrol.setUnorderedListPrompt(String unorderedListPrompt) The prompt for the built-inunorderedListcontrol.setUseDesignMode(Boolean useDesignMode) Should this editor use a separate IFRAME with special cross-browser support for editing HTML content? In Smart GWT versions 13.0 and later, this feature is switched off on account of better modern browser support for contentEditable containers.Initial value for the edit area.Methods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructureMethods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEditProxyConstructor, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEditProxyConstructor, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMemberMethods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
RichTextEditor
public RichTextEditor() -
RichTextEditor
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
setAlignCenterPrompt
The prompt for the built-inalignCentercontrol.- Parameters:
alignCenterPrompt- New alignCenterPrompt value. Default value is "Center selection"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getAlignCenterPrompt
The prompt for the built-inalignCentercontrol.- Returns:
- Current alignCenterPrompt value. Default value is "Center selection"
-
setAlignLeftPrompt
The prompt for the built-inalignLeftcontrol.- Parameters:
alignLeftPrompt- New alignLeftPrompt value. Default value is "Left align selection"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getAlignLeftPrompt
The prompt for the built-inalignLeftcontrol.- Returns:
- Current alignLeftPrompt value. Default value is "Left align selection"
-
setAlignRightPrompt
The prompt for the built-inalignRightcontrol.- Parameters:
alignRightPrompt- New alignRightPrompt value. Default value is "Right align selection"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getAlignRightPrompt
The prompt for the built-inalignRightcontrol.- Returns:
- Current alignRightPrompt value. Default value is "Right align selection"
-
setBackgroundColorPrompt
The prompt for the built-inbackgroundColorcontrol.- Parameters:
backgroundColorPrompt- New backgroundColorPrompt value. Default value is "Set selection background color"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getBackgroundColorPrompt
The prompt for the built-inbackgroundColorcontrol.- Returns:
- Current backgroundColorPrompt value. Default value is "Set selection background color"
-
setBoldSelectionPrompt
The prompt for the built-inboldSelectioncontrol.- Parameters:
boldSelectionPrompt- New boldSelectionPrompt value. Default value is "Make selection bold"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getBoldSelectionPrompt
The prompt for the built-inboldSelectioncontrol.- Returns:
- Current boldSelectionPrompt value. Default value is "Make selection bold"
-
setBulletControls
Default HTML list control group. Consists of an array ofControlNames and/orCanvasinstances. To display this group of controls for some RichTextEditor, include"bulletControls"in thecontrolGroupsarray.Note : This is an advanced setting
- Parameters:
bulletControls- New bulletControls value. Default value is ["indent", "outdent", "orderedList", "unorderedList", "listProperties"]- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setColorControls
Control group for modifying text color / background color. Consists of an array ofControlNames and/orCanvasinstances. To display this group of controls for some RichTextEditor, include"formatControls"in thecontrolGroupsarray.Note : This is an advanced setting
- Parameters:
colorControls- New colorControls value. Default value is ["color", "backgroundColor"]- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setColorPrompt
The prompt for the built-incolorcontrol.- Parameters:
colorPrompt- New colorPrompt value. Default value is "Set selection text color"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getColorPrompt
The prompt for the built-incolorcontrol.- Returns:
- Current colorPrompt value. Default value is "Set selection text color"
-
setCopySelectionPrompt
The prompt for the built-incopySelectioncontrol.- Parameters:
copySelectionPrompt- New copySelectionPrompt value. Default value is "Copy Selection"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getCopySelectionPrompt
The prompt for the built-incopySelectioncontrol.- Returns:
- Current copySelectionPrompt value. Default value is "Copy Selection"
-
setCutSelectionPrompt
The prompt for the built-incutSelectioncontrol.- Parameters:
cutSelectionPrompt- New cutSelectionPrompt value. Default value is "Cut Selection"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getCutSelectionPrompt
The prompt for the built-incutSelectioncontrol.- Returns:
- Current cutSelectionPrompt value. Default value is "Cut Selection"
-
getEditArea
The edit canvas created automatically for this RichTextEditor.This component is an AutoChild named "editArea". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current editArea value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setEditAreaBackgroundColor
public RichTextEditor setEditAreaBackgroundColor(String editAreaBackgroundColor) throws IllegalStateException Background color for theedit canvas.- Parameters:
editAreaBackgroundColor- New editAreaBackgroundColor value. Default value is "white"- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getEditAreaBackgroundColor
Background color for theedit canvas.- Returns:
- Current editAreaBackgroundColor value. Default value is "white"
-
setFontControls
Default font control group. Consists of an array ofControlNames and/orCanvasinstances. To display this group of controls for some RichTextEditor, include"fontControls"in thecontrolGroupsarray.Note : This is an advanced setting
- Parameters:
fontControls- New fontControls value. Default value is ["fontSelector", "fontSizeSelector"]- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getFontSelectorItem
Thecom.smartgwt.client.types.AutoChildSelectItemused for choosing the font to apply to the current selection.This component is an AutoChild named "fontSelectorItem". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current fontSelectorItem value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setFontSelectorPrompt
The prompt for the built-infont selector.- Parameters:
fontSelectorPrompt- New fontSelectorPrompt value. Default value is "Set Font..."- Returns:
RichTextEditorinstance, for chaining setter calls
-
getFontSelectorPrompt
The prompt for the built-infont selector.- Returns:
- Current fontSelectorPrompt value. Default value is "Set Font..."
-
getFontSizeSelectorItem
Thecom.smartgwt.client.types.AutoChildSelectItemused for choosing the font-size to apply to the current selection.This component is an AutoChild named "fontSizeSelectorItem". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current fontSizeSelectorItem value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setFontSizeSelectorPrompt
The prompt for the built-infont-size selector.- Parameters:
fontSizeSelectorPrompt- New fontSizeSelectorPrompt value. Default value is "Set Font Size..."- Returns:
RichTextEditorinstance, for chaining setter calls
-
getFontSizeSelectorPrompt
The prompt for the built-infont-size selector.- Returns:
- Current fontSizeSelectorPrompt value. Default value is "Set Font Size..."
-
setFormatControls
Default text formatting control group. Consists of an array ofControlNames and/orCanvasinstances. To display this group of controls for some RichTextEditor, include"formatControls"in thecontrolGroupsarray.Note : This is an advanced setting
- Parameters:
formatControls- New formatControls value. Default value is ["alignLeft", "alignRight", "alignCenter", "justify"]- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setIndentPrompt
The prompt for the built-inindentcontrol.- Parameters:
indentPrompt- New indentPrompt value. Default value is "Increase Indent"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getIndentPrompt
The prompt for the built-inindentcontrol.- Returns:
- Current indentPrompt value. Default value is "Increase Indent"
-
setItalicSelectionPrompt
The prompt for the built-initalicSelectioncontrol.- Parameters:
italicSelectionPrompt- New italicSelectionPrompt value. Default value is "Make selection italic"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getItalicSelectionPrompt
The prompt for the built-initalicSelectioncontrol.- Returns:
- Current italicSelectionPrompt value. Default value is "Make selection italic"
-
setJustifyPrompt
The prompt for the built-injustifycontrol.- Parameters:
justifyPrompt- New justifyPrompt value. Default value is "Full justify selection"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getJustifyPrompt
The prompt for the built-injustifycontrol.- Returns:
- Current justifyPrompt value. Default value is "Full justify selection"
-
getListPropertiesDialog
Dialog shown when the"listProperties" controlis pressed. Provides options for the user to control formatting of lists.This component is an AutoChild named "listPropertiesDialog". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current listPropertiesDialog value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setListPropertiesPrompt
The prompt for the built-inlistPropertiescontrol.- Parameters:
listPropertiesPrompt- New listPropertiesPrompt value. Default value is "Configure the list"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getListPropertiesPrompt
The prompt for the built-inlistPropertiescontrol.- Returns:
- Current listPropertiesPrompt value. Default value is "Configure the list"
-
setListPropertiesWarningText
The warning message displayed in a dialog when a user tries to configure a list without first putting the cursor in an appropriate place.- Parameters:
listPropertiesWarningText- New listPropertiesWarningText value. Default value is "Place the cursor within a list to configure it"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getListPropertiesWarningText
The warning message displayed in a dialog when a user tries to configure a list without first putting the cursor in an appropriate place.- Returns:
- Current listPropertiesWarningText value. Default value is "Place the cursor within a list to configure it"
-
setMoveFocusOnTab
If the user presses the "Tab" key, should focus be taken from this editor? If set tofalsea "Tab" keypress will cause a Tab character to be inserted into the text, and focus will be left in the edit area.
If this method is called after the component has been drawn/initialized: Setter formoveFocusOnTab.- Parameters:
moveFocusOnTab- new value for moveFocusOnTab. Default value is true- Returns:
RichTextEditorinstance, for chaining setter calls
-
getMoveFocusOnTab
public boolean getMoveFocusOnTab()If the user presses the "Tab" key, should focus be taken from this editor? If set tofalsea "Tab" keypress will cause a Tab character to be inserted into the text, and focus will be left in the edit area.- Returns:
- Current moveFocusOnTab value. Default value is true
-
setOrderedListPrompt
The prompt for the built-inorderedListcontrol.- Parameters:
orderedListPrompt- New orderedListPrompt value. Default value is "Convert to a numbered list"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getOrderedListPrompt
The prompt for the built-inorderedListcontrol.- Returns:
- Current orderedListPrompt value. Default value is "Convert to a numbered list"
-
setOutdentPrompt
The prompt for the built-inoutdentcontrol.- Parameters:
outdentPrompt- New outdentPrompt value. Default value is "Decrease Indent"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getOutdentPrompt
The prompt for the built-inoutdentcontrol.- Returns:
- Current outdentPrompt value. Default value is "Decrease Indent"
-
setPasteSelectionPrompt
The prompt for the built-inpasteSelectioncontrol.- Parameters:
pasteSelectionPrompt- New pasteSelectionPrompt value. Default value is "Paste"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getPasteSelectionPrompt
The prompt for the built-inpasteSelectioncontrol.- Returns:
- Current pasteSelectionPrompt value. Default value is "Paste"
-
setStrikethroughSelectionPrompt
The prompt for the built-instrikethroughSelectioncontrol.- Parameters:
strikethroughSelectionPrompt- New strikethroughSelectionPrompt value. Default value is "Strike through selection"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getStrikethroughSelectionPrompt
The prompt for the built-instrikethroughSelectioncontrol.- Returns:
- Current strikethroughSelectionPrompt value. Default value is "Strike through selection"
-
setStyleControls
Default text styling control group. Consists of an array ofControlNames and/orCanvasinstances. To display this group of controls for some RichTextEditor, include"styleControls"in thecontrolGroupsarray.Note : This is an advanced setting
- Parameters:
styleControls- New styleControls value. Default value is ["boldSelection", "italicSelection", "underlineSelection"]- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setStyleWithCSS
When true, applies style attributes in markup instead of presentation elements.Note : This is an advanced setting
- Parameters:
styleWithCSS- New styleWithCSS value. Default value is null- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getStyleWithCSS
When true, applies style attributes in markup instead of presentation elements.- Returns:
- Current styleWithCSS value. Default value is null
-
getToolArea
Layout used to contain all of thetoolbarAutoChildren that contain thecontrolGroups.This component is an AutoChild named "toolArea". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current toolArea value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
getToolbar
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildrenfor details.Layout used to contain each of the
controlGroups.- Returns:
- null
-
setToolbarBackgroundColor
public RichTextEditor setToolbarBackgroundColor(String toolbarBackgroundColor) throws IllegalStateException The background color for the toolbar.- Parameters:
toolbarBackgroundColor- New toolbarBackgroundColor value. Default value is "#CCCCCC"- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getToolbarBackgroundColor
The background color for the toolbar.- Returns:
- Current toolbarBackgroundColor value. Default value is "#CCCCCC"
-
setUnderlineSelectionPrompt
The prompt for the built-inunderlineSelectioncontrol.- Parameters:
underlineSelectionPrompt- New underlineSelectionPrompt value. Default value is "Make selection underlined"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getUnderlineSelectionPrompt
The prompt for the built-inunderlineSelectioncontrol.- Returns:
- Current underlineSelectionPrompt value. Default value is "Make selection underlined"
-
setUnorderedListPrompt
The prompt for the built-inunorderedListcontrol.- Parameters:
unorderedListPrompt- New unorderedListPrompt value. Default value is "Convert to a bullet list"- Returns:
RichTextEditorinstance, for chaining setter calls
-
getUnorderedListPrompt
The prompt for the built-inunorderedListcontrol.- Returns:
- Current unorderedListPrompt value. Default value is "Convert to a bullet list"
-
setUseDesignMode
Should this editor use a separate IFRAME with special cross-browser support for editing HTML content? In Smart GWT versions 13.0 and later, this feature is switched off on account of better modern browser support for contentEditable containers.Note : This is an advanced setting
- Parameters:
useDesignMode- New useDesignMode value. Default value is false- Returns:
RichTextEditorinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getUseDesignMode
Should this editor use a separate IFRAME with special cross-browser support for editing HTML content? In Smart GWT versions 13.0 and later, this feature is switched off on account of better modern browser support for contentEditable containers.- Returns:
- Current useDesignMode value. Default value is false
-
setValue
Initial value for the edit area. UsegetValue()andsetValue()to update at runtime.
If this method is called after the component has been drawn/initialized: Updates the current value of the edit area.- Parameters:
value- New value value. Default value is ""- Returns:
RichTextEditorinstance, for chaining setter calls
-
getValue
Initial value for the edit area. UsegetValue()andsetValue()to update at runtime.- Returns:
- Retrieves the current value of the edit area. Default value is ""
-
doWarn
public void doWarn()Display a warning if Rich Text Editing is not fully supported in this browser. Default behavior logs a warning to the developer console - Override this if a user-visible warning is required -
richEditorSupported
Does this browser support the full RichTextEditor feature set. Returns false for browsers in which some features are not natively supported (Safari before version 3.1 and Opera before version 9.50).- Returns:
- false if this browser doesn't fully support RichTextEditing
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
richTextEditorProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setControlGroups
An array of control group names specifying which groups of controls should be included in the editor tool area. The special string "break" may also be included in this array to cause the subsequent control groups to continue onto a new line.- Parameters:
controlGroups- the control groups. Default is ["fontControls", "formatControls", "styleControls", "colorControls"]- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setControlGroups
An array of control groups specifying which groups of controls should be included in the editor tool area. The values of this array may be aStandardControlGroupenum value, the name of a control group (String), aCanvas, or the special string "break" which causes the subsequent control groups to continue onto a new line.- Parameters:
controlGroups- the control groups. Default is [FONTCONTROLS,FORMATCONTROLS,STYLECONTROLS,COLORCONTROLS].- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setBulletControls
Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setBulletControls(ControlName... bulletControls)- Throws:
IllegalStateException
-
setColorControls
Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setColorControls(ControlName... colorControls)- Throws:
IllegalStateException
-
setFontControls
Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setFontControls(ControlName... fontControls)- Throws:
IllegalStateException
-
setFormatControls
Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setFormatControls(ControlName... formatControls)- Throws:
IllegalStateException
-
setStyleControls
Use this signature if you plan to pass a mixture of standard ControlNames and custom widgets (any subclass of Canvas is allowed):setStyleControls(ControlName... styleControls)- Throws:
IllegalStateException
-
getFontNames
ValueMap of CSS fontName properties to font name titles to display in the font selector for theFONTSELECTORcontrol.- Returns:
- the current fontNames valueMap
-
setFontNames
ValueMap of CSS fontName properties to font name titles to display in the font selector for theFONTSELECTORcontrol.- Parameters:
fontNames- the new ValueMap- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getFontSizes
ValueMap of CSS font size property values to font size titles to display in the font size selector for theFONTSIZESELECTORcontrol.- Returns:
- the current fontNames valueMap
-
setFontSizes
ValueMap of CSS font size property values to font size titles to display in the font size selector for theFONTSIZESELECTORcontrol.- Parameters:
fontSizes- the new ValueMap- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classVLayout
-