Package com.broadleafcommerce.metadata.dsl.core.extension.columns

Class AbstractColumn<C extends AbstractColumn<C>>

java.lang.Object

com.broadleafcommerce.metadata.dsl.core.AbstractComponent<C>

com.broadleafcommerce.metadata.dsl.core.extension.columns.AbstractColumn<C>

All Implemented Interfaces:

Column<C>, Component<C>, Copyable<C>, CustomCssComponent<C>, Serializable, Comparable<C>

Direct Known Subclasses:

DefaultColumn, DefaultConditionalColumn, DefaultDateColumn, DefaultDerivedColumn, DefaultDynamicColumn, DefaultEmbeddedListColumn, DefaultEnumArrayColumn, DefaultEnumColumn, DefaultLinkColumn, DefaultMoneyColumn, DefaultProgressColumn, DefaultRSQLRuleColumn, DefaultSpelRuleColumn, DefaultThumbnailColumn

public abstract class AbstractColumn<C extends AbstractColumn<C>>
extends AbstractComponent<C>
implements Column<C>

The abstract column component specification.

Author:

Nick Crum (ncrum)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.Column

Column.ColumnAttributes

Field Summary

Fields inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent

CSS_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
AbstractColumn()
AbstractColumn(Column<?> component)
AbstractColumn(String type)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getAlign()	Defines the alignment of column data as either "left", "center", or "right".
String	getColSpan()	Defines the number of column lengths this column spans.
String	getName()	The name of the property this column will display.
String	getWidth()	Defines a fixed width for this column.
int	hashCode()
boolean	isSortable()	Whether or not the column is sortable.
void	setAlign(String align)	Sets the alignment.
void	setColSpan(String colSpan)	Sets the column span.
void	setName(String name)	Sets the name.
void	setSortable(boolean sortable)	Sets whether or not sortable.
void	setWidth(String width)	Sets the width of the column.

Methods inherited from class com.broadleafcommerce.metadata.dsl.core.AbstractComponent

compareTo, getActions, getAttributes, getAugmentationKey, getClassifier, getComponents, getConditionals, getDescription, getEndpoints, getId, getLabel, getOrder, getScope, getType, isTranslatable, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Column

addCellCssClass, addCellCssClass, addCellCssClass, addHeaderCssClass, addHeaderCssClass, addHeaderCssClass, align, alignCenter, alignLeft, alignRight, clearCellCssClasses, clearHeaderCssClasses, colSpan, colSpan, filterAndSortAlias, getDataCellCssClasses, getHeaderCssClasses, name, notSortable, removeCellCssClass, removeCellCssClass, removeCellCssClass, removeHeaderCssClass, removeHeaderCssClass, removeHeaderCssClass, sortable, sortable, width

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component

addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent

addCssClass, addCssClass, addCssClass, clearCssClasses, getCssClasses, removeCssClass, removeCssClass, removeCssClass

Constructor Details

AbstractColumn

public AbstractColumn()

AbstractColumn

public AbstractColumn(String type)

AbstractColumn

public AbstractColumn(Column<?> component)

Method Details

getAlign

public String getAlign()

Description copied from interface: Column

Defines the alignment of column data as either "left", "center", or "right". Default is "left" if not set.

Specified by:

getAlign in interface Column<C extends AbstractColumn<C>>

Returns:

the alignment

getColSpan

public String getColSpan()

Description copied from interface: Column

Defines the number of column lengths this column spans. Useful for making a name or description column span multiple column lengths.

Specified by:

getColSpan in interface Column<C extends AbstractColumn<C>>

Returns:

the col span

getName

public String getName()

Description copied from interface: Column

The name of the property this column will display.

Specified by:

getName in interface Column<C extends AbstractColumn<C>>

Returns:

the name

isSortable

public boolean isSortable()

Description copied from interface: Column

Whether or not the column is sortable.

Specified by:

isSortable in interface Column<C extends AbstractColumn<C>>

Returns:

whether or not sortable.

getWidth

public String getWidth()

Description copied from interface: Column

Defines a fixed width for this column. By default, all columns are auto-sized according to their content.

Supports width values compatible with the CSS width property, for example:

• 100px
• 100
• 4rem
• 3em
• 50%

Specified by:

getWidth in interface Column<C extends AbstractColumn<C>>

Returns:

the width

setAlign

public void setAlign(String align)

Description copied from interface: Column

Sets the alignment.

Specified by:

setAlign in interface Column<C extends AbstractColumn<C>>

Parameters:

align - the alignment

setColSpan

public void setColSpan(String colSpan)

Description copied from interface: Column

Sets the column span.

Specified by:

setColSpan in interface Column<C extends AbstractColumn<C>>

Parameters:

colSpan - the col span

setName

public void setName(String name)

Description copied from interface: Column

Sets the name.

Specified by:

setName in interface Column<C extends AbstractColumn<C>>

Parameters:

name - the name

setSortable

public void setSortable(boolean sortable)

Description copied from interface: Column

Sets whether or not sortable.

Specified by:

setSortable in interface Column<C extends AbstractColumn<C>>

Parameters:

sortable - whether or not sortable

setWidth

public void setWidth(String width)

Description copied from interface: Column

Sets the width of the column.

Specified by:

setWidth in interface Column<C extends AbstractColumn<C>>

Parameters:

width - the width

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractComponent<C extends AbstractColumn<C>>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractComponent<C extends AbstractColumn<C>>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractComponent<C extends AbstractColumn<C>>