|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hivemind.impl.BaseLocatable
org.apache.tapestry.AbstractComponent
org.apache.tapestry.form.AbstractFormComponent
org.apache.tapestry.contrib.form.MultiplePropertySelection
A component which uses <input type=checkbox> to set a property of some object. Typically,
the values for the object are defined using an Enum
. A
MultiplePropertySelection is dependent on an {link IPropertySelectionModel} to provide the list
of possible values.
Often, this is used to select one or more Enum
to assign to
a property; the EnumPropertySelectionModel
class simplifies
this.
The Palette
component is more powerful, but requires
client-side JavaScript and is not fully cross-browser compatible.
Parameter | Type | Direction | Required | Default | Description |
selectedList | java.util.List | in-out | yes | The property to set. During rendering, this property is read, and sets the default value of the options in the select. When the form is submitted, list is cleared, then has each selected option added to it. | |
renderer | IMultiplePropertySelectionRenderer |
in | no | shared instance of CheckBoxMultiplePropertySelectionRenderer |
Defines the object used to render this component. The default renders a table of checkboxes. |
model | IPropertySelectionModel |
in | yes | The model provides a list of possible labels, and matches those labels against possible values that can be assigned back to the property. | |
disabled | boolean | in | no | false | Controls whether the <select> is active or not. A disabled PropertySelection does not
update its value parameter.
Corresponds to the |
Informal parameters are not allowed.
Field Summary | |
static IMultiplePropertySelectionRenderer |
DEFAULT_CHECKBOX_RENDERER
A shared instance of CheckBoxMultiplePropertySelectionRenderer . |
Constructor Summary | |
MultiplePropertySelection()
|
Method Summary | |
protected void |
finishLoad()
|
abstract org.apache.tapestry.form.IPropertySelectionModel |
getModel()
|
abstract IMultiplePropertySelectionRenderer |
getRenderer()
|
abstract boolean |
isDisabled()
Returns true if the component is disabled (this is relevant to the renderer). |
protected void |
renderComponent(org.apache.tapestry.IMarkupWriter writer,
org.apache.tapestry.IRequestCycle cycle)
Renders the component, much of which is the responsiblity of the renderer . |
abstract void |
setRenderer(IMultiplePropertySelectionRenderer renderer)
|
Methods inherited from class org.apache.tapestry.form.AbstractFormComponent |
getDisplayName, getForm, getForm, getName, setForm, setName |
Methods inherited from class org.apache.tapestry.AbstractComponent |
addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainer, setId, setNamespace, setPage, setProperty, toString |
Methods inherited from class org.apache.hivemind.impl.BaseLocatable |
getLocation, setLocation |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.tapestry.IComponent |
addAsset, addBody, addComponent, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getProperty, getSpecification, isRendering, renderBody, setBinding, setContainer, setId, setNamespace, setPage, setProperty |
Methods inherited from interface org.apache.tapestry.IRender |
render |
Methods inherited from interface org.apache.hivemind.LocationHolder |
setLocation |
Methods inherited from interface org.apache.hivemind.Locatable |
getLocation |
Field Detail |
public static final IMultiplePropertySelectionRenderer DEFAULT_CHECKBOX_RENDERER
CheckBoxMultiplePropertySelectionRenderer
.
Constructor Detail |
public MultiplePropertySelection()
Method Detail |
protected void finishLoad()
public abstract boolean isDisabled()
protected void renderComponent(org.apache.tapestry.IMarkupWriter writer, org.apache.tapestry.IRequestCycle cycle)
renderer
. The possible options, their labels, and
the values to be encoded in the form are provided by the
model
.
public abstract org.apache.tapestry.form.IPropertySelectionModel getModel()
public abstract IMultiplePropertySelectionRenderer getRenderer()
public abstract void setRenderer(IMultiplePropertySelectionRenderer renderer)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |