Package org.opencms.gwt.client.ui.input
Class CmsLinkSelector
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.CmsLinkSelector
- 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_CmsFormWidget,I_CmsHasGhostValue
public class CmsLinkSelector
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasGhostValue
Widget for selecting an internal or external link.
- Since:
- 8.0.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static interfaceThe UI Binder interface for this widget.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 button for editing the link.protected CmsCheckBoxThe check box for setting the link to external or internal.protected com.google.gwt.user.client.ui.HorizontalPanelThe row containing the input field and the gallery edit button.protected CmsTextBoxThe text box containing the current link.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 TypeMethodDescriptionprotected StringCreates the URL for the gallery dialog IFrame.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.getLink()Returns the selected link target string.org.opencms.gwt.shared.CmsLinkBeanReturns the selected link as a bean.Returns the text box of this widget.static voidInitializes this class.booleanReturnstrueif this widget is enabled.booleanReturns true if the widget is in internal mode.protected voidInternal method which opens the gallery dialog.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.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".voidsetInternal(boolean internal) Sets the widget's mode to internal or external.voidSets the link target.voidsetLinkBean(org.opencms.gwt.shared.CmsLinkBean link) Sets the link from a bean.voidSets the name of the input field.protected voiduserChangedExternal(boolean external) Called if the user changed the state to internal or external.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_editButton
The button for editing the link. -
m_externalCheckbox
The check box for setting the link to external or internal. -
m_inputRow
The row containing the input field and the gallery edit button. -
m_textbox
The text box containing the current link.
-
-
Constructor Details
-
CmsLinkSelector
public CmsLinkSelector()Constructs a new gallery widget.
-
-
Method Details
-
initClass
Initializes this class. -
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:
-
getLink
Returns the selected link target string.- Returns:
- the link target string
-
getLinkBean
Returns the selected link as a bean.- Returns:
- the selected link as a bean
-
getTextBox
Returns the text box of this widget.- Returns:
- the CmsTextBox.
-
isEnabled
Description copied from interface:I_CmsFormWidgetReturnstrueif this widget is enabled.- Specified by:
isEnabledin interfaceI_CmsFormWidget- Returns:
trueif this widget is enabled- See Also:
-
isInternal
Returns true if the widget is in internal mode.- Returns:
- true if the widget is in internal mode
-
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:
-
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:
-
setInternal
Sets the widget's mode to internal or external.- Parameters:
internal- if true, sets the mode to internal, else to external
-
setLink
Sets the link target.- Parameters:
link- the link target
-
setName
Sets the name of the input field.- Parameters:
name- of the input field
-
buildGalleryUrl
Creates the URL for the gallery dialog IFrame.- Returns:
- the URL for the gallery dialog IFrame
-
openGalleryDialog
Internal method which opens the gallery dialog. -
userChangedExternal
Called if the user changed the state to internal or external.- Parameters:
external- if the new state is "external"
-