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<java.lang.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<java.lang.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
-
-
Constructor Summary
Constructors Constructor Description CmsTextArea()
Text area widgets for ADE forms.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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<java.lang.String> handler)
java.lang.String
getApparentValue()
Returns the "apparent value", i.e.I_CmsFormWidget.FieldType
getFieldType()
Returns the type of data this widget produces.java.lang.Object
getFormValue()
Gets the selected/entered value from the widget.java.lang.String
getFormValueAsString()
Gets the current value of the widget as a string.java.lang.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()
Returnstrue
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(java.lang.String errorMessage)
Sets the error message for this widget.void
setFocus(boolean b)
Sets or removes focus.void
setFormValue(java.lang.Object value)
Sets the value of the widget.void
setFormValueAsString(java.lang.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(java.lang.String value, boolean ghostMode)
Sets the "ghost value" of the widget and optionally sets it to "ghost mode".void
setName(java.lang.String name)
Sets the name of the input field.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(java.lang.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
-
-
-
-
Constructor Detail
-
CmsTextArea
public CmsTextArea()
Text area widgets for ADE forms.
-
-
Method Detail
-
initClass
public static void initClass()
Initializes this class.
-
addFocusHandler
public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
- Specified by:
addFocusHandler
in interfacecom.google.gwt.event.dom.client.HasFocusHandlers
- See Also:
HasFocusHandlers.addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)
-
addResizeHandler
public com.google.gwt.event.shared.HandlerRegistration addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler handler)
- Specified by:
addResizeHandler
in interfacecom.google.gwt.event.logical.shared.HasResizeHandlers
- See Also:
HasResizeHandlers.addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler)
-
addValueChangeHandler
public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
- Specified by:
addValueChangeHandler
in interfacecom.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>
- See Also:
HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
-
getApparentValue
public java.lang.String getApparentValue()
Description copied from interface:I_CmsFormWidget
Returns the "apparent value", i.e. either the real value if available, or else the ghost value if available, or null otherwise.- Specified by:
getApparentValue
in interfaceI_CmsFormWidget
- Returns:
- the apparent value
- See Also:
I_CmsFormWidget.getApparentValue()
-
getFieldType
public I_CmsFormWidget.FieldType getFieldType()
Description copied from interface:I_CmsFormWidget
Returns the type of data this widget produces.- Specified by:
getFieldType
in interfaceI_CmsFormWidget
- Returns:
- the data type
- See Also:
I_CmsFormWidget.getFieldType()
-
getFormValue
public java.lang.Object getFormValue()
Description copied from interface:I_CmsFormWidget
Gets the selected/entered value from the widget.- Specified by:
getFormValue
in interfaceI_CmsFormWidget
- Returns:
- the value
- See Also:
I_CmsFormWidget.getFormValue()
-
getFormValueAsString
public java.lang.String getFormValueAsString()
Description copied from interface:I_CmsFormWidget
Gets the current value of the widget as a string.- Specified by:
getFormValueAsString
in interfaceI_CmsFormWidget
- Returns:
- the current value of the widget
- See Also:
I_CmsFormWidget.getFormValueAsString()
-
getText
public java.lang.String getText()
Returns the text contained in the text area.- Returns:
- the text in the text area
-
getTextArea
public com.google.gwt.user.client.ui.TextArea getTextArea()
Returns the textarea of this widget.- Returns:
- the textarea
-
getTextAreaContainer
public CmsScrollPanel getTextAreaContainer()
Returns the text area container of this widget.- Returns:
- the text area container
-
isEnabled
public boolean isEnabled()
Description copied from interface:I_CmsFormWidget
Returnstrue
if this widget is enabled.- Specified by:
isEnabled
in interfaceI_CmsFormWidget
- Returns:
true
if this widget is enabled- See Also:
I_CmsFormWidget.isEnabled()
-
reset
public void reset()
Description copied from interface:I_CmsFormWidget
Resets the widget to its default state.- Specified by:
reset
in interfaceI_CmsFormWidget
- See Also:
I_CmsFormWidget.reset()
-
resizeOnShow
public void resizeOnShow()
Description copied from interface:I_CmsHasResizeOnShow
Adjusts widget's size once it's visible.- Specified by:
resizeOnShow
in interfaceI_CmsHasResizeOnShow
- See Also:
I_CmsHasResizeOnShow.resizeOnShow()
-
selectAll
public void selectAll()
Selects all content.
-
setAutoHideParent
public void setAutoHideParent(I_CmsAutoHider autoHideParent)
Description copied from interface:I_CmsFormWidget
Call this when auto hiding parents are shown.- Specified by:
setAutoHideParent
in interfaceI_CmsFormWidget
- Parameters:
autoHideParent
- the auto hide parent- See Also:
I_CmsFormWidget.setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)
-
setEnabled
public void setEnabled(boolean enabled)
Description copied from interface:I_CmsFormWidget
Enables or disables the widget.- Specified by:
setEnabled
in interfaceI_CmsFormWidget
- Parameters:
enabled
- if true, the widget will be enabled, else disabled- See Also:
I_CmsFormWidget.setEnabled(boolean)
-
setErrorMessage
public void setErrorMessage(java.lang.String errorMessage)
Description copied from interface:I_CmsFormWidget
Sets the error message for this widget.If the error message is null, no error message will be displayed.
- Specified by:
setErrorMessage
in interfaceI_CmsFormWidget
- Parameters:
errorMessage
- an error message or null- See Also:
I_CmsFormWidget.setErrorMessage(java.lang.String)
-
setFocus
public void setFocus(boolean b)
Sets or removes focus.- Parameters:
b
- true if the text area should be focused
-
setFormValue
public void setFormValue(java.lang.Object value)
Sets the value of the widget.- Parameters:
value
- the new value
-
setFormValueAsString
public void setFormValueAsString(java.lang.String newValue)
Description copied from interface:I_CmsFormWidget
Sets the current value of the widget as a string.- Specified by:
setFormValueAsString
in interfaceI_CmsFormWidget
- Parameters:
newValue
- the new value of the widget- See Also:
I_CmsFormWidget.setFormValueAsString(java.lang.String)
-
setGhostMode
public void setGhostMode(boolean ghostMode)
Not used.This widget automatically decides whether it's in ghost mode depending on the real value and ghost value set.
- Specified by:
setGhostMode
in interfaceI_CmsHasGhostValue
- Parameters:
ghostMode
- not used
-
setGhostStyleEnabled
public void setGhostStyleEnabled(boolean enabled)
Enables or disables the 'ghost mode' style.- Parameters:
enabled
- true if 'ghost mode' style should be enabled
-
setGhostValue
public void setGhostValue(java.lang.String value, boolean ghostMode)
Description copied from interface:I_CmsHasGhostValue
Sets the "ghost value" of the widget and optionally sets it to "ghost mode"."Ghost mode" can be used to show the user the value (called "ghost value") which will be used if he either doesn't choose an option in the widget, or explicitly chooses an "empty" or "default" option.
- Specified by:
setGhostValue
in interfaceI_CmsHasGhostValue
- Parameters:
value
- the ghost valueghostMode
- if true, sets the widget to ghost mode- See Also:
I_CmsHasGhostValue.setGhostValue(java.lang.String, boolean)
-
setName
public void setName(java.lang.String name)
Sets the name of the input field.- Parameters:
name
- of the input field
-
setProportionalStyle
public void setProportionalStyle(boolean proportional)
Sets the text area to use a proportional font.- Parameters:
proportional
-true
to use a proportional font
-
setRows
public void setRows(int rows)
Sets the height of this textarea.- Parameters:
rows
- the value of rows should be shown
-
setRowsGallery
public void setRowsGallery(int rows)
Sets the height of this textarea. Especial for the image Gallery.- Parameters:
rows
- the value of rows should be shown
-
setText
public void setText(java.lang.String text)
Sets the text in the text area.- Parameters:
text
- the new text
-
onAttach
protected void onAttach()
- Overrides:
onAttach
in classcom.google.gwt.user.client.ui.Composite
- See Also:
Composite.onAttach()
-
scheduleResize
protected void scheduleResize()
Schedules resizing the widget.
-
showFadePanelIfNeeded
protected void showFadePanelIfNeeded()
Shows the fade panel if the text area content exceeds the visible area.
-
updateContentSize
protected void updateContentSize()
Updates the text area height according to the current text content.
-
-