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

Class SearchSettings

java.lang.Object

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

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

com.jalios.jcms.taglib.settings.impl.SearchSettings

All Implemented Interfaces:

ControlSettings<SearchSettings>, java.lang.Cloneable

public class SearchSettings
extends AbstractTextSettings<SearchSettings>

Field Summary

Fields

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

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
SearchSettings()

Method Summary

Modifier and Type	Method	Description
SearchSettings	buttonDataAttribute(java.lang.String dataName, java.lang.Object dataValue)	Add a data attribute on the search button. The method accepts the data name with or without the 'data-' prefix.
SearchSettings	buttonDataAttributes(java.util.Map<java.lang.String,java.lang.Object> dataAttributes)	Add a map of data attributes on the search button. The map key is the data attribute name, and the map value is the data attribute value.
protected SearchSettings	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.

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, dataAttributes, disable, getOption, getOptionNames, htmlAttributes, htmlAttributes, id, isChannelReady, maxLength, merge, name, onFocusOut, placeholder, prepend, readonly, removeOption, require, resolveOptions, 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

BUTTON_DATA_ATTRIBUTES

public static final java.lang.String BUTTON_DATA_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

SearchSettings

public SearchSettings()

Method Detail

getType

public ControlType getType()

Description copied from interface: ControlSettings

Returns the ControlType related to the current ControlSettings implementation.

Returns:

ControlType

getThis

protected SearchSettings 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<SearchSettings>

Returns:

The exact type of the this reference

buttonDataAttributes

public SearchSettings buttonDataAttributes(java.util.Map<java.lang.String,java.lang.Object> dataAttributes)

Add a map of data attributes on the search button.
The map key is the data attribute name, and the map value is the data attribute value. Example:

 <%
 Map<String, Object> map = new HashMap<String>();
 map.put("data-jalios-mydata1", "myvalue1");
 map.put("jalios-mydata2", "myvalue2");
 %>
 <jalios:control settings='new DefaultSettings().dataAttributes(map)' />
 

Parameters:

dataAttributes - Map of data attributes

Returns:

a reference to this object - used to chain calls

See Also:

BasicSettings.dataAttribute(String, Object)

buttonDataAttribute

public SearchSettings buttonDataAttribute(java.lang.String dataName,
                                          java.lang.Object dataValue)

Add a data attribute on the search button.
The method accepts the data name with or without the 'data-' prefix. Example:

 <jalios:control settings='new DefaultSettings().dataAttribute("data-jalios-mydata1", "myvalue1").dataAttribute("jalios-mydata2", "myvalue2")'
 />
 

This will add data attributes as follows:

 data-jalios-mydata1="myvalue1" data-jalios-mydata2="myvalue2"
 

Parameters:

dataName - data attribute name

dataValue - data attribute value

Returns:

a reference to this object - used to chain calls