org.ametys.cms.search.ui.model.impl

Class AbstractSearchUIColumn

java.lang.Object

org.ametys.runtime.parameter.Parameter<MetadataType>

org.ametys.cms.search.ui.model.impl.AbstractSearchUIColumn

All Implemented Interfaces:

Field, ResultField, SearchUIColumn

Direct Known Subclasses:

DefaultMetadataSearchUIColumn, SystemSearchUIColumn

public abstract class AbstractSearchUIColumn
extends Parameter<MetadataType>
implements SearchUIColumn

This class represents a result column

Field Summary

Fields

Modifier and Type	Field and Description
private String	_contentTypeId
private String	_converter
private String	_defaultSorter
private boolean	_editable
private boolean	_hidden
private boolean	_multiple
private String	_renderer
private boolean	_sortable
private int	_width

Constructor Summary

Constructors

Constructor and Description
AbstractSearchUIColumn()

Method Summary

Modifier and Type	Method and Description
protected I18nizableText	_configureI18nizableText(Configuration config, I18nizableText defaultValue) Configure an i18nizable text
String	getContentTypeId() Get the content type ID (only when the search criteria is of type CONTENT).
String	getConverter() Get the JS class name for converting field's value
String	getDefaultSorter() If the column should be the default sorter 'ASC' or 'DESC'.
String	getRenderer() Get the JS class name for renderer
SearchField	getSearchField() Get the SearchField representing this result field.
int	getWidth() The column's width
boolean	isEditable() Determines if the property is editable
boolean	isHidden() Determines if the column is hidden by default
boolean	isMultiple() Get the multiple status of the field.
boolean	isSortable() Determines if the column is sortable
void	setContentTypeId(String contentTypeId) Set the content type ID (only when the search criteria is of type CONTENT).
void	setConverter(String converter) Set the JS class name for converting field's value
void	setDefaultSorter(String defaultSorter) Set the default sorter propery
void	setEditable(boolean editable) Set the editable property
void	setHidden(boolean hidden) Set the hidden property
void	setMultiple(boolean multiple) Set the multiple property
void	setRenderer(String renderer) Set the JS class name for renderer
void	setSortable(boolean sortable) Set the sortable property
void	setWidth(int width) Set the column's width

Methods inherited from class org.ametys.runtime.parameter.Parameter

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getType, getValidator, getWidget, getWidgetParameters, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.search.ui.model.SearchUIColumn

getDescription, getLabel, getValidator, getWidget, getWidgetParameters

Methods inherited from interface org.ametys.cms.search.model.ResultField

getFullValue, getId, getValue

Methods inherited from interface org.ametys.cms.search.model.Field

getEnumerator, getType

Field Detail

_width

private int _width

_renderer

private String _renderer

_converter

private String _converter

_hidden

private boolean _hidden

_editable

private boolean _editable

_sortable

private boolean _sortable

_multiple

private boolean _multiple

_contentTypeId

private String _contentTypeId

_defaultSorter

private String _defaultSorter

Constructor Detail

AbstractSearchUIColumn

public AbstractSearchUIColumn()

Method Detail

getWidth

public int getWidth()

Description copied from interface: SearchUIColumn

The column's width

Specified by:

getWidth in interface SearchUIColumn

Returns:

The width

setWidth

public void setWidth(int width)

Set the column's width

Parameters:

width - The width to set

isHidden

public boolean isHidden()

Description copied from interface: SearchUIColumn

Determines if the column is hidden by default

Specified by:

isHidden in interface SearchUIColumn

Returns:

true if the column is hidden by default

setHidden

public void setHidden(boolean hidden)

Set the hidden property

Parameters:

hidden - true to hidden the columns by default

isEditable

public boolean isEditable()

Description copied from interface: SearchUIColumn

Determines if the property is editable

Specified by:

isEditable in interface SearchUIColumn

Returns:

true if the property is editable

setSortable

public void setSortable(boolean sortable)

Set the sortable property

Parameters:

sortable - true to authorized sort

isSortable

public boolean isSortable()

Description copied from interface: SearchUIColumn

Determines if the column is sortable

Specified by:

isSortable in interface SearchUIColumn

Returns:

true if the column is sortable

setDefaultSorter

public void setDefaultSorter(String defaultSorter)

Set the default sorter propery

Parameters:

defaultSorter - If the column should be a default sorter, 'ASC' for ascending 'DESC' for descending. Null otherwise.

getDefaultSorter

public String getDefaultSorter()

Description copied from interface: SearchUIColumn

If the column should be the default sorter 'ASC' or 'DESC'. Null otherwise.

Specified by:

getDefaultSorter in interface SearchUIColumn

Returns:

'ASC', 'DESC' or null

setEditable

public void setEditable(boolean editable)

Set the editable property

Parameters:

editable - true to authorized edition

getRenderer

public String getRenderer()

Description copied from interface: SearchUIColumn

Get the JS class name for renderer

Specified by:

getRenderer in interface SearchUIColumn

Returns:

The renderer

setRenderer

public void setRenderer(String renderer)

Set the JS class name for renderer

Parameters:

renderer - The renderer

getConverter

public String getConverter()

Description copied from interface: SearchUIColumn

Get the JS class name for converting field's value

Specified by:

getConverter in interface SearchUIColumn

Returns:

The convert JS class name

setConverter

public void setConverter(String converter)

Set the JS class name for converting field's value

Parameters:

converter - The convert JS class name

isMultiple

public boolean isMultiple()

Description copied from interface: Field

Get the multiple status of the field.

Specified by:

isMultiple in interface Field

Returns:

true if the field can have multiple values, false otherwise.

setMultiple

public void setMultiple(boolean multiple)

Set the multiple property

Parameters:

multiple - the multiple property

getContentTypeId

public String getContentTypeId()

Get the content type ID (only when the search criteria is of type CONTENT).

Specified by:

getContentTypeId in interface Field

Returns:

the content type ID.

setContentTypeId

public void setContentTypeId(String contentTypeId)

Set the content type ID (only when the search criteria is of type CONTENT).

Parameters:

contentTypeId - the content type ID.

getSearchField

public SearchField getSearchField()

Description copied from interface: ResultField

Get the SearchField representing this result field.

Specified by:

getSearchField in interface ResultField

Returns:

The SearchField representing this result field.

_configureI18nizableText

protected I18nizableText _configureI18nizableText(Configuration config,
                                                  I18nizableText defaultValue)

Configure an i18nizable text

Parameters:

config - The Configuration.

defaultValue - The default value as an I18nizableText.

Returns:

The i18nizable text