Class CmsSelectWidget
- 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.acacia.client.widgets.CmsSelectWidget
-
- All Implemented Interfaces:
com.google.gwt.event.dom.client.HasFocusHandlers
,com.google.gwt.event.logical.shared.HasAttachHandlers
,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.TakesValue<java.lang.String>
,com.google.gwt.user.client.ui.HasValue<java.lang.String>
,com.google.gwt.user.client.ui.HasVisibility
,com.google.gwt.user.client.ui.IsRenderable
,com.google.gwt.user.client.ui.IsWidget
,I_CmsEditWidget
,I_CmsHasDisplayDirection
public class CmsSelectWidget extends com.google.gwt.user.client.ui.Composite implements I_CmsEditWidget, I_CmsHasDisplayDirection
An option of a select type widget.Regarding widget configuration, see
.CmsSelectConfigurationParser
-
-
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.acacia.client.widgets.I_CmsHasDisplayDirection
I_CmsHasDisplayDirection.Direction
-
-
Field Summary
Fields Modifier and Type Field Description protected CmsSelectBox
m_selectBox
The global select box.
-
Constructor Summary
Constructors Constructor Description CmsSelectWidget(java.lang.String config, boolean allowUnknown)
Constructs an CmsComboWidget with the in XSD schema declared configuration.
-
Method Summary
All 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
addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
void
fireChangeEvent()
Represents a value change event.I_CmsHasDisplayDirection.Direction
getDisplayingDirection()
Returns the display direction.java.lang.String
getValue()
boolean
isActive()
Returns if the widget is active.void
onAttachWidget()
This method is called when a widget is attached to the browser's document.boolean
owns(com.google.gwt.dom.client.Element element)
Returns true if the element should be logically counted as part of the widget for the purpose of determining whether a mouse click is "outside".void
setActive(boolean active)
Sets the widget active/inactive.void
setName(java.lang.String name)
Sets the name of input fields.void
setValue(java.lang.String value)
void
setValue(java.lang.String value, boolean fireEvents)
boolean
shouldSetDefaultWhenDisabled()
If this returns true, the default value will also be set as the widget value if the widget is inactive (i.e.-
Methods inherited from class com.google.gwt.user.client.ui.Composite
claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, 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 Detail
-
m_selectBox
protected CmsSelectBox m_selectBox
The global select box.
-
-
Constructor Detail
-
CmsSelectWidget
public CmsSelectWidget(java.lang.String config, boolean allowUnknown)
Constructs an CmsComboWidget with the in XSD schema declared configuration.- Parameters:
config
- The configuration string given from OpenCms XSD.
-
-
Method Detail
-
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)
-
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>
- Specified by:
addValueChangeHandler
in interfaceI_CmsEditWidget
- See Also:
HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
-
fireChangeEvent
public void fireChangeEvent()
Represents a value change event.
-
getDisplayingDirection
public I_CmsHasDisplayDirection.Direction getDisplayingDirection()
Description copied from interface:I_CmsHasDisplayDirection
Returns the display direction.- Specified by:
getDisplayingDirection
in interfaceI_CmsHasDisplayDirection
- Returns:
- the display direction
- See Also:
I_CmsHasDisplayDirection.getDisplayingDirection()
-
getValue
public java.lang.String getValue()
- Specified by:
getValue
in interfacecom.google.gwt.user.client.ui.HasValue<java.lang.String>
- Specified by:
getValue
in interfacecom.google.gwt.user.client.TakesValue<java.lang.String>
- See Also:
HasValue.getValue()
-
isActive
public boolean isActive()
Description copied from interface:I_CmsEditWidget
Returns if the widget is active.- Specified by:
isActive
in interfaceI_CmsEditWidget
- Returns:
true
if the widget is active- See Also:
I_CmsEditWidget.isActive()
-
onAttachWidget
public void onAttachWidget()
Description copied from interface:I_CmsEditWidget
This method is called when a widget is attached to the browser's document.It needs to call the
Widget.onAttach()
method.- Specified by:
onAttachWidget
in interfaceI_CmsEditWidget
- See Also:
I_CmsEditWidget.onAttachWidget()
-
owns
public boolean owns(com.google.gwt.dom.client.Element element)
Description copied from interface:I_CmsEditWidget
Returns true if the element should be logically counted as part of the widget for the purpose of determining whether a mouse click is "outside". For example, this is needed if the widget uses a popup.- Specified by:
owns
in interfaceI_CmsEditWidget
- Parameters:
element
- the element to check- Returns:
- true if the element counts as part of the widget
- See Also:
I_CmsEditWidget.owns(com.google.gwt.dom.client.Element)
-
setActive
public void setActive(boolean active)
Description copied from interface:I_CmsEditWidget
Sets the widget active/inactive.- Specified by:
setActive
in interfaceI_CmsEditWidget
- Parameters:
active
-true
to activate the widget- See Also:
I_CmsEditWidget.setActive(boolean)
-
setName
public void setName(java.lang.String name)
Description copied from interface:I_CmsEditWidget
Sets the name of input fields.- Specified by:
setName
in interfaceI_CmsEditWidget
- Parameters:
name
- of the input field- See Also:
I_CmsEditWidget.setName(java.lang.String)
-
setValue
public void setValue(java.lang.String value)
- Specified by:
setValue
in interfacecom.google.gwt.user.client.ui.HasValue<java.lang.String>
- Specified by:
setValue
in interfacecom.google.gwt.user.client.TakesValue<java.lang.String>
- See Also:
HasValue.setValue(java.lang.Object)
-
setValue
public void setValue(java.lang.String value, boolean fireEvents)
- Specified by:
setValue
in interfacecom.google.gwt.user.client.ui.HasValue<java.lang.String>
- Specified by:
setValue
in interfaceI_CmsEditWidget
- See Also:
HasValue.setValue(java.lang.Object, boolean)
-
shouldSetDefaultWhenDisabled
public boolean shouldSetDefaultWhenDisabled()
Description copied from interface:I_CmsEditWidget
If this returns true, the default value will also be set as the widget value if the widget is inactive (i.e. for optional values which don't exist yet).- Specified by:
shouldSetDefaultWhenDisabled
in interfaceI_CmsEditWidget
- Returns:
- true if the default value should be set even if the widget is inactive
- See Also:
I_CmsEditWidget.shouldSetDefaultWhenDisabled()
-
-