Package org.opencms.gwt.client.ui.input
Class CmsVfsLinkWidget
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.CmsVfsLinkWidget
- All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers,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_CmsHasInit,I_CmsFormWidget,I_CmsHasGhostValue
public class CmsVfsLinkWidget
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasInit, I_CmsHasGhostValue
The vfs-link widget.
- Since:
- 8.0.0
-
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.gwt.client.ui.input.I_CmsFormWidget
I_CmsFormWidget.FieldType -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CmsPushButtonThe browse button.protected CmsTextBoxThe textbox containing the currently selected path.static final StringThe widget type.Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddButtonStyle(String styleName) Adds a style-name to the browse button.voidaddInputStyleName(String styleName) Adds a style-name to the input text-box.voidaddValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler) Adds a value change handler.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.protected StringReturns the URL to the link selector popup.static voidInitializes this class.booleanReturnstrueif this widget is enabled.protected voidopenSelector(String selectorUrl) Opens the vfs-selector.voidremoveButtonStyle(String styleName) Removes a style-name from the browse button.voidremoveInputStyle(String styleName) Removes a style-name from the input text-box.voidreset()Resets the widget to its default state.voidsetAutoHideParent(I_CmsAutoHider autoHideParent) Call this when auto hiding parents are shown.voidSet the browse button size.voidsetEnabled(boolean enabled) Enables or disables the widget.voidsetErrorMessage(String errorMessage) Sets the error message for this widget.voidsetFormValueAsString(String value) Sets the current value of the widget as a string.voidsetGhostMode(boolean ghostMode) Enables or disables ghost mode, if possible.voidsetGhostValue(String value, boolean isGhostMode) Sets the "ghost value" of the widget and optionally sets it to "ghost mode".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, toString
-
Field Details
-
WIDGET_TYPE
The widget type.- See Also:
-
m_browseButton
The browse button. -
m_textbox
The textbox containing the currently selected path.
-
-
Constructor Details
-
CmsVfsLinkWidget
public CmsVfsLinkWidget()Constructor.
-
-
Method Details
-
initClass
Initializes this class. -
addButtonStyle
Adds a style-name to the browse button.- Parameters:
styleName- the style name
-
addInputStyleName
Adds a style-name to the input text-box.- Parameters:
styleName- the style name
-
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:
-
isEnabled
Description copied from interface:I_CmsFormWidgetReturnstrueif this widget is enabled.- Specified by:
isEnabledin interfaceI_CmsFormWidget- Returns:
trueif this widget is enabled- See Also:
-
removeButtonStyle
Removes a style-name from the browse button.- Parameters:
styleName- the style name
-
removeInputStyle
Removes a style-name from the input text-box.- Parameters:
styleName- the style name
-
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:
-
setButtonSize
Set the browse button size.- Parameters:
size- the button size
-
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:
-
setFormValueAsString
Description copied from interface:I_CmsFormWidgetSets the current value of the widget as a string.- Specified by:
setFormValueAsStringin interfaceI_CmsFormWidget- Parameters:
value- the new value of the widget- See Also:
-
setGhostMode
Description copied from interface:I_CmsHasGhostValueEnables or disables ghost mode, if possible.- Specified by:
setGhostModein interfaceI_CmsHasGhostValue- Parameters:
ghostMode- if ghost mode should be enabled, else disabled- See Also:
-
setGhostValue
Description copied from interface:I_CmsHasGhostValueSets the "ghost value" of the widget and optionally sets it to "ghost mode"."Ghost mode" can be used to show the user the value (called "ghost value") which will be used if he either doesn't choose an option in the widget, or explicitly chooses an "empty" or "default" option.
- Specified by:
setGhostValuein interfaceI_CmsHasGhostValue- Parameters:
value- the ghost valueisGhostMode- if true, sets the widget to ghost mode- See Also:
-
getSelectorUrl
Returns the URL to the link selector popup.- Returns:
- the URL to the link selector popup
-
openSelector
Opens the vfs-selector.- Parameters:
selectorUrl- the URL to the link selector popup
-