org.opencms.workplace.list
Class CmsListColumnDefinition

java.lang.Object
  org.opencms.workplace.list.CmsListColumnDefinition

Direct Known Subclasses:

CmsListItemDetails

public class CmsListColumnDefinition

extends Object

Html list column definition.

Since:

6.0.0

Version:

$Revision: 1.21 $

Author:

Michael Moossen

Field Summary

static String	ICON_DOWN Standard list button location.
static String	ICON_UP Standard list button location.

Constructor Summary

CmsListColumnDefinition(String id)
Default Constructor.

Method Summary

void	addDirectAction(I_CmsListDirectAction listAction) Adds a new action to the column.
CmsListColumnAlignEnum	getAlign() Returns the align.
I_CmsListDirectAction	getDefaultAction() Returns the default Action.
I_CmsListDirectAction	getDirectAction(String actionId) Returns a direct action by id.
List	getDirectActions() Returns all direct actions.
I_CmsListFormatter	getFormatter() Returns the data formatter.
CmsMessageContainer	getHelpText() Returns the customized help Text.
String	getId() Returns the id.
I_CmsListItemComparator	getListItemComparator() Returns the comparator, used for sorting.
CmsMessageContainer	getName() Returns the name.
String	getWidth() Returns the width.
String	htmlCell(CmsListItem item, CmsWorkplace wp) returns the html for a cell.
String	htmlHeader(CmsHtmlList list, CmsWorkplace wp) Returns the html code for a column header.
boolean	isSorteable() Returns the sorteable.
boolean	isTextWrapping() Returns the text Wrapping flag.
boolean	isVisible() Returns the visible.
void	setAlign(CmsListColumnAlignEnum align) Sets the align.
void	setDefaultAction(CmsListDefaultAction defaultAction) Sets the default Action.
void	setFormatter(I_CmsListFormatter formatter) Sets the data formatter.
void	setHelpText(CmsMessageContainer helpText) Sets the customized help Text.
void	setListItemComparator(I_CmsListItemComparator comparator) Sets the comparator, used for sorting.
void	setName(CmsMessageContainer name) Sets the name.
void	setSorteable(boolean sorteable) Indicates if the current column is sorteable or not.
void	setTextWrapping(boolean textWrapping) Sets the text Wrapping flag.
void	setVisible(boolean visible) Sets the visible.
void	setWidth(String width) Sets the width.

Methods inherited from class java.lang.Object

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

Field Detail

ICON_DOWN

public static final String ICON_DOWN

Standard list button location.

See Also:

Constant Field Values

ICON_UP

public static final String ICON_UP

Standard list button location.

See Also:

Constant Field Values

Constructor Detail

CmsListColumnDefinition

public CmsListColumnDefinition(String id)

Default Constructor.

Parameters:

id - the unique id

Method Detail

addDirectAction

public void addDirectAction(I_CmsListDirectAction listAction)

Adds a new action to the column.

Parameters:

listAction - the action to add

getAlign

public CmsListColumnAlignEnum getAlign()

Returns the align.

Returns:

the align

getDefaultAction

public I_CmsListDirectAction getDefaultAction()

Returns the default Action.

Returns:

the default Action

getDirectAction

public I_CmsListDirectAction getDirectAction(String actionId)

Returns a direct action by id.

Parameters:

actionId - the id of the action

Returns:

the action if found or null

getDirectActions

public List getDirectActions()

Returns all direct actions.

Returns:

a list of I_CmsListDirectActions.

getFormatter

public I_CmsListFormatter getFormatter()

Returns the data formatter.

Returns:

the data formatter

getHelpText

public CmsMessageContainer getHelpText()

Returns the customized help Text.

if null a default help text indicating the sort actions is used.

Returns:

the customized help Text

getId

public String getId()

Returns the id.

Returns:

the id

getListItemComparator

public I_CmsListItemComparator getListItemComparator()

Returns the comparator, used for sorting.

if no comparator was set, the default list item comparator is used.

Returns:

the comparator

See Also:

CmsListItemDefaultComparator

getName

public CmsMessageContainer getName()

Returns the name.

Returns:

the name

getWidth

public String getWidth()

Returns the width.

Returns:

the width

htmlCell

public String htmlCell(CmsListItem item,
                       CmsWorkplace wp)

returns the html for a cell.

Parameters:

item - the item to render the cell for

wp - the workplace context

Returns:

html code

htmlHeader

public String htmlHeader(CmsHtmlList list,
                         CmsWorkplace wp)

Returns the html code for a column header.

Parameters:

list - the list to generate the header code for

wp - the workplace instance

Returns:

html code

isSorteable

public boolean isSorteable()

Returns the sorteable.

Returns:

the sorteable

isTextWrapping

public boolean isTextWrapping()

Returns the text Wrapping flag.

Returns:

the text Wrapping flag

isVisible

public boolean isVisible()

Returns the visible.

Returns:

the visible

setAlign

public void setAlign(CmsListColumnAlignEnum align)

Sets the align.

Parameters:

align - the align to set

setDefaultAction

public void setDefaultAction(CmsListDefaultAction defaultAction)

Sets the default Action.

Parameters:

defaultAction - the default Action to set

setFormatter

public void setFormatter(I_CmsListFormatter formatter)

Sets the data formatter.

Parameters:

formatter - the data formatter to set

setHelpText

public void setHelpText(CmsMessageContainer helpText)

Sets the customized help Text.

if null a default help text indicating the sort actions is used.

Parameters:

helpText - the customized help Text to set

setListItemComparator

public void setListItemComparator(I_CmsListItemComparator comparator)

Sets the comparator, used for sorting.

Parameters:

comparator - the comparator to set

setName

public void setName(CmsMessageContainer name)

Sets the name.

Parameters:

name - the name to set

setSorteable

public void setSorteable(boolean sorteable)

Indicates if the current column is sorteable or not.

if true a default list item comparator is used.

if false any previously set list item comparator is removed.

Parameters:

sorteable - the sorteable flag

setTextWrapping

public void setTextWrapping(boolean textWrapping)

Sets the text Wrapping flag.

Parameters:

textWrapping - the text Wrapping flag to set

setVisible

public void setVisible(boolean visible)

Sets the visible.

Parameters:

visible - the visible to set

setWidth

public void setWidth(String width)

Sets the width.

Parameters:

width - the width to set