nl.gx.webmanager.cms.form
Interface PredefinedList

All Superinterfaces:

Wrapper

public interface PredefinedList
extends Wrapper

This class represents the interface for a predefined list. A predefined list is maintained in the Form module (options, predefined lists of type 'list') and can be used to create selection pulldowns in a form from which a user can select the available options. Note that this interface does not cover lists of the type Query, only static lists.

Author:

Ivo Ladage-van Doorn

Method Summary

PredefinedListItem	addItem(java.lang.String value, java.lang.String label, boolean defaultChecked) Adds a new predefined list item.
PredefinedListItem[]	getItems() Returns the items contained by this predefined list.
java.lang.String	getName() Returns the name of this predefined list.
void	setName(java.lang.String name) Sets the name of this predefined list.

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Method Detail

getName

java.lang.String getName()

Returns the name of this predefined list.

Returns:

the name of this predefined list

setName

void setName(java.lang.String name)

Sets the name of this predefined list.

Parameters:

name - the name of this predefined list to set

getItems

PredefinedListItem[] getItems()

Returns the items contained by this predefined list.

Returns:

the items contained by this predefined list.

addItem

PredefinedListItem addItem(java.lang.String value,
                           java.lang.String label,
                           boolean defaultChecked)

Adds a new predefined list item.

Parameters:

value - Value (identifier) of the predefined list item to add

label - Label of the predefined list item to add

defaultChecked - Defines if the list item should be checked by default

Returns:

The created list item.