Package org.opencms.gwt.client.ui.input
Class CmsColorPicker
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.CmsColorPicker
- All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers
,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_CmsFormWidget
public class CmsColorPicker
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasInit
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
FieldsModifier and TypeFieldDescriptionprotected com.google.gwt.user.client.ui.SimplePanel
The field to display the color.protected String
The color value.protected CmsPopup
The popup to choose the color.protected com.google.gwt.user.client.ui.TextBox
The internal textbox used by this widget to display the color value.protected com.google.gwt.user.client.ui.SimplePanel
The field to display the value.protected int
The x-coords of the popup.protected int
The y-coords of the popup.Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addValueChangeHandler
(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler) Adds a value change handler to the textbox.protected boolean
checkvalue
(String colorvalue) Validates the inputed color value.protected void
Close the popup and store the color value in the colorvalue field.protected void
Close the popup and store the old color value in the colorvalue field.protected String
convertToHex
(int i) Converts the integer value to an hex value.Returns the "apparent value", i.e.com.google.gwt.user.client.ui.SimplePanel
Returns the colorfield.com.google.gwt.user.client.ui.TextBox
Returns the color value textbox.Returns the type of data this widget produces.Gets the selected/entered value from the widget.Gets the current value of the widget as a string.getText()
Returns the text contained in the text area.com.google.gwt.user.client.ui.SimplePanel
Returns the color value textboxpanel.static void
Initializes this class.boolean
Returnstrue
if this widget is enabled.protected void
onAttach()
protected void
Helper function to open the popup.void
reset()
Resets the widget to its default state.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
setFormValue
(Object value) Sets the value of the widget.void
setFormValueAsString
(String newValue) Sets the current value of the widget as a string.void
Sets the name of the input field.void
Sets the text in the text area.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
-
Field Details
-
m_colorField
The field to display the color. -
m_colorValue
The color value. -
m_popup
The popup to choose the color. -
m_textboxpanel
The field to display the value. -
m_xcoordspopup
The x-coords of the popup. -
m_ycoordspopup
The y-coords of the popup. -
m_textboxColorValue
The internal textbox used by this widget to display the color value.
-
-
Constructor Details
-
CmsColorPicker
public CmsColorPicker()Text area widgets for ADE forms.
-
-
Method Details
-
initClass
Initializes this class. -
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:
-
getColorfield
Returns the colorfield.- Returns:
- the colorfield
-
getColorValueBox
Returns the color value textbox.- Returns:
- the color value textbox
-
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:
-
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:
-
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:
-
getText
Returns the text contained in the text area.- Returns:
- the text in the text area
-
getTextboxPanel
Returns the color value textboxpanel.- Returns:
- the color value textboxpanel
-
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:
-
reset
Description copied from interface:I_CmsFormWidget
Resets the widget to its default state.- Specified by:
reset
in interfaceI_CmsFormWidget
- See Also:
-
setAutoHideParent
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:
-
setEnabled
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:
-
setErrorMessage
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:
-
setFormValue
Sets the value of the widget.- Parameters:
value
- the new value
-
setFormValueAsString
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:
-
setName
Sets the name of the input field.- Parameters:
name
- of the input field
-
setText
Sets the text in the text area.- Parameters:
text
- the new text
-
checkvalue
Validates the inputed color value.- Parameters:
colorvalue
- the value of the color- Returns:
- true if the inputed color value is valid
-
closePopup
Close the popup and store the color value in the colorvalue field. -
closePopupDefault
Close the popup and store the old color value in the colorvalue field. -
convertToHex
Converts the integer value to an hex value.- Parameters:
i
- the integer value- Returns:
- the hex string
-
onAttach
- Overrides:
onAttach
in classcom.google.gwt.user.client.ui.Composite
- See Also:
-
Composite.onAttach()
-
openPopup
Helper function to open the popup.
-