org.bridje.web.view.controls

Class ControlPlaceHolder

java.lang.Object

org.bridje.web.view.controls.Control

org.bridje.web.view.controls.ControlPlaceHolder

public class ControlPlaceHolder
extends Control

A control that represents a placeholder for a layout. This controls can be overwritten by the corresponding Defines objects.

Constructor Summary

Constructors

Constructor and Description
ControlPlaceHolder()

Method Summary

Modifier and Type	Method and Description
void	doOverride(Map<String,Defines> definesMap) This method must be implemented by all controls in order for it to override all its placeholder objects.
EventResult	executeEvent(ControlInputReader req, ElEnvironment env) Executes any event sent from the client to the server.
<T> T	findById(ElEnvironment env, String id, ControlCallback<T> callback) Finds a control recursively by id.
String	getName() The name of the placeholder.
void	readInput(ControlInputReader req, ElEnvironment env) Reads the input recursively for this and all the child controls sent in the given HTTP request.

Methods inherited from class org.bridje.web.view.controls.Control

childs, doExecuteEvent, doFindById, doOverride, doOverride, doReadInput, events, eventTriggered, get, get, getId, getVisible, inputFiles, inputs, invokeEvent, override, resources, set, set

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlPlaceHolder

public ControlPlaceHolder()

Method Detail

getName

public String getName()

The name of the placeholder.

Returns:

The name of the placeholder.

findById

public <T> T findById(ElEnvironment env,
                      String id,
                      ControlCallback<T> callback)

Description copied from class: Control

Finds a control recursively by id.

Specified by:

findById in class Control

Type Parameters:

T - The result type for the callback.

Parameters:

env - The EL environment.

id - The control id.

callback - The callback when the control is found.

Returns:

The control found.

readInput

public void readInput(ControlInputReader req,
                      ElEnvironment env)

Description copied from class: Control

Reads the input recursively for this and all the child controls sent in the given HTTP request.

Specified by:

readInput in class Control

Parameters:

req - The HTTP request to read the input from.

env - The EL environment to write the data to.

executeEvent

public EventResult executeEvent(ControlInputReader req,
                                ElEnvironment env)

Description copied from class: Control

Executes any event sent from the client to the server.

Specified by:

executeEvent in class Control

Parameters:

req - The HTTP request.

env - The EL environment.

Returns:

The event result.

doOverride

public void doOverride(Map<String,Defines> definesMap)

Description copied from class: Control

This method must be implemented by all controls in order for it to override all its placeholder objects.

Specified by:

doOverride in class Control

Parameters:

definesMap - The source map for the placeholders.