lumis.doui.control.pane

Class PaneControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.DataBoundControl

lumis.doui.control.pane.PaneControl

All Implemented Interfaces:

Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

WikiViewArticlePaneControl

public class PaneControl
extends DataBoundControl

Used to render one of the (n) specified panes when rendering an interface. This control by default renders the first pane. However as a result of a process action or a render action the pane that is displayed may be changed. This pane control is associated with an id and the control listens for this id in the request parameters in order to determine what pane to display.

Example use: <control:lum_pane id="pane" sourceId="none"> <pane id="form"> <!-- Sub controls --> </pane> <pane id="updatedSubscription"> <!-- Sub controls --> </pane> </control:lum_pane> xml data available for xsl rendering: <control id="pane" sourceId="none" type="lum_pane"> <pane id="form"> <!-- Sub controls --> </pane> <pane id="updatedSubscription"> <!-- Sub controls --> </pane> </control:lum_pane>

Since:

4.0.4

Version:

$Revision: 6166 $ $Date: 2007-03-16 18:29:00 +0000 (Fri, 16 Mar 2007) $

Field Summary

Fields inherited from class lumis.doui.control.DataControl

FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, ON_EVENT_VALIDATE, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

Constructors

Constructor and Description
PaneControl()

Method Summary

Modifier and Type	Method and Description
void	buildSubControls() This method identifies one of the panes to render and deletes all the other panes from its definition
protected String	getRequestParameterName()
void	setRenderData()

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRuntimeDefaultSource, getSource, getSourceById, getUnboundedConverter, init, loadFromRequest, setDefaultValue, setRawValue, setReload, setSourceParameter, setSourceParameters, setsSourceParameters, setValid, setValueFromSource, setValueFromSource, update

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, getConverter, getDataType, getDefaultValue, getParameterValue, getProcessActionIds, getValue, getValue, getValueClass, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getSourceContext, getStringsToLocalize, getType, getValidationScript, getWindowProperties, getWindowProperties, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setName, setRuntimeAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.doui.control.IDataControl

getConverter, getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue

Methods inherited from interface lumis.doui.control.IControl

createContainer, disconnect, getChildControls, getControlResource, getId, getName, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes

Methods inherited from interface lumis.doui.render.IRenderer

getResources, getSourceContext

Constructor Detail

PaneControl

public PaneControl()

Method Detail

buildSubControls

public void buildSubControls()
                      throws PortalException

This method identifies one of the panes to render and deletes all the other panes from its definition

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl

Throws:

PortalException

getRequestParameterName

protected String getRequestParameterName()
                                  throws PortalException

Overrides:

getRequestParameterName in class DataControl

Returns:

Returns the dataId.

Throws:

PortalException