Package org.opencms.gwt.client.ui.input

Class CmsTextArea

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Composite
org.opencms.gwt.client.ui.input.CmsTextArea
All Implemented Interfaces:
com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasResizeHandlers, 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.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, I_CmsHasInit, I_CmsHasResizeOnShow, I_CmsFormWidget, I_CmsHasGhostValue
public class CmsTextArea extends com.google.gwt.user.client.ui.Composite implements I_CmsFormWidget, I_CmsHasInit, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.logical.shared.HasResizeHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, I_CmsHasResizeOnShow, I_CmsHasGhostValue
Basic text area widget for forms.

Since:
8.0.0

  • Nested Class Summary

    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 org.opencms.gwt.client.ui.input.I_CmsFormWidget

    I_CmsFormWidget.FieldType

  • Field Summary

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

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsTextArea()
    Text area widgets for ADE forms.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.gwt.event.shared.HandlerRegistration
    addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
     
    com.google.gwt.event.shared.HandlerRegistration
    addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler handler)
     
    com.google.gwt.event.shared.HandlerRegistration
    addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
     
    String
    getApparentValue()
    Returns the "apparent value", i.e.
    I_CmsFormWidget.FieldType
    getFieldType()
    Returns the type of data this widget produces.
    Object
    getFormValue()
    Gets the selected/entered value from the widget.
    String
    getFormValueAsString()
    Gets the current value of the widget as a string.
    int
    getPosition()
    Gets the cursor position.
    String
    getText()
    Returns the text contained in the text area.
    com.google.gwt.user.client.ui.TextArea
    getTextArea()
    Returns the textarea of this widget.
    CmsScrollPanel
    getTextAreaContainer()
    Returns the text area container of this widget.
    static void
    initClass()
    Initializes this class.
    boolean
    isEnabled()
    Returns true if this widget is enabled.
    protected void
    onAttach()
     
    void
    reset()
    Resets the widget to its default state.
    void
    resizeOnShow()
    Adjusts widget's size once it's visible.
    protected void
    scheduleResize()
    Schedules resizing the widget.
    void
    selectAll()
    Selects all content.
    void
    setAutoHideParent(I_CmsAutoHider autoHideParent)
    Call this when auto hiding parents are shown.
    void
    setEnabled(boolean enabled)
    Enables or disables the widget.
    void
    setErrorMessage(String errorMessage)
    Sets the error message for this widget.
    void
    setFocus(boolean b)
    Sets or removes focus.
    void
    setFormValue(Object value)
    Sets the value of the widget.
    void
    setFormValueAsString(String newValue)
    Sets the current value of the widget as a string.
    void
    setGhostMode(boolean ghostMode)
    Not used.
    void
    setGhostStyleEnabled(boolean enabled)
    Enables or disables the 'ghost mode' style.
    void
    setGhostValue(String value, boolean ghostMode)
    Sets the "ghost value" of the widget and optionally sets it to "ghost mode".
    void
    setName(String name)
    Sets the name of the input field.
    void
    setPosition(int position)
    Sets the cursor position.
    void
    setProportionalStyle(boolean proportional)
    Sets the text area to use a proportional font.
    void
    setRows(int rows)
    Sets the height of this textarea.
    void
    setRowsGallery(int rows)
    Sets the height of this textarea.
    void
    setText(String text)
    Sets the text in the text area.
    protected void
    showFadePanelIfNeeded()
    Shows the fade panel if the text area content exceeds the visible area.
    protected void
    updateContentSize()
    Updates the text area height according to the current text content.

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

    claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

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

    addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, 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, 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.shared.HasHandlers

    fireEvent