Package org.opencms.gwt.client.ui.input
Class CmsVfsSelection
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.CmsVfsSelection
- All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers,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.ui.HasVisibility,com.google.gwt.user.client.ui.IsRenderable,com.google.gwt.user.client.ui.IsWidget,I_CmsFormWidget
public class CmsVfsSelection
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>
Basic gallery widget for forms.
- Since:
- 8.0.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classEvent preview handler.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 TypeFieldDescriptionstatic final StringThe download mode of this widget.static final StringThe download link mode of this widget.static final StringThe file link mode of this widget.static final StringThe image link mode of this widget.static final StringThe link mode of this widget.protected StringThe old value.protected CmsFramePopupThe popup frame.protected com.google.gwt.event.shared.HandlerRegistrationThe handler registration.Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
ConstructorsConstructorDescriptionCmsVfsSelection(String iconImage, String type, String config) VsfSelection widget to open the gallery selection. -
Method Summary
Modifier and TypeMethodDescriptioncom.google.gwt.event.shared.HandlerRegistrationaddValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler) protected StringCreates the URL for the gallery dialog IFrame.protected voidclose()Close the popup of this widget.Returns the "apparent value", i.e.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.org.opencms.gwt.shared.CmsLinkBeanReturns the selected link as a bean.getText()Returns the text contained in the text area.Returns the text box container of this widget.booleanReturnstrueif this widget is enabled.protected voidopen()Opens the popup of this widget.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.voidsetLinkBean(org.opencms.gwt.shared.CmsLinkBean link) Sets the link from a bean.voidSets the name of the input field.voidSets the text in the text area.voidMethods 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, 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
fireEvent
-
Field Details
-
DOWNLOAD
The download mode of this widget.- See Also:
-
DOWNLOAD_LINK
The download link mode of this widget.- See Also:
-
FILE_LINK
The file link mode of this widget.- See Also:
-
IMAGE_LINK
The image link mode of this widget.- See Also:
-
LINK
The link mode of this widget.- See Also:
-
m_oldValue
The old value. -
m_popup
The popup frame. -
m_previewHandlerRegistration
The handler registration.
-
-
Constructor Details
-
CmsVfsSelection
VsfSelection widget to open the gallery selection.- Parameters:
iconImage- the image of the icon shown in thetype- the type of this widgetconfig- the configuration for this widget
-
-
Method Details
-
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:
-
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:
-
getLinkBean
Returns the selected link as a bean.- Returns:
- the selected link as a bean
-
getText
Returns the text contained in the text area.- Returns:
- the text in the text area
-
getTextAreaContainer
Returns the text box container of this widget.- Returns:
- the text box container
-
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
-
setTitle
- Overrides:
setTitlein classcom.google.gwt.user.client.ui.UIObject- See Also:
-
buildGalleryUrl
Creates the URL for the gallery dialog IFrame.- Returns:
- the URL for the gallery dialog IFrame
-
close
Close the popup of this widget. -
open
Opens the popup of this widget.