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

Class SearchUIColumnHelper

java.lang.Object

org.ametys.cms.search.ui.model.SearchUIColumnHelper

public final class SearchUIColumnHelper
extends Object

Helper class for search UI columns

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_COLUMN_WIDTH	The default column width
static final int	DEFAULT_SYSTEM_PROPERTY_COLUMN_WIDTH	The default column width for system properties

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	columnPropertiesToJSON(SearchUIColumn column)	Converts the given column's properties in a JSON map
static SearchUIColumn	createModelItemColumn(ModelItem modelItem)	Creates a column for the given model item
static int	getDefaultColumnWidth(SearchUIColumn column)	Retrieves the default column width, corresponding to the referenced model item
static Optional<String>	getElementDefinitionDefaultConverter(ElementDefinition definition)	Retrieves the default converter for the given definition
static boolean	isEditionAllowed(SearchUIColumn column)	Determines if the inline edition is allowed for the given column
static boolean	isSortAllowed(SearchUIColumn column)	Determines if the sort is allowed for the given column

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_COLUMN_WIDTH

public static final int DEFAULT_COLUMN_WIDTH

The default column width

See Also:

• Constant Field Values

DEFAULT_SYSTEM_PROPERTY_COLUMN_WIDTH

public static final int DEFAULT_SYSTEM_PROPERTY_COLUMN_WIDTH

The default column width for system properties

See Also:

• Constant Field Values

Method Details

createModelItemColumn

public static SearchUIColumn createModelItemColumn(ModelItem modelItem)
                                            throws IllegalArgumentException

Creates a column for the given model item

Parameters:

modelItem - the model item

Returns:

the created column

Throws:

IllegalArgumentException - if the given model item is not an element or a repeater

getDefaultColumnWidth

public static int getDefaultColumnWidth(SearchUIColumn column)

Retrieves the default column width, corresponding to the referenced model item

Parameters:

column - the column

Returns:

the default width

isEditionAllowed

public static boolean isEditionAllowed(SearchUIColumn column)

Determines if the inline edition is allowed for the given column

Parameters:

column - the column

Returns:

true if the column edition is allowed, false otherwise

isSortAllowed

public static boolean isSortAllowed(SearchUIColumn column)

Determines if the sort is allowed for the given column

Parameters:

column - the column

Returns:

true if the column edition is allowed, false otherwise

getElementDefinitionDefaultConverter

public static Optional<String> getElementDefinitionDefaultConverter(ElementDefinition definition)

Retrieves the default converter for the given definition

Parameters:

definition - the definition

Returns:

the default converter

columnPropertiesToJSON

public static Map<String,Object> columnPropertiesToJSON(SearchUIColumn column)

Converts the given column's properties in a JSON map

Parameters:

column - the column

Returns:

The column's properties as a JSON map