com.arsdigita.bebop
Class ListPanel

java.lang.Object
  com.arsdigita.bebop.Completable
      com.arsdigita.bebop.SimpleComponent
          com.arsdigita.bebop.TextStylable
              com.arsdigita.bebop.BlockStylable
                  com.arsdigita.bebop.SimpleContainer
                      com.arsdigita.bebop.ListPanel

All Implemented Interfaces:

Cloneable, Component, Container, Lockable

public class ListPanel

extends SimpleContainer

A container that outputs its components in a <list>. Each child is printed in its own list item. The components are put into the list in the order in which they were added to the ListPanel, progressing from top to bottom.

ListPanels can be ordered or unordered.

Version:

$Id: //core-platform/dev/src/com/arsdigita/bebop/ListPanel.java#6 $

Author:

Christian Brechbühler (christian@arsdigita.com)

Field Summary

static boolean	ORDERED
static boolean	UNORDERED
static String	versionId

Fields inherited from class com.arsdigita.bebop.BlockStylable

ABSBOTTOM, ABSMIDDLE, BASELINE, BOTTOM, CENTER, FULL_WIDTH, INSERT, LEFT, MIDDLE, RIGHT, TEXTTOP, TOP

Fields inherited from class com.arsdigita.bebop.SimpleComponent

m_attr

Fields inherited from interface com.arsdigita.bebop.Component

BEBOP_XML_NS, CLASS, ID, ON_CLICK, STYLE

Constructor Summary

ListPanel(boolean ordered)
Creates a simple list.

Method Summary

void	generateXML(PageState state, Element parent) Adds child components as a subtree under list-item nodes.

Methods inherited from class com.arsdigita.bebop.SimpleContainer

add, add, children, contains, generateChildrenXML, generateParent, get, getNamespace, getTag, indexOf, isEmpty, setNamespace, setTag, size

Methods inherited from class com.arsdigita.bebop.BlockStylable

setBorder, setBorder, setBorderColor, setHorizontalAlignment, setMargin, setMargin, setPadding, setPadding, setVerticalAlignment

Methods inherited from class com.arsdigita.bebop.TextStylable

setBackgroundColor, setColor

Methods inherited from class com.arsdigita.bebop.SimpleComponent

clone, exportAttributes, getAttribute, getClassAttr, getIdAttr, getKey, getMetaDataAttribute, getStyleAttr, hasAttributes, isLocked, isVisible, lock, register, register, respond, setAttribute, setClassAttr, setIdAttr, setKey, setMetaDataAttribute, setStyleAttr, setVisible

Methods inherited from class com.arsdigita.bebop.Completable

addCompletionListener, fireCompletionEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arsdigita.bebop.Component

getClassAttr, getIdAttr, getKey, getStyleAttr, isVisible, register, register, respond, setClassAttr, setIdAttr, setKey, setStyleAttr, setVisible

Methods inherited from interface com.arsdigita.util.Lockable

isLocked, lock

Field Detail

versionId

public static final String versionId

See Also:

Constant Field Values

ORDERED

public static final boolean ORDERED

See Also:

Constant Field Values

UNORDERED

public static final boolean UNORDERED

See Also:

Constant Field Values

Constructor Detail

ListPanel

public ListPanel(boolean ordered)

Creates a simple list.

Parameters:

ordered - true is an ordered (numbered) list; false is an unordered (bulleted) list

Method Detail

generateXML

public void generateXML(PageState state,
                        Element parent)

Adds child components as a subtree under list-item nodes.

Generates a DOM fragment:

 <bebop:listPanel>
   <bebop:cell> ... cell contents </bebop:cell>
   <bebop:cell> ... cell contents </bebop:cell>
   ...
 </bebop:list>

Specified by:

generateXML in interface Component

Overrides:

generateXML in class SimpleContainer

Parameters:

state - the state of the current request

parent - the node under which this subtree will be added

See Also:

SimpleContainer.setTag(String), SimpleContainer.setNamespace(String)