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<java.lang.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<java.lang.String>
Basic gallery widget for forms.- Since:
- 8.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
CmsVfsSelection.CloseEventPreviewHandler
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
Fields Modifier and Type Field Description static java.lang.String
DOWNLOAD
The download mode of this widget.static java.lang.String
DOWNLOAD_LINK
The download link mode of this widget.static java.lang.String
FILE_LINK
The file link mode of this widget.static java.lang.String
IMAGE_LINK
The image link mode of this widget.static java.lang.String
LINK
The link mode of this widget.protected java.lang.String
m_oldValue
The old value.protected CmsFramePopup
m_popup
The popup frame.protected com.google.gwt.event.shared.HandlerRegistration
m_previewHandlerRegistration
The handler registration.
-
Constructor Summary
Constructors Constructor Description CmsVfsSelection(java.lang.String iconImage, java.lang.String type, java.lang.String config)
VsfSelection widget to open the gallery selection.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.gwt.event.shared.HandlerRegistration
addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
protected java.lang.String
buildGalleryUrl()
Creates the URL for the gallery dialog IFrame.protected void
close()
Close the popup of this widget.java.lang.String
getApparentValue()
Returns the "apparent value", i.e.I_CmsFormWidget.FieldType
getFieldType()
Returns the type of data this widget produces.java.lang.Object
getFormValue()
Gets the selected/entered value from the widget.java.lang.String
getFormValueAsString()
Gets the current value of the widget as a string.org.opencms.gwt.shared.CmsLinkBean
getLinkBean()
Returns the selected link as a bean.java.lang.String
getText()
Returns the text contained in the text area.CmsSelectionInput
getTextAreaContainer()
Returns the text box container of this widget.boolean
isEnabled()
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(java.lang.String errorMessage)
Sets the error message for this widget.void
setFormValue(java.lang.Object value)
Sets the value of the widget.void
setFormValueAsString(java.lang.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
setName(java.lang.String name)
Sets the name of the input field.void
setText(java.lang.String text)
Sets the text in the text area.void
setTitle(java.lang.String title)
-
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
-
-
-
-
Field Detail
-
DOWNLOAD
public static final java.lang.String DOWNLOAD
The download mode of this widget.- See Also:
- Constant Field Values
-
DOWNLOAD_LINK
public static final java.lang.String DOWNLOAD_LINK
The download link mode of this widget.- See Also:
- Constant Field Values
-
FILE_LINK
public static final java.lang.String FILE_LINK
The file link mode of this widget.- See Also:
- Constant Field Values
-
IMAGE_LINK
public static final java.lang.String IMAGE_LINK
The image link mode of this widget.- See Also:
- Constant Field Values
-
LINK
public static final java.lang.String LINK
The link mode of this widget.- See Also:
- Constant Field Values
-
m_oldValue
protected java.lang.String m_oldValue
The old value.
-
m_popup
protected CmsFramePopup m_popup
The popup frame.
-
m_previewHandlerRegistration
protected com.google.gwt.event.shared.HandlerRegistration m_previewHandlerRegistration
The handler registration.
-
-
Constructor Detail
-
CmsVfsSelection
public CmsVfsSelection(java.lang.String iconImage, java.lang.String type, java.lang.String config)
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 Detail
-
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>
- See Also:
HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
-
getApparentValue
public java.lang.String 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:
I_CmsFormWidget.getApparentValue()
-
getFieldType
public I_CmsFormWidget.FieldType 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:
I_CmsFormWidget.getFieldType()
-
getFormValue
public java.lang.Object 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:
I_CmsFormWidget.getFormValue()
-
getFormValueAsString
public java.lang.String 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:
I_CmsFormWidget.getFormValueAsString()
-
getLinkBean
public org.opencms.gwt.shared.CmsLinkBean getLinkBean()
Returns the selected link as a bean.- Returns:
- the selected link as a bean
-
getText
public java.lang.String getText()
Returns the text contained in the text area.- Returns:
- the text in the text area
-
getTextAreaContainer
public CmsSelectionInput getTextAreaContainer()
Returns the text box container of this widget.- Returns:
- the text box container
-
isEnabled
public boolean 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:
I_CmsFormWidget.isEnabled()
-
reset
public void reset()
Description copied from interface:I_CmsFormWidget
Resets the widget to its default state.- Specified by:
reset
in interfaceI_CmsFormWidget
- See Also:
I_CmsFormWidget.reset()
-
setAutoHideParent
public void setAutoHideParent(I_CmsAutoHider autoHideParent)
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:
I_CmsFormWidget.setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)
-
setEnabled
public void setEnabled(boolean enabled)
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:
I_CmsFormWidget.setEnabled(boolean)
-
setErrorMessage
public void setErrorMessage(java.lang.String errorMessage)
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:
I_CmsFormWidget.setErrorMessage(java.lang.String)
-
setFormValue
public void setFormValue(java.lang.Object value)
Sets the value of the widget.- Parameters:
value
- the new value
-
setFormValueAsString
public void setFormValueAsString(java.lang.String newValue)
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:
I_CmsFormWidget.setFormValueAsString(java.lang.String)
-
setLinkBean
public void setLinkBean(org.opencms.gwt.shared.CmsLinkBean link)
Sets the link from a bean.- Parameters:
link
- the link bean
-
setName
public void setName(java.lang.String name)
Sets the name of the input field.- Parameters:
name
- of the input field
-
setText
public void setText(java.lang.String text)
Sets the text in the text area.- Parameters:
text
- the new text
-
setTitle
public void setTitle(java.lang.String title)
- Overrides:
setTitle
in classcom.google.gwt.user.client.ui.UIObject
- See Also:
UIObject.setTitle(java.lang.String)
-
buildGalleryUrl
protected java.lang.String buildGalleryUrl()
Creates the URL for the gallery dialog IFrame.- Returns:
- the URL for the gallery dialog IFrame
-
close
protected void close()
Close the popup of this widget.
-
open
protected void open()
Opens the popup of this widget.
-
-