Package lumis.doui.control

Class ControlContainer

java.lang.Object

lumis.doui.control.ControlContainer

@StableMinor(version="14.1",
             sinceVersion="4.0")
public class ControlContainer
extends Object

Container for all controls.

Since:

4.0.0

Version:

$Revision: 24684 $ $Date: 2021-08-23 18:58:35 -0300 (Mon, 23 Aug 2021) $

Field Summary

Fields

Modifier and Type	Field	Description
static String	RENDER_CONTROL_ID

Constructor Summary

Constructors

Constructor	Description
ControlContainer(DouiContext douiContext)

Method Summary

Modifier and Type	Method	Description
void	addClientSideUpdatableControl(String controlId)
protected void	appendDefaultErrorSummaryControl()
protected void	appendDefaultStyle()
boolean	checkControlPermission(Node controlNode)
protected void	createContainersForClientSideUpdatableControls()
Set<IValidatorControl>	getActionValidatorControls(Node[] actionNodes)
Set<IValidatorControl>	getAllValidatorControls()
String	getClientSideUpdatableControlContainerId(String controlId)
DouiContext	getContentContext()
IControl	getControlById(String id)
IControl	getControlByType(String type)
Map<String,IControl>	getControlsMap()	Returns the map with the controls in this control container.
DouiContext	getDouiContext()
IErrorSummaryControl	getErrorSummaryControl()
IFormControl	getFormControl()
String	getFormName()
String	getRenderData()
void	indexControl(IControl control)
void	init()
void	loadControlsFromRequest()
void	removeControl(IControl control)
void	setControlAsClientSideUpdatable(String controlId)
protected void	setControlRenderData(IControl control)
void	setFormName(String formName)
void	setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)
boolean	validateControls()

Methods inherited from class java.lang.Object

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

Field Detail

RENDER_CONTROL_ID

public static final String RENDER_CONTROL_ID

See Also:

Constant Field Values

Constructor Detail

ControlContainer

public ControlContainer(DouiContext douiContext)

Method Detail

init

public void init()
          throws PortalException

Throws:

PortalException

checkControlPermission

public boolean checkControlPermission(Node controlNode)
                               throws PortalException

Throws:

PortalException

setControlAsClientSideUpdatable

public void setControlAsClientSideUpdatable(String controlId)

getContentContext

public DouiContext getContentContext()

indexControl

public void indexControl(IControl control)
                  throws PortalException

Throws:

PortalException

getControlById

public IControl getControlById(String id)

getControlByType

public IControl getControlByType(String type)

loadControlsFromRequest

public void loadControlsFromRequest()
                             throws PortalException

Throws:

PortalException

getRenderData

public String getRenderData()
                     throws PortalException

Throws:

PortalException

addClientSideUpdatableControl

public void addClientSideUpdatableControl(String controlId)

createContainersForClientSideUpdatableControls

protected void createContainersForClientSideUpdatableControls()
                                                       throws PortalException

Throws:

PortalException

getClientSideUpdatableControlContainerId

public String getClientSideUpdatableControlContainerId(String controlId)
                                                throws PortalException

Throws:

PortalException

setControlRenderData

protected void setControlRenderData(IControl control)
                             throws PortalException

Throws:

PortalException

validateControls

public boolean validateControls()
                         throws PortalException

Throws:

PortalException

setFormName

public void setFormName(String formName)

getFormName

public String getFormName()

setProcessActionHandlerParameters

public void setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)
                                       throws PortalException

Throws:

PortalException

getDouiContext

public DouiContext getDouiContext()

appendDefaultErrorSummaryControl

protected void appendDefaultErrorSummaryControl()
                                         throws PortalException

Throws:

PortalException

appendDefaultStyle

protected void appendDefaultStyle()
                           throws PortalException

Throws:

PortalException

getErrorSummaryControl

public IErrorSummaryControl getErrorSummaryControl()

getActionValidatorControls

public Set<IValidatorControl> getActionValidatorControls(Node[] actionNodes)
                                                  throws PortalException

Throws:

PortalException

getAllValidatorControls

public Set<IValidatorControl> getAllValidatorControls()
                                               throws PortalException

Throws:

PortalException

removeControl

public void removeControl(IControl control)

getFormControl

public IFormControl getFormControl()

Returns:

Returns the formControl.

getControlsMap

public Map<String,IControl> getControlsMap()

Returns the map with the controls in this control container. The key of the map is the id of the control, and the value is the control instance.

Returns:

the map with the controls in this control container.