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

Class ViewElementSearchUIColumn

java.lang.Object

org.ametys.runtime.model.ViewElement

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

All Implemented Interfaces:

SearchUIColumn<ElementDefinition>, ModelViewItem<ElementDefinition>, ViewItem, Labelable, ModifiableLabelable

public class ViewElementSearchUIColumn
extends ViewElement
implements SearchUIColumn<ElementDefinition>

This class represents a result column

Constructor Summary

Constructors

Constructor	Description
ViewElementSearchUIColumn()

Method Summary

Modifier and Type	Method	Description
boolean	allowSortOnMultipleJoin()	Determines if sort is allowed on multiple join
void	copyTo(ViewItem item)	Copy the current view item in the given one.
ViewElementSearchUIColumn	createInstance()	Create an instance of ViewItem
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
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	isSortable()	Determines if the column is sortable
void	setAllowSortOnMultipleJoin(boolean allowSortOnMultipleJoin)	Set the allowSortOnMultipleJoin property
void	setConverter(Optional<String> converter)	Set the JS class name for converting field's value
void	setDefaultSorter(Optional<String> defaultSorter)	Set the default sorter property
void	setEditable(boolean editable)	Set the editable property
void	setHidden(boolean hidden)	Set the hidden property
void	setRenderer(Optional<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
Map<String,Object>	toJSON(DefinitionContext context)	Converts the view item in a JSON map

Methods inherited from class org.ametys.runtime.model.ViewElement

equals, equals, getDefinition, getDescription, getLabel, getName, getParent, hashCode, setDefinition, setDescription, setLabel, setParent, toSAX, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.model.ModelViewItem

getDefinition, setDefinition, setName

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel

Methods inherited from interface org.ametys.runtime.model.ViewItem

copyTo, equals, getParent, setParent, toSAX

Constructor Details

ViewElementSearchUIColumn

public ViewElementSearchUIColumn()

Method Details

getWidth

public int getWidth()

Description copied from interface: SearchUIColumn

The column's width

Specified by:

getWidth in interface SearchUIColumn<ElementDefinition>

Returns:

The width

setWidth

public void setWidth(int width)

Description copied from interface: SearchUIColumn

Set the column's width

Specified by:

setWidth in interface SearchUIColumn<ElementDefinition>

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<ElementDefinition>

Returns:

true if the column is hidden by default

setHidden

public void setHidden(boolean hidden)

Description copied from interface: SearchUIColumn

Set the hidden property

Specified by:

setHidden in interface SearchUIColumn<ElementDefinition>

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<ElementDefinition>

Returns:

true if the property is editable

setEditable

public void setEditable(boolean editable)

Description copied from interface: SearchUIColumn

Set the editable property

Specified by:

setEditable in interface SearchUIColumn<ElementDefinition>

Parameters:

editable - true to authorized edition

isSortable

public boolean isSortable()

Description copied from interface: SearchUIColumn

Determines if the column is sortable

Specified by:

isSortable in interface SearchUIColumn<ElementDefinition>

Returns:

true if the column is sortable

setSortable

public void setSortable(boolean sortable)

Description copied from interface: SearchUIColumn

Set the sortable property

Specified by:

setSortable in interface SearchUIColumn<ElementDefinition>

Parameters:

sortable - true to authorized sort

allowSortOnMultipleJoin

public boolean allowSortOnMultipleJoin()

Description copied from interface: SearchUIColumn

Determines if sort is allowed on multiple join

Specified by:

allowSortOnMultipleJoin in interface SearchUIColumn<ElementDefinition>

Returns:

true if sort is allowed on multiple join, false otherwise

setAllowSortOnMultipleJoin

public void setAllowSortOnMultipleJoin(boolean allowSortOnMultipleJoin)

Description copied from interface: SearchUIColumn

Set the allowSortOnMultipleJoin property

Specified by:

setAllowSortOnMultipleJoin in interface SearchUIColumn<ElementDefinition>

Parameters:

allowSortOnMultipleJoin - true to authorized sort on multiple join

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<ElementDefinition>

Returns:

'ASC', 'DESC' or null

setDefaultSorter

public void setDefaultSorter(Optional<String> defaultSorter)

Description copied from interface: SearchUIColumn

Set the default sorter property

Specified by:

setDefaultSorter in interface SearchUIColumn<ElementDefinition>

Parameters:

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

getRenderer

public String getRenderer()

Description copied from interface: SearchUIColumn

Get the JS class name for renderer

Specified by:

getRenderer in interface SearchUIColumn<ElementDefinition>

Returns:

The renderer

setRenderer

public void setRenderer(Optional<String> renderer)

Description copied from interface: SearchUIColumn

Set the JS class name for renderer

Specified by:

setRenderer in interface SearchUIColumn<ElementDefinition>

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<ElementDefinition>

Returns:

The convert JS class name

setConverter

public void setConverter(Optional<String> converter)

Description copied from interface: SearchUIColumn

Set the JS class name for converting field's value

Specified by:

setConverter in interface SearchUIColumn<ElementDefinition>

Parameters:

converter - The convert JS class name

createInstance

public ViewElementSearchUIColumn createInstance()

Description copied from interface: ViewItem

Create an instance of ViewItem

Specified by:

createInstance in interface ViewItem

Overrides:

createInstance in class ViewElement

Returns:

the created instance

toJSON

public Map<String,Object> toJSON(DefinitionContext context)
                          throws ProcessingException

Description copied from interface: ViewItem

Converts the view item in a JSON map

Specified by:

toJSON in interface ViewItem

Overrides:

toJSON in class ViewElement

Parameters:

context - the context of the definitions referenced in this view item and/or its children

Returns:

The view item as a JSON map

Throws:

ProcessingException - If an error occurs when converting the view item

copyTo

public void copyTo(ViewItem item)

Description copied from interface: ViewItem

Copy the current view item in the given one. If the view item is an accessor, its view items are not copied

Specified by:

copyTo in interface ViewItem

Overrides:

copyTo in class ViewElement

Parameters:

item - the copy