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.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_browseButton	The browse button.
protected CmsTextBox	m_textbox	The textbox containing the currently selected path.
static java.lang.String	WIDGET_TYPE	The widget type.

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsVfsLinkWidget()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addButtonStyle(java.lang.String styleName)	Adds a style-name to the browse button.
void	addInputStyleName(java.lang.String styleName)	Adds a style-name to the input text-box.
void	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)	Adds a value change handler.
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.
protected java.lang.String	getSelectorUrl()	Returns the URL to the link selector popup.
static void	initClass()	Initializes this class.
boolean	isEnabled()	Returns true if this widget is enabled.
protected void	openSelector(java.lang.String selectorUrl)	Opens the vfs-selector.
void	removeButtonStyle(java.lang.String styleName)	Removes a style-name from the browse button.
void	removeInputStyle(java.lang.String styleName)	Removes a style-name from the input text-box.
void	reset()	Resets the widget to its default state.
void	setAutoHideParent(I_CmsAutoHider autoHideParent)	Call this when auto hiding parents are shown.
void	setButtonSize(I_CmsButton.Size size)	Set the browse button size.
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".

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WIDGET_TYPE

public static final java.lang.String WIDGET_TYPE

The widget type.

See Also:

Constant Field Values

m_browseButton

protected CmsPushButton m_browseButton

The browse button.

m_textbox

protected CmsTextBox m_textbox

The textbox containing the currently selected path.

Constructor Detail

CmsVfsLinkWidget

public CmsVfsLinkWidget()

Constructor.

Method Detail

initClass

public static void initClass()

Initializes this class.

addButtonStyle

public void addButtonStyle(java.lang.String styleName)

Adds a style-name to the browse button.

Parameters:

styleName - the style name

addInputStyleName

public void addInputStyleName(java.lang.String styleName)

Adds a style-name to the input text-box.

Parameters:

styleName - the style name

addValueChangeHandler

public void addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)

Adds a value change handler.

Parameters:

handler - the handler to add

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 interface I_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 interface I_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 interface I_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 interface I_CmsFormWidget

Returns:

the current value of the widget

See Also:

I_CmsFormWidget.getFormValueAsString()

isEnabled

public boolean isEnabled()

Description copied from interface: I_CmsFormWidget

Returns true if this widget is enabled.

Specified by:

isEnabled in interface I_CmsFormWidget

Returns:

true if this widget is enabled

See Also:

I_CmsFormWidget.isEnabled()

removeButtonStyle

public void removeButtonStyle(java.lang.String styleName)

Removes a style-name from the browse button.

Parameters:

styleName - the style name

removeInputStyle

public void removeInputStyle(java.lang.String styleName)

Removes a style-name from the input text-box.

Parameters:

styleName - the style name

reset

public void reset()

Description copied from interface: I_CmsFormWidget

Resets the widget to its default state.

Specified by:

reset in interface I_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 interface I_CmsFormWidget

Parameters:

autoHideParent - the auto hide parent

See Also:

I_CmsFormWidget.setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)

setButtonSize

public void setButtonSize(I_CmsButton.Size size)

Set the browse button size.

Parameters:

size - the button size

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: I_CmsFormWidget

Enables or disables the widget.

Specified by:

setEnabled in interface I_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 interface I_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 interface I_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 interface I_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 interface I_CmsHasGhostValue

Parameters:

value - the ghost value

isGhostMode - if true, sets the widget to ghost mode

See Also:

I_CmsHasGhostValue.setGhostValue(java.lang.String, boolean)

getSelectorUrl

protected java.lang.String getSelectorUrl()

Returns the URL to the link selector popup.

Returns:

the URL to the link selector popup

openSelector

protected void openSelector(java.lang.String selectorUrl)

Opens the vfs-selector.

Parameters:

selectorUrl - the URL to the link selector popup