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

Interface DateColumn<C extends DateColumn<C>>

All Superinterfaces:

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

All Known Subinterfaces:

DateRangeColumn<C>

All Known Implementing Classes:

DefaultDateColumn, DefaultDateRangeColumn

public interface DateColumn<C extends DateColumn<C>>
extends Column<C>

Author:

Nathan Moore (nathandmoore)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DateColumn.Attributes
static final class	DateColumn.TimeZoneFormatSuffixes	Append these to one of DateFormatTypes to display time-zone.

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

Method Summary

Modifier and Type	Method	Description
default C	dateFormat(String format)	Adds the DateColumn.Attributes.DATE_FORMAT attribute.
default C	dateTimeSeparator(String separator)	Adds the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute.
default Optional<String>	findDateFormat()	Finds the DateColumn.Attributes.DATE_FORMAT attribute.
default Optional<String>	findDateTimeSeparator()	Finds the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute.
default String	getDateFormat()	Gets the DateColumn.Attributes.DATE_FORMAT attribute.
default String	getDateTimeSeparator()	Gets the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute.
default boolean	hasDateFormat()	Checks whether the DateColumn.Attributes.DATE_FORMAT attribute has been set.
default boolean	hasDateTimeSeparator()	Checks whether the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute has been set.
default C	removeDateFormat()	Removes the DateColumn.Attributes.DATE_FORMAT attribute.
default C	removeDateTimeSeparator()	Removes the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute.

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, getAlign, getColSpan, getDataCellCssClasses, getHeaderCssClasses, getName, getWidth, isSortable, name, notSortable, removeCellCssClass, removeCellCssClass, removeCellCssClass, removeHeaderCssClass, removeHeaderCssClass, removeHeaderCssClass, setAlign, setColSpan, setName, setSortable, setWidth, 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, addSimpleComponent, apply, attribute, augmentable, 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, getAugmentableFlag, 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, setAugmentable, 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

Method Details

dateFormat

default C dateFormat(String format)

Adds the DateColumn.Attributes.DATE_FORMAT attribute.

Parameters:

format - The format to set. See DateFormatTypes

Returns:

this

getDateFormat

@Nullable
default String getDateFormat()

Gets the DateColumn.Attributes.DATE_FORMAT attribute.

Returns:

the value of the attribute

findDateFormat

default Optional<String> findDateFormat()

Finds the DateColumn.Attributes.DATE_FORMAT attribute.

Returns:

the value of the attribute or Optional.empty() if not present.

removeDateFormat

default C removeDateFormat()

Removes the DateColumn.Attributes.DATE_FORMAT attribute.

Returns:

this

hasDateFormat

default boolean hasDateFormat()

Checks whether the DateColumn.Attributes.DATE_FORMAT attribute has been set.

Returns:

Whether the attribute is set.

dateTimeSeparator

default C dateTimeSeparator(String separator)

Adds the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute.

Parameters:

separator - The separator to set. See DateFormatTypes

Returns:

this

getDateTimeSeparator

@Nullable
default String getDateTimeSeparator()

Gets the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute.

Returns:

the value of the attribute

findDateTimeSeparator

default Optional<String> findDateTimeSeparator()

Finds the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute.

Returns:

the value of the attribute or Optional.empty() if not present

removeDateTimeSeparator

default C removeDateTimeSeparator()

Removes the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute.

Returns:

this

hasDateTimeSeparator

default boolean hasDateTimeSeparator()

Checks whether the DateColumn.Attributes.DATE_TIME_SEPARATOR attribute has been set.

Returns:

Whether the attribute is set.