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 Classes Modifier and Type Class Description protected static interface
CmsLinkSelector.I_CmsLinkSelectorUiBinder
The 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.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 protected CmsPushButton
m_editButton
The button for editing the link.protected CmsCheckBox
m_externalCheckbox
The check box for setting the link to external or internal.protected com.google.gwt.user.client.ui.HorizontalPanel
m_inputRow
The row containing the input field and the gallery edit button.protected CmsTextBox
m_textbox
The text box containing the current link.static java.lang.String
WIDGET_TYPE
The widget type.
-
Constructor Summary
Constructors Constructor Description CmsLinkSelector()
Constructs a new gallery widget.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
buildGalleryUrl()
Creates the URL for the gallery dialog IFrame.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.java.lang.String
getLink()
Returns the selected link target string.org.opencms.gwt.shared.CmsLinkBean
getLinkBean()
Returns the selected link as a bean.CmsTextBox
getTextBox()
Returns the text box of this widget.static void
initClass()
Initializes this class.boolean
isEnabled()
Returnstrue
if this widget is enabled.boolean
isInternal()
Returns true if the widget is in internal mode.protected void
openGalleryDialog()
Internal method which opens the gallery dialog.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
setFormValueAsString(java.lang.String value)
Sets the current value of the widget as a string.void
setGhostMode(boolean ghostMode)
Enables or disables ghost mode, if possible.void
setGhostValue(java.lang.String value, boolean isGhostMode)
Sets the "ghost value" of the widget and optionally sets it to "ghost mode".void
setInternal(boolean internal)
Sets the widget's mode to internal or external.void
setLink(java.lang.String link)
Sets the link target.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.protected void
userChangedExternal(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, 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, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
-
-
-
-
Field Detail
-
WIDGET_TYPE
public static final java.lang.String WIDGET_TYPE
The widget type.- See Also:
- Constant Field Values
-
m_editButton
@UiField protected CmsPushButton m_editButton
The button for editing the link.
-
m_externalCheckbox
@UiField protected CmsCheckBox m_externalCheckbox
The check box for setting the link to external or internal.
-
m_inputRow
@UiField protected com.google.gwt.user.client.ui.HorizontalPanel m_inputRow
The row containing the input field and the gallery edit button.
-
m_textbox
@UiField protected CmsTextBox m_textbox
The text box containing the current link.
-
-
Constructor Detail
-
CmsLinkSelector
public CmsLinkSelector()
Constructs a new gallery widget.
-
-
Method Detail
-
initClass
public static void initClass()
Initializes this class.
-
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()
-
getLink
public java.lang.String getLink()
Returns the selected link target string.- Returns:
- the link target string
-
getLinkBean
public org.opencms.gwt.shared.CmsLinkBean getLinkBean()
Returns the selected link as a bean.- Returns:
- the selected link as a bean
-
getTextBox
public CmsTextBox getTextBox()
Returns the text box of this widget.- Returns:
- the CmsTextBox.
-
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()
-
isInternal
public boolean isInternal()
Returns true if the widget is in internal mode.- Returns:
- true if the widget is in internal mode
-
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)
-
setFormValueAsString
public void setFormValueAsString(java.lang.String value)
Description copied from interface:I_CmsFormWidget
Sets the current value of the widget as a string.- Specified by:
setFormValueAsString
in interfaceI_CmsFormWidget
- Parameters:
value
- the new value of the widget- See Also:
I_CmsFormWidget.setFormValueAsString(java.lang.String)
-
setGhostMode
public void setGhostMode(boolean ghostMode)
Description copied from interface:I_CmsHasGhostValue
Enables or disables ghost mode, if possible.- Specified by:
setGhostMode
in interfaceI_CmsHasGhostValue
- Parameters:
ghostMode
- if ghost mode should be enabled, else disabled- See Also:
I_CmsHasGhostValue.setGhostMode(boolean)
-
setGhostValue
public void setGhostValue(java.lang.String value, boolean isGhostMode)
Description copied from interface:I_CmsHasGhostValue
Sets 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:
setGhostValue
in interfaceI_CmsHasGhostValue
- Parameters:
value
- the ghost valueisGhostMode
- if true, sets the widget to ghost mode- See Also:
I_CmsHasGhostValue.setGhostValue(java.lang.String, boolean)
-
setInternal
public void setInternal(boolean internal)
Sets the widget's mode to internal or external.- Parameters:
internal
- if true, sets the mode to internal, else to external
-
setLink
public void setLink(java.lang.String link)
Sets the link target.- Parameters:
link
- the link target
-
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
-
buildGalleryUrl
protected java.lang.String buildGalleryUrl()
Creates the URL for the gallery dialog IFrame.- Returns:
- the URL for the gallery dialog IFrame
-
openGalleryDialog
protected void openGalleryDialog()
Internal method which opens the gallery dialog.
-
userChangedExternal
protected void userChangedExternal(boolean external)
Called if the user changed the state to internal or external.- Parameters:
external
- if the new state is "external"
-
-