org.uberfire.ext.wires.core.grids.client.model.impl

Class BaseGridColumn<T>

java.lang.Object

org.uberfire.ext.wires.core.grids.client.model.impl.BaseGridColumn<T>

All Implemented Interfaces:

GridColumn<T>

Direct Known Subclasses:

BooleanDOMElementColumn, ListBoxDOMElementSingletonColumn, RowNumberColumn, StringDOMElementColumn, StringDOMElementSingletonColumn, StringPopupColumn

public class BaseGridColumn<T>
extends Object
implements GridColumn<T>

Base implementation of a grid column to avoid boiler-plate for more specific implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface org.uberfire.ext.wires.core.grids.client.model.GridColumn

GridColumn.ColumnWidthMode, GridColumn.HeaderMetaData

Field Summary

Fields

Modifier and Type	Field and Description
protected String	placeHolder

Constructor Summary

Constructors

Constructor and Description
BaseGridColumn(GridColumn.HeaderMetaData headerMetaData, GridColumnRenderer<T> columnRenderer, double width)
BaseGridColumn(GridColumn.HeaderMetaData headerMetaData, GridColumnRenderer<T> columnRenderer, double width, String placeHolder)
BaseGridColumn(List<GridColumn.HeaderMetaData> headerMetaData, GridColumnRenderer<T> columnRenderer, double width)
BaseGridColumn(List<GridColumn.HeaderMetaData> headerMetaData, GridColumnRenderer<T> columnRenderer, double width, String placeHolder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
GridColumnRenderer<T>	getColumnRenderer() Returns the Render for the column
GridColumn.ColumnWidthMode	getColumnWidthMode() Get column width mode
List<GridColumn.HeaderMetaData>	getHeaderMetaData() Returns the MetaData for the Header.
int	getIndex() Returns the logical index to which this column relates.
GridColumn<?>	getLink() Returns the column to which this column is linked
Double	getMaximumWidth() Returns the maximum width to which the column can be re-sized
Double	getMinimumWidth() Returns the minimum width to which the column can be re-sized
String	getPlaceHolder()
double	getWidth() Returns the column's width
int	hashCode()
boolean	isFloatable() Returns a flag indicating whether a column is capable of floating on the left-hand side of the table when clipped horizontally.
boolean	isLinked() Returns a flag indicating this column is linked to another
boolean	isMovable() Returns a flag indicating whether a column can be moved.
boolean	isResizable() Returns a flag indicating whether a column can be re-sized.
boolean	isVisible() Returns a flag indicating whether a column is visible.
void	setColumnWidthMode(GridColumn.ColumnWidthMode columnWidthMode) Set column width mode
void	setFloatable(boolean isFloatable) Sets whether the column is capable of floating on the left-hand side of the table when clipped horizontally.
void	setIndex(int index) Sets the logical index of the column, to support indirection of columns' access to row data.
void	setLink(GridColumn<?> link) Sets the column to which this column is linked
void	setMaximumWidth(Double maximumWidth) Sets the maximum width to which the column can be re-sized
void	setMinimumWidth(Double minimumWidth) Sets the minimum width to which the column can be re-sized
void	setMovable(boolean isMovable) Sets whether the column can be moved.
void	setPlaceHolder(String placeHolder)
void	setResizable(boolean isResizable) Sets whether the column can be re-sized.
void	setVisible(boolean isVisible) Sets whether the column is visible.
void	setWidth(double width) Sets the columns width

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.uberfire.ext.wires.core.grids.client.model.GridColumn

edit, edit

Field Detail

placeHolder

protected String placeHolder

Constructor Detail

BaseGridColumn

public BaseGridColumn(GridColumn.HeaderMetaData headerMetaData,
                      GridColumnRenderer<T> columnRenderer,
                      double width)

BaseGridColumn

public BaseGridColumn(List<GridColumn.HeaderMetaData> headerMetaData,
                      GridColumnRenderer<T> columnRenderer,
                      double width)

BaseGridColumn

public BaseGridColumn(GridColumn.HeaderMetaData headerMetaData,
                      GridColumnRenderer<T> columnRenderer,
                      double width,
                      String placeHolder)

BaseGridColumn

public BaseGridColumn(List<GridColumn.HeaderMetaData> headerMetaData,
                      GridColumnRenderer<T> columnRenderer,
                      double width,
                      String placeHolder)

Method Detail

getHeaderMetaData

public List<GridColumn.HeaderMetaData> getHeaderMetaData()

Description copied from interface: GridColumn

Returns the MetaData for the Header. Each entry represents a row in the header. Index 0 represents the first (top-down) row, Index 1 represents the second row etc.

Specified by:

getHeaderMetaData in interface GridColumn<T>

Returns:

getColumnRenderer

public GridColumnRenderer<T> getColumnRenderer()

Description copied from interface: GridColumn

Returns the Render for the column

Specified by:

getColumnRenderer in interface GridColumn<T>

Returns:

getWidth

public double getWidth()

Description copied from interface: GridColumn

Returns the column's width

Specified by:

getWidth in interface GridColumn<T>

Returns:

setWidth

public void setWidth(double width)

Description copied from interface: GridColumn

Sets the columns width

Specified by:

setWidth in interface GridColumn<T>

isLinked

public boolean isLinked()

Description copied from interface: GridColumn

Returns a flag indicating this column is linked to another

Specified by:

isLinked in interface GridColumn<T>

Returns:

getLink

public GridColumn<?> getLink()

Description copied from interface: GridColumn

Returns the column to which this column is linked

Specified by:

getLink in interface GridColumn<T>

Returns:

setLink

public void setLink(GridColumn<?> link)

Description copied from interface: GridColumn

Sets the column to which this column is linked

Specified by:

setLink in interface GridColumn<T>

getIndex

public int getIndex()

Description copied from interface: GridColumn

Returns the logical index to which this column relates. Columns may be re-ordered and therefore, to avoid manipulating the underlying row data, the logical index of the column may be different to their physical index (i.e. the order in which they were added to the grid).

Specified by:

getIndex in interface GridColumn<T>

Returns:

setIndex

public void setIndex(int index)

Description copied from interface: GridColumn

Sets the logical index of the column, to support indirection of columns' access to row data.

Specified by:

setIndex in interface GridColumn<T>

isResizable

public boolean isResizable()

Description copied from interface: GridColumn

Returns a flag indicating whether a column can be re-sized.

Specified by:

isResizable in interface GridColumn<T>

Returns:

true if the column can be re-sized.

setResizable

public void setResizable(boolean isResizable)

Description copied from interface: GridColumn

Sets whether the column can be re-sized.

Specified by:

setResizable in interface GridColumn<T>

Parameters:

isResizable - true if the column can be re-sized.

isMovable

public boolean isMovable()

Description copied from interface: GridColumn

Returns a flag indicating whether a column can be moved.

Specified by:

isMovable in interface GridColumn<T>

Returns:

true if the column can be moved.

setMovable

public void setMovable(boolean isMovable)

Description copied from interface: GridColumn

Sets whether the column can be moved.

Specified by:

setMovable in interface GridColumn<T>

Parameters:

isMovable - true if the column can be moved.

isFloatable

public boolean isFloatable()

Description copied from interface: GridColumn

Returns a flag indicating whether a column is capable of floating on the left-hand side of the table when clipped horizontally.

Specified by:

isFloatable in interface GridColumn<T>

Returns:

true if the column is capable of floating.

setFloatable

public void setFloatable(boolean isFloatable)

Description copied from interface: GridColumn

Sets whether the column is capable of floating on the left-hand side of the table when clipped horizontally.

Specified by:

setFloatable in interface GridColumn<T>

Parameters:

isFloatable - true if the column can be floated.

isVisible

public boolean isVisible()

Description copied from interface: GridColumn

Returns a flag indicating whether a column is visible.

Specified by:

isVisible in interface GridColumn<T>

Returns:

true if the column is visible.

setVisible

public void setVisible(boolean isVisible)

Description copied from interface: GridColumn

Sets whether the column is visible.

Specified by:

setVisible in interface GridColumn<T>

Parameters:

isVisible - true if the column is visible.

getMinimumWidth

public Double getMinimumWidth()

Description copied from interface: GridColumn

Returns the minimum width to which the column can be re-sized

Specified by:

getMinimumWidth in interface GridColumn<T>

Returns:

null if no minimum

setMinimumWidth

public void setMinimumWidth(Double minimumWidth)

Description copied from interface: GridColumn

Sets the minimum width to which the column can be re-sized

Specified by:

setMinimumWidth in interface GridColumn<T>

Parameters:

minimumWidth - Minimum width, or null if no minimum width

getMaximumWidth

public Double getMaximumWidth()

Description copied from interface: GridColumn

Returns the maximum width to which the column can be re-sized

Specified by:

getMaximumWidth in interface GridColumn<T>

Returns:

null if no maximum

setMaximumWidth

public void setMaximumWidth(Double maximumWidth)

Description copied from interface: GridColumn

Sets the maximum width to which the column can be re-sized

Specified by:

setMaximumWidth in interface GridColumn<T>

Parameters:

maximumWidth - Maximum width, or null if no minimum width

getPlaceHolder

public String getPlaceHolder()

setPlaceHolder

public void setPlaceHolder(String placeHolder)

getColumnWidthMode

public GridColumn.ColumnWidthMode getColumnWidthMode()

Description copied from interface: GridColumn

Get column width mode

Specified by:

getColumnWidthMode in interface GridColumn<T>

Returns:

setColumnWidthMode

public void setColumnWidthMode(GridColumn.ColumnWidthMode columnWidthMode)

Description copied from interface: GridColumn

Set column width mode

Specified by:

setColumnWidthMode in interface GridColumn<T>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object