info.magnolia.cms.gui.controlx.list
Class ListControl

java.lang.Object
  info.magnolia.cms.gui.controlx.impl.AbstractControl
      info.magnolia.cms.gui.controlx.list.ListControl

All Implemented Interfaces:

Control

public class ListControl
extends AbstractControl

A list. Can sort or group data.

Version:

$Revision: 41137 $ ($Author: gjoseph $)

Author:

Philipp Bracher

Field Summary

static String

RENDER_TYPE The type used for rendering

Constructor Summary

ListControl()
Constructor.

Method Summary

void	addColumn(ListColumn column)
void	addGroupableField(String name)
void	addSortableField(String name)
String	getColumnLabel(String name) Get the lable of a specific
ContextMenu	getContextMenu()
List	getGroupableFields()
String	getGroupBy()
String	getGroupByOrder()
ListModelIterator	getIterator() Layzy bound iterator.
String	getIteratorId()
Object	getIteratorValue(String name) Get the value for a column in the current iterator.
Object	getIteratorValueObject() Get the current object (not the value) in the current iterator.
int	getMaxRowsPerGroup()
ListModel	getModel()
List	getSortableFields()
String	getSortBy()
String	getSortByOrder()
void	resetIterator() Restart the iterator.
void	setContextMenu(ContextMenu contextMenu)
void	setGroupBy(String name)
void	setGroupByOrder(String order)
void	setMaxRowsPerGroup(int maxRowsPerGroup)
void	setModel(ListModel model)
void	setSortBy(String name)
void	setSortByOrder(String order)

Methods inherited from class info.magnolia.cms.gui.controlx.impl.AbstractControl

addChild, getChild, getChildren, getName, getParent, getRenderer, getRenderKit, getRenderType, removeAllChildren, removeChild, render, setName, setParent, setRenderer, setRenderKit, setRenderType

Methods inherited from class java.lang.Object

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

Field Detail

RENDER_TYPE

public static final String RENDER_TYPE

The type used for rendering

See Also:

Constant Field Values

Constructor Detail

ListControl

public ListControl()

Constructor. Setting the render type.

Method Detail

getModel

public ListModel getModel()

setModel

public void setModel(ListModel model)

addColumn

public void addColumn(ListColumn column)

See Also:

addColumn(info.magnolia.cms.gui.controlx.list.ListColumn)

getIterator

public ListModelIterator getIterator()

Layzy bound iterator.

Returns:

Returns the iterator.

getIteratorValue

public Object getIteratorValue(String name)

Get the value for a column in the current iterator.

Parameters:

name -

Returns:

the value

getIteratorValueObject

public Object getIteratorValueObject()

Get the current object (not the value) in the current iterator.

Returns:

the object. corresponds to a row.

getIteratorId

public String getIteratorId()

resetIterator

public void resetIterator()

Restart the iterator.

getContextMenu

public ContextMenu getContextMenu()

setContextMenu

public void setContextMenu(ContextMenu contextMenu)

getGroupableFields

public List getGroupableFields()

getSortableFields

public List getSortableFields()

addSortableField

public void addSortableField(String name)

addGroupableField

public void addGroupableField(String name)

getMaxRowsPerGroup

public int getMaxRowsPerGroup()

setMaxRowsPerGroup

public void setMaxRowsPerGroup(int maxRowsPerGroup)

getGroupBy

public String getGroupBy()

See Also:

ListModel.getGroupBy()

getGroupByOrder

public String getGroupByOrder()

See Also:

ListModel.getGroupByOrder()

getSortBy

public String getSortBy()

See Also:

ListModel.getSortBy()

getSortByOrder

public String getSortByOrder()

See Also:

ListModel.getSortByOrder()

setGroupBy

public void setGroupBy(String name)

See Also:

ListModel.setGroupBy(java.lang.String)

setGroupByOrder

public void setGroupByOrder(String order)

See Also:

ListModel.setGroupBy(java.lang.String)

getColumnLabel

public String getColumnLabel(String name)

Get the lable of a specific

Parameters:

name -

Returns:

setSortBy

public void setSortBy(String name)

See Also:

ListModel.setSortBy(java.lang.String)

setSortByOrder

public void setSortByOrder(String order)