info.magnolia.ui.workbench.column.definition

Interface ColumnDefinition

All Known Implementing Classes:

AbstractColumnDefinition, BooleanPropertyColumnDefinition, MetaDataColumnDefinition, PropertyColumnDefinition, PropertyTypeColumnDefinition, StatusColumnDefinition, UserNameColumnDefinition

public interface ColumnDefinition

Defines a column in a workbench.

See Also:

WorkbenchDefinition

Method Summary

Methods

Modifier and Type	Method and Description
float	getExpandRatio() Expand ratios can be defined to customize the way how excess space is divided among columns.
Class<? extends ColumnFormatter>	getFormatterClass()
String	getLabel()
String	getName()
String	getPropertyName()
Class<? extends ColumnAvailabilityRule>	getRuleClass() Returns the AvailabilityRule object for this subject.
Class<?>	getType()
int	getWidth() Sets columns width (in pixels).
boolean	isDisplayInChooseDialog()
boolean	isEditable() Returns whether this column should be editable if workbench uses inplace editing.
boolean	isEnabled() If false - the column will not be displayed.
boolean	isSearchable() Returns whether this column and therefore the underlying JCR property it represents is to be included in searches.
boolean	isSortable()

Method Detail

getName

String getName()

getPropertyName

String getPropertyName()

getLabel

String getLabel()

getWidth

int getWidth()

Sets columns width (in pixels). See getExpandRatio().

getExpandRatio

float getExpandRatio()

Expand ratios can be defined to customize the way how excess space is divided among columns. A table can have excess space if it has its width defined and there is horizontally more space than columns consume naturally. Excess space is the space that is not used by columns with explicit width (see getWidth()) or with natural width (no width nor expand ratio).

isSortable

boolean isSortable()

getFormatterClass

Class<? extends ColumnFormatter> getFormatterClass()

getType

Class<?> getType()

isDisplayInChooseDialog

boolean isDisplayInChooseDialog()

isSearchable

boolean isSearchable()

Returns whether this column and therefore the underlying JCR property it represents is to be included in searches. Its value is true by default.

isEditable

boolean isEditable()

Returns whether this column should be editable if workbench uses inplace editing.

Returns:

true, if column is editable

See Also:

WorkbenchDefinition.isEditable()

isEnabled

boolean isEnabled()

If false - the column will not be displayed. useful for turning a column off when extending a columns configuration.

Returns:

getRuleClass

Class<? extends ColumnAvailabilityRule> getRuleClass()

Returns the AvailabilityRule object for this subject.