Class CmsFormWidgetWrapper
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.CmsFormWidgetWrapper
- 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.TakesValue<String>,com.google.gwt.user.client.ui.HasValue<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_CmsFormEditWidget,I_CmsHasDisplayDirection,I_CmsHasResizeOnShow
public class CmsFormWidgetWrapper
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormEditWidget, com.google.gwt.event.logical.shared.HasResizeHandlers, I_CmsHasResizeOnShow, I_CmsHasDisplayDirection
Wraps an edit widget to supply a widget label.
-
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.acacia.client.widgets.I_CmsHasDisplayDirection
I_CmsHasDisplayDirection.Direction -
Field Summary
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.google.gwt.event.shared.HandlerRegistrationaddFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler) com.google.gwt.event.shared.HandlerRegistrationaddResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler handler) com.google.gwt.event.shared.HandlerRegistrationaddValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler) Returns the display direction.Gets the wrapped widget.com.google.gwt.user.client.ui.LabelgetLabel()Returns the label widget.getValue()booleanisActive()Returns if the widget is active.voidThis method is called when a widget is attached to the browser's document.booleanowns(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".voidAdjusts widget's size once it's visible.voidsetActive(boolean active) Sets the widget active/inactive.voidsetEditWidget(I_CmsEditWidget editWidget) The edit widget needs to set, before the widget may be used.voidSets the name of input fields.voidvoidvoidsetWidgetInfo(String label, String help) Sets the widget label and help text.booleanIf 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, 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, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEventMethods inherited from interface com.google.gwt.user.client.ui.IsWidget
asWidget
-
Constructor Details
-
CmsFormWidgetWrapper
public CmsFormWidgetWrapper()Constructor. -
CmsFormWidgetWrapper
Constructor.- Parameters:
editWidget- the edit widget to wrap
-
-
Method Details
-
addFocusHandler
public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler) - Specified by:
addFocusHandlerin interfacecom.google.gwt.event.dom.client.HasFocusHandlers- See Also:
-
getDisplayingDirection
Description copied from interface:I_CmsHasDisplayDirectionReturns the display direction.- Specified by:
getDisplayingDirectionin interfaceI_CmsHasDisplayDirection- Returns:
- the display direction
- See Also:
-
getEditWidget
Gets the wrapped widget.- Returns:
- the wrapped widget
-
getLabel
Returns the label widget.- Returns:
- the label widget
-
getValue
-
isActive
Description copied from interface:I_CmsEditWidgetReturns if the widget is active.- Specified by:
isActivein interfaceI_CmsEditWidget- Returns:
trueif the widget is active- See Also:
-
onAttachWidget
Description copied from interface:I_CmsEditWidgetThis method is called when a widget is attached to the browser's document.It needs to call the
Widget.onAttach()method.- Specified by:
onAttachWidgetin interfaceI_CmsEditWidget- See Also:
-
owns
Description copied from interface:I_CmsEditWidgetReturns 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:
ownsin interfaceI_CmsEditWidget- Parameters:
element- the element to check- Returns:
- true if the element counts as part of the widget
- See Also:
-
resizeOnShow
Description copied from interface:I_CmsHasResizeOnShowAdjusts widget's size once it's visible.- Specified by:
resizeOnShowin interfaceI_CmsHasResizeOnShow- See Also:
-
setActive
Description copied from interface:I_CmsEditWidgetSets the widget active/inactive.- Specified by:
setActivein interfaceI_CmsEditWidget- Parameters:
active-trueto activate the widget- See Also:
-
setEditWidget
The edit widget needs to set, before the widget may be used.- Parameters:
editWidget- the edit widget to wrap
-
setName
Description copied from interface:I_CmsEditWidgetSets the name of input fields.- Specified by:
setNamein interfaceI_CmsEditWidget- Parameters:
name- of the input field- See Also:
-
setValue
-
setValue
- Specified by:
setValuein interfacecom.google.gwt.user.client.ui.HasValue<String>- Specified by:
setValuein interfaceI_CmsEditWidget- See Also:
-
setWidgetInfo
Description copied from interface:I_CmsFormEditWidgetSets the widget label and help text.- Specified by:
setWidgetInfoin interfaceI_CmsFormEditWidget- Parameters:
label- the widget label texthelp- the widget help text- See Also:
-
shouldSetDefaultWhenDisabled
Description copied from interface:I_CmsEditWidgetIf 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:
shouldSetDefaultWhenDisabledin interfaceI_CmsEditWidget- Returns:
- true if the default value should be set even if the widget is inactive
- See Also:
-