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.DebugIdImplEnabledNested 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.SimplePanelThe field to display the color.protected StringThe color value.protected CmsPopupThe popup to choose the color.protected com.google.gwt.user.client.ui.TextBoxThe internal textbox used by this widget to display the color value.protected com.google.gwt.user.client.ui.SimplePanelThe field to display the value.protected intThe x-coords of the popup.protected intThe 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 TypeMethodDescriptionvoidaddValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler) Adds a value change handler to the textbox.protected booleancheckvalue(String colorvalue) Validates the inputed color value.protected voidClose the popup and store the color value in the colorvalue field.protected voidClose the popup and store the old color value in the colorvalue field.protected StringconvertToHex(int i) Converts the integer value to an hex value.Returns the "apparent value", i.e.com.google.gwt.user.client.ui.SimplePanelReturns the colorfield.com.google.gwt.user.client.ui.TextBoxReturns 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.SimplePanelReturns the color value textboxpanel.static voidInitializes this class.booleanReturnstrueif this widget is enabled.protected voidonAttach()protected voidHelper function to open the popup.voidreset()Resets the widget to its default state.voidsetAutoHideParent(I_CmsAutoHider autoHideParent) Call this when auto hiding parents are shown.voidsetEnabled(boolean enabled) Enables or disables the widget.voidsetErrorMessage(String errorMessage) Sets the error message for this widget.voidsetFormValue(Object value) Sets the value of the widget.voidsetFormValueAsString(String newValue) Sets the current value of the widget as a string.voidSets the name of the input field.voidSets 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, setWidgetMethods 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, unsinkEventsMethods 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_CmsFormWidgetReturns the "apparent value", i.e. either the real value if available, or else the ghost value if available, or null otherwise.- Specified by:
getApparentValuein 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_CmsFormWidgetReturns the type of data this widget produces.- Specified by:
getFieldTypein interfaceI_CmsFormWidget- Returns:
- the data type
- See Also:
-
getFormValue
Description copied from interface:I_CmsFormWidgetGets the selected/entered value from the widget.- Specified by:
getFormValuein interfaceI_CmsFormWidget- Returns:
- the value
- See Also:
-
getFormValueAsString
Description copied from interface:I_CmsFormWidgetGets the current value of the widget as a string.- Specified by:
getFormValueAsStringin 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_CmsFormWidgetReturnstrueif this widget is enabled.- Specified by:
isEnabledin interfaceI_CmsFormWidget- Returns:
trueif this widget is enabled- See Also:
-
reset
Description copied from interface:I_CmsFormWidgetResets the widget to its default state.- Specified by:
resetin interfaceI_CmsFormWidget- See Also:
-
setAutoHideParent
Description copied from interface:I_CmsFormWidgetCall this when auto hiding parents are shown.- Specified by:
setAutoHideParentin interfaceI_CmsFormWidget- Parameters:
autoHideParent- the auto hide parent- See Also:
-
setEnabled
Description copied from interface:I_CmsFormWidgetEnables or disables the widget.- Specified by:
setEnabledin interfaceI_CmsFormWidget- Parameters:
enabled- if true, the widget will be enabled, else disabled- See Also:
-
setErrorMessage
Description copied from interface:I_CmsFormWidgetSets the error message for this widget.If the error message is null, no error message will be displayed.
- Specified by:
setErrorMessagein 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_CmsFormWidgetSets the current value of the widget as a string.- Specified by:
setFormValueAsStringin 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:
onAttachin classcom.google.gwt.user.client.ui.Composite- See Also:
-
openPopup
Helper function to open the popup.
-