Package com.jalios.jcms.taglib.settings.impl

Class MediaPathSettings

java.lang.Object

com.jalios.jcms.taglib.settings.BasicSettings<T>

com.jalios.jcms.taglib.settings.AbstractTextSettings<T>

com.jalios.jcms.taglib.settings.AbstractTextChooserSettings<MediaPathSettings>

com.jalios.jcms.taglib.settings.impl.MediaPathSettings

All Implemented Interfaces:

ControlSettings<MediaPathSettings>, java.lang.Cloneable

Direct Known Subclasses:

MediaSettings

public class MediaPathSettings
extends AbstractTextChooserSettings<MediaPathSettings>

Media path Settings

Author:

Nicolas Dos Santos

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MediaPathSettings.MediaType

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MEDIA

Fields inherited from class com.jalios.jcms.taglib.settings.BasicSettings

APPEND, ARIA_ATTR_PREFIX, ARIA_ATTRIBUTES, AUTOFOCUS, CLEAR_BUTTON, CSS, DATA_ATTR_PREFIX, DATA_ATTRIBUTES, DISABLED, HIDE_CLEAR_BUTTON, HTML_ATTRIBUTES, ID, LANGUAGE_CHOOSER, MAX_LENGTH, NAME, PLACEHOLDER, PREPEND, READONLY, REQUIRED, TITLE, TRIGGER_ACTION, TRIGGER_EVENT, VALUE

Constructor Summary

Constructors

Constructor	Description
MediaPathSettings()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getChooserName()	Chooser name used by the databroker when there is a click event in the chooser button.
protected java.lang.String	getChooserOption(java.util.Map<java.lang.String,java.lang.String[]> customOptionMap)	Options used by the databroker when there is a click event in the chooser button.
protected MediaPathSettings	getThis()	Returns the exact type of the this reference. It's a way to recover the type of the this object in a class hierarchy (cf.
ControlType	getType()	Returns the ControlType related to the current ControlSettings implementation.
MediaPathSettings	media(MediaPathSettings.MediaType[] mediaTypes)	Filter the media to select according to the given media types.
MediaPathSettings	media(MediaPathSettings.MediaType mediaType, MediaPathSettings.MediaType... otherMediaTypes)	Filter the media to select according to the given media types.
MediaPathSettings	media(java.lang.String[] mediaTypes)	Filter the media to select according to the given media types.
MediaPathSettings	media(java.lang.String mediaType, java.lang.String... otherMediaTypes)	Filter the media to select according to the given media types.
MediaPathSettings	media(java.util.Collection<MediaPathSettings.MediaType> mediaTypes)	Filter the media to select according to the given media types.
void	resolveOptions(TypeFieldEntry tfe)	Set options from the specified TypeFieldEntry.
protected boolean	useCurrentWorkspace()	Override this method and return 'true' to add current Workspace in chooser option if not defined by WORKSPACE option.

Methods inherited from class com.jalios.jcms.taglib.settings.AbstractTextChooserSettings

addAcChooserOption, addChooserOption, getAcChooserName, getAcChooserOption, getChooserIcon, getChooserTitle, getOption, popupHeight, popupWidth, superGetOption, workspace, workspace

Methods inherited from class com.jalios.jcms.taglib.settings.AbstractTextSettings

onChange

Methods inherited from class com.jalios.jcms.taglib.settings.BasicSettings

addOption, append, aria, aria, autofocus, clearOption, clone, css, dataAttribute, dataAttribute, dataAttributes, disable, getOptionNames, htmlAttributes, htmlAttributes, id, isChannelReady, maxLength, merge, name, onFocusOut, placeholder, prepend, readonly, removeOption, require, showLanguageChooser, sortSet, title, toStringArray, toStringArray, toStringArray, toStringArray, toStringArray, trigger, value

Methods inherited from class java.lang.Object

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

Field Detail

MEDIA

public static final java.lang.String MEDIA

See Also:

Constant Field Values

Constructor Detail

MediaPathSettings

public MediaPathSettings()

Method Detail

getType

public ControlType getType()

Description copied from interface: ControlSettings

Returns the ControlType related to the current ControlSettings implementation.

Returns:

ControlType

getThis

protected MediaPathSettings getThis()

Description copied from class: BasicSettings

Returns the exact type of the this reference.
It's a way to recover the type of the this object in a class hierarchy (cf. getThis "trick").

Specified by:

getThis in class BasicSettings<MediaPathSettings>

Returns:

The exact type of the this reference

getChooserName

protected java.lang.String getChooserName()

Description copied from class: AbstractTextChooserSettings

Chooser name used by the databroker when there is a click event in the chooser button.

Specified by:

getChooserName in class AbstractTextChooserSettings<MediaPathSettings>

Returns:

The chooser name

See Also:

"/js/jalios/core/jalios-widget-chooser.js"

resolveOptions

public void resolveOptions(TypeFieldEntry tfe)

Description copied from interface: ControlSettings

Set options from the specified TypeFieldEntry.

Specified by:

resolveOptions in interface ControlSettings<MediaPathSettings>

Overrides:

resolveOptions in class BasicSettings<MediaPathSettings>

Parameters:

tfe - TypeFieldEntry

getChooserOption

protected java.lang.String getChooserOption(java.util.Map<java.lang.String,java.lang.String[]> customOptionMap)

Description copied from class: AbstractTextChooserSettings

Options used by the databroker when there is a click event in the chooser button.

Specified by:

getChooserOption in class AbstractTextChooserSettings<MediaPathSettings>

Parameters:

customOptionMap - Extra chooser options forwarded by the option ChooserConstants.EXTRA_CHOOSER_OPTION and appended to the query string

Returns:

String representing the options as query string

useCurrentWorkspace

protected boolean useCurrentWorkspace()

Description copied from class: AbstractTextChooserSettings

Override this method and return 'true' to add current Workspace in chooser option if not defined by WORKSPACE option.

Overrides:

useCurrentWorkspace in class AbstractTextChooserSettings<MediaPathSettings>

Returns:

true to use the current workspace, false instead

media

public MediaPathSettings media(java.lang.String[] mediaTypes)

Filter the media to select according to the given media types.

Parameters:

mediaTypes - Array of media types

Returns:

a reference to this object - used to chain calls

media

public MediaPathSettings media(MediaPathSettings.MediaType[] mediaTypes)

Filter the media to select according to the given media types.

Parameters:

mediaTypes - Array of MediaPathSettings.MediaType objects

Returns:

a reference to this object - used to chain calls

media

public MediaPathSettings media(java.util.Collection<MediaPathSettings.MediaType> mediaTypes)

Filter the media to select according to the given media types.

Parameters:

mediaTypes - Collection of MediaPathSettings.MediaType objects

Returns:

a reference to this object - used to chain calls

media

public MediaPathSettings media(MediaPathSettings.MediaType mediaType,
                               MediaPathSettings.MediaType... otherMediaTypes)

Filter the media to select according to the given media types.

Parameters:

mediaType - The first MediaPathSettings.MediaType object

otherMediaTypes - the other MediaPathSettings.MediaType objects

Returns:

a reference to this object - used to chain calls

media

public MediaPathSettings media(java.lang.String mediaType,
                               java.lang.String... otherMediaTypes)

Filter the media to select according to the given media types.

Parameters:

mediaType - The first media type

otherMediaTypes - the other media types

Returns:

a reference to this object - used to chain calls