|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.list.CmsListColumnDefinition
Html list column definition.
Field Summary | |
static java.lang.String |
ICON_DOWN
Standard list button location. |
static java.lang.String |
ICON_UP
Standard list button location. |
Constructor Summary | |
CmsListColumnDefinition(java.lang.String id)
Default Constructor. |
Method Summary | |
void |
addDefaultAction(CmsListDefaultAction defaultAction)
Adds a default Action. |
void |
addDirectAction(I_CmsListDirectAction listAction)
Adds a new action to the column. |
java.lang.String |
csvCell(CmsListItem item,
CmsWorkplace wp)
returns the csv output for a cell. |
java.lang.String |
csvHeader(CmsWorkplace wp)
Returns the csv output for a column header. |
CmsListColumnAlignEnum |
getAlign()
Returns the align. |
CmsListDefaultAction |
getDefaultAction(java.lang.String actionId)
Returns a default action by id. |
java.util.List |
getDefaultActionIds()
Returns the default Action Ids list. |
java.util.List |
getDefaultActions()
Returns the default Actions list. |
I_CmsListDirectAction |
getDirectAction(java.lang.String actionId)
Returns a direct action by id. |
java.util.List |
getDirectActionIds()
Returns the direct Action Ids list. |
java.util.List |
getDirectActions()
Returns all direct actions. |
I_CmsListFormatter |
getFormatter()
Returns the data formatter. |
CmsMessageContainer |
getHelpText()
Returns the customized help Text. |
java.lang.String |
getId()
Returns the id. |
I_CmsListItemComparator |
getListItemComparator()
Returns the comparator, used for sorting. |
CmsMessageContainer |
getName()
Returns the name. |
java.lang.String |
getWidth()
Returns the width. |
java.lang.String |
htmlCell(CmsListItem item,
CmsWorkplace wp,
boolean isPrintable)
returns the html for a cell. |
java.lang.String |
htmlHeader(CmsHtmlList list,
CmsWorkplace wp)
Returns the html code for a column header. |
boolean |
isPrintable()
Returns the printable . |
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 |
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 |
setPrintable(boolean printable)
Sets the printable flag. |
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(java.lang.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 |
public static final java.lang.String ICON_DOWN
public static final java.lang.String ICON_UP
Constructor Detail |
public CmsListColumnDefinition(java.lang.String id)
id
- the unique idMethod Detail |
public void addDefaultAction(CmsListDefaultAction defaultAction)
A column could have more than one default action if the visibilities are complementary.
defaultAction
- the default Action to addpublic void addDirectAction(I_CmsListDirectAction listAction)
listAction
- the action to addpublic java.lang.String csvCell(CmsListItem item, CmsWorkplace wp)
item
- the item to render the cell forwp
- the workplace context
public java.lang.String csvHeader(CmsWorkplace wp)
wp
- the workplace instance
public CmsListColumnAlignEnum getAlign()
public CmsListDefaultAction getDefaultAction(java.lang.String actionId)
actionId
- the id of the action
public java.util.List getDefaultActionIds()
public java.util.List getDefaultActions()
public I_CmsListDirectAction getDirectAction(java.lang.String actionId)
actionId
- the id of the action
public java.util.List getDirectActionIds()
public java.util.List getDirectActions()
I_CmsListDirectAction
s.public I_CmsListFormatter getFormatter()
public CmsMessageContainer getHelpText()
if null
a default help text indicating the sort actions is used.
public java.lang.String getId()
public I_CmsListItemComparator getListItemComparator()
if no comparator was set, the default list item comparator is used.
CmsListItemDefaultComparator
public CmsMessageContainer getName()
public java.lang.String getWidth()
public java.lang.String htmlCell(CmsListItem item, CmsWorkplace wp, boolean isPrintable)
item
- the item to render the cell forwp
- the workplace contextisPrintable
- if the list is to be printed
public java.lang.String htmlHeader(CmsHtmlList list, CmsWorkplace wp)
list
- the list to generate the header code forwp
- the workplace instance
public boolean isPrintable()
public boolean isSorteable()
public boolean isTextWrapping()
public boolean isVisible()
public void setAlign(CmsListColumnAlignEnum align)
align
- the align to setpublic void setFormatter(I_CmsListFormatter formatter)
formatter
- the data formatter to setpublic void setHelpText(CmsMessageContainer helpText)
if null
a default help text indicating the sort actions is used.
helpText
- the customized help Text to setpublic void setListItemComparator(I_CmsListItemComparator comparator)
comparator
- the comparator to setpublic void setName(CmsMessageContainer name)
name
- the name to setpublic void setPrintable(boolean printable)
printable
- the printable flag to setpublic void setSorteable(boolean sorteable)
if true
a default list item comparator is used.
if false
any previously set list item comparator is removed.
sorteable
- the sorteable flagpublic void setTextWrapping(boolean textWrapping)
textWrapping
- the text Wrapping flag to setpublic void setVisible(boolean visible)
visible
- the visible to setpublic void setWidth(java.lang.String width)
width
- the width to set
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |