Package org.opencms.ui.components.fileselect

Class CmsPathSelectField

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.v7.ui.AbstractLegacyComponent

com.vaadin.v7.ui.AbstractField<T>

com.vaadin.v7.ui.CustomField<T>

org.opencms.ui.components.fileselect.A_CmsFileSelectField<java.lang.String>

org.opencms.ui.components.fileselect.CmsPathSelectField

All Implemented Interfaces:

com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasComponents, com.vaadin.v7.data.Buffered, com.vaadin.v7.data.BufferedValidatable, com.vaadin.v7.data.Property<java.lang.String>, com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer, com.vaadin.v7.data.Validatable, com.vaadin.v7.ui.Field<java.lang.String>, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>, java.util.EventListener, CmsEditableGroup.I_HasError

Direct Known Subclasses:

CmsFolderSelector, CmsModuleResourceSelectField

public class CmsPathSelectField
extends A_CmsFileSelectField<java.lang.String>

File path select field. This field will also allow paths that are not pointing to any VFS resource.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractField

com.vaadin.v7.ui.AbstractField.FocusShortcut, com.vaadin.v7.ui.AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Buffered

com.vaadin.v7.data.Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.v7.ui.Field

com.vaadin.v7.ui.Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Property

com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyException, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.Transactional<T extends java.lang.Object>, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from class org.opencms.ui.components.fileselect.A_CmsFileSelectField

m_cms, m_diableSiteSwitch, m_fileSelectCaption, m_filter, m_startWithSitemapView, m_textField

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor	Description
CmsPathSelectField()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
java.lang.Class<? extends java.lang.String>	getType()
java.lang.String	getValue()	Gets the value.
boolean	isUseRootPaths()	Returns if only root paths are used.
protected void	setInternalValue(java.lang.String newValue)
protected void	setResourceValue(CmsResource resource)	Sets the field value.
void	setUseRootPaths(boolean useRootPaths)	Sets if only root paths should be used.
protected void	setValue(boolean fireChange, java.lang.String value)	Sets the value.
void	setValue(java.lang.String value)	Sets the value.

Methods inherited from class org.opencms.ui.components.fileselect.A_CmsFileSelectField

disableSiteSwitch, getOptions, hasEditableGroupError, initContent, openFileSelector, requireFile, requireFolder, resetRequireType, resourceIsValid, setBasePath, setCmsObject, setDefaultPath, setFileSelectButtonVisible, setFileSelectCaption, setResourceFilter, setStartWithSitempaView

Methods inherited from class com.vaadin.v7.ui.CustomField

attach, focus, getContent, getTabIndex, iterator, setFocusDelegate, setHeight, setTabIndex, setWidth

Methods inherited from class com.vaadin.v7.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, beforeClientResponse, clear, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getState, getState, getValidators, isBuffered, isEmpty, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readDesign, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setValidationVisible, setValue, setValue, shouldHideErrors, validate, validate, valueChange, writeDesign

Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent

getExplicitImmediateValue, isImmediate, setImmediate

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidthFull, setWidthUndefined

Constructor Detail

CmsPathSelectField

public CmsPathSelectField()

Creates a new instance.

Method Detail

getType

public java.lang.Class<? extends java.lang.String> getType()

Specified by:

getType in interface com.vaadin.v7.data.Property<java.lang.String>

Specified by:

getType in class com.vaadin.v7.ui.AbstractField<java.lang.String>

See Also:

com.vaadin.ui.AbstractField#getType()

getValue

public java.lang.String getValue()

Gets the value.

Specified by:

getValue in interface com.vaadin.v7.data.Property<java.lang.String>

Overrides:

getValue in class com.vaadin.v7.ui.AbstractField<java.lang.String>

Returns:

the value

isUseRootPaths

public boolean isUseRootPaths()

Returns if only root paths are used.

Returns:

true if only root paths are used

setUseRootPaths

public void setUseRootPaths(boolean useRootPaths)

Sets if only root paths should be used.

Parameters:

useRootPaths - true to use root paths only

setValue

public void setValue(java.lang.String value)

Sets the value.

Specified by:

setValue in interface com.vaadin.v7.data.Property<java.lang.String>

Overrides:

setValue in class com.vaadin.v7.ui.AbstractField<java.lang.String>

Parameters:

value - the new value

setInternalValue

protected void setInternalValue(java.lang.String newValue)

Overrides:

setInternalValue in class com.vaadin.v7.ui.AbstractField<java.lang.String>

See Also:

com.vaadin.ui.AbstractField#setInternalValue(java.lang.Object)

setResourceValue

protected void setResourceValue(CmsResource resource)

Description copied from class: A_CmsFileSelectField

Sets the field value.

Specified by:

setResourceValue in class A_CmsFileSelectField<java.lang.String>

Parameters:

resource - the resource

See Also:

A_CmsFileSelectField.setResourceValue(org.opencms.file.CmsResource)

setValue

protected void setValue(boolean fireChange,
                        java.lang.String value)

Sets the value.

Parameters:

fireChange - true to fire the value change event

value - the value to set