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
Modifier and TypeClassDescriptionprotected class
Event 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.DebugIdImplEnabled
Nested classes/interfaces inherited from interface org.opencms.gwt.client.ui.input.I_CmsFormWidget
I_CmsFormWidget.FieldType
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The download mode of this widget.static final String
The download link mode of this widget.static final String
The file link mode of this widget.static final String
The image link mode of this widget.static final String
The link mode of this widget.protected String
The old value.protected CmsFramePopup
The popup frame.protected com.google.gwt.event.shared.HandlerRegistration
The handler registration.Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
-
Constructor Summary
ConstructorDescriptionCmsVfsSelection
(String iconImage, String type, String config) VsfSelection widget to open the gallery selection. -
Method Summary
Modifier and TypeMethodDescriptioncom.google.gwt.event.shared.HandlerRegistration
addValueChangeHandler
(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler) protected String
Creates the URL for the gallery dialog IFrame.protected void
close()
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.CmsLinkBean
Returns the selected link as a bean.getText()
Returns the text contained in the text area.Returns the text box container of this widget.boolean
Returnstrue
if this widget is enabled.protected void
open()
Opens the popup of this widget.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
setLinkBean
(org.opencms.gwt.shared.CmsLinkBean link) Sets the link from a bean.void
Sets the name of the input field.void
Sets the text in the text area.void
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, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods 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_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:
-
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:
-
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_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
-
setTitle
- Overrides:
setTitle
in classcom.google.gwt.user.client.ui.UIObject
- See Also:
-
UIObject.setTitle(java.lang.String)
-
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.