org.mmbase.framework.basic

Class State

java.lang.Object

org.mmbase.framework.basic.State

public class State
extends Object

State is a wrapper arround HttpServletRequest which maintains the current state of framework component rendering.

Since:

MMBase-1.9

Version:

$Id$

Author:

Michiel Meeuwissen

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY

Constructor Summary

Constructors

Constructor and Description
State(javax.servlet.http.HttpServletRequest r, State s)
State(javax.servlet.ServletRequest r) Use this constructor, if you want to explicitely create a new State object.

Method Summary

Modifier and Type	Method and Description
void	end() At the end of the request (or subcomponent), this method must be called, to indicate that this state is no longer in use.
void	endBlock() After rendering (a certain renderer of) a block, the state must be informed about that.
void	endProcess()
protected String	generateId(int c)
Block	getBlock() The currently rendered block, or null if not rendering.
protected String	getBlockRequestKey()
int	getDepth() With recursive includes of blocks, it may occur that the state is only for components inside a certain other component's block.
Parameters	getFrameworkParameters() Returns the parameters which were used to initialize rendering of the current block.
String	getId() Returns the id of the current block, which uniquely identifies it on the current page (or http request).
Processor	getProcessor()
Renderer	getRenderer()
protected Renderer	getRenderer(Renderer r) Determines what should be rendered now.
javax.servlet.ServletRequest	getRequest()
static State	getState(javax.servlet.ServletRequest request) Returns the framework 'State' object for the given request.
String	getUpcomingId() If rendering not yet started, this returns the id of a component which would begin now.
WindowState	getWindowState() The current window state of rendering.
boolean	isLeading() If the state is leading, then the currently rendered block is not a 'block in a block'.
boolean	isRendering() Whether something is rendered right now.
protected void	localizeContext() Sets up a LocalizationContext attributes based on Component.getBundle()and puts in on the request.
protected boolean	needsProcess()
void	process(Processor proc) Puts this state in 'process' mode
void	render(Renderer rend) Puts this state in 'render' mode.
void	setAction(String a)
void	setBlock(Map<String,Object> map, Block toBlock)
protected void	setType(Renderer.Type t)
Renderer	startBlock(Parameters frameworkParameters, Renderer renderer)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

State

public State(javax.servlet.ServletRequest r)

Use this constructor, if you want to explicitely create a new State object. E.g. when starting a subcomponent. state = getState(req); if (state.isRendering()) { state = new State(req); } But this is only used by code which want to initiate a new component itself. Normally getState(ServletRequest) should suffice.

State

public State(javax.servlet.http.HttpServletRequest r,
             State s)

Method Detail

getState

public static State getState(javax.servlet.ServletRequest request)

Returns the framework 'State' object for the given request.

Returns:

a State. Never null.

getWindowState

public WindowState getWindowState()

The current window state of rendering. As yet unimplemented.

To Do:

getDepth

public int getDepth()

With recursive includes of blocks, it may occur that the state is only for components inside a certain other component's block. In that case the depth > 0.

isLeading

public boolean isLeading()

If the state is leading, then the currently rendered block is not a 'block in a block'.

getRequest

public javax.servlet.ServletRequest getRequest()

end

public void end()

At the end of the request (or subcomponent), this method must be called, to indicate that this state is no longer in use.

endBlock

public void endBlock()

After rendering (a certain renderer of) a block, the state must be informed about that.

endProcess

public void endProcess()

isRendering

public boolean isRendering()

Whether something is rendered right now.

getFrameworkParameters

public Parameters getFrameworkParameters()

Returns the parameters which were used to initialize rendering of the current block. Or null if currently this state is not 'rendering'.

getBlock

public Block getBlock()

The currently rendered block, or null if not rendering.

localizeContext

protected void localizeContext()

Sets up a LocalizationContext attributes based on Component.getBundle()and puts in on the request. This is recognized by fmt:message-tag, which in a JspRenderer can therefore be used without fmt:bundle or fmt:setbundle.

setType

protected void setType(Renderer.Type t)

setAction

public void setAction(String a)

needsProcess

protected boolean needsProcess()

startBlock

public Renderer startBlock(Parameters frameworkParameters,
                           Renderer renderer)

Parameters:

frameworkParameters - The parameters that are required by the framework

renderer - Proposed renderer (State may decide to render another one, and return that)

Returns:

Whether action must be performed.

Throws:

IllegalStateException - When renderers which should occur 'later' were already rendered, or when the belonging request was already 'ended'.

getBlockRequestKey

protected String getBlockRequestKey()

getRenderer

protected Renderer getRenderer(Renderer r)

Determines what should be rendered now.

setBlock

public void setBlock(Map<String,Object> map,
                     Block toBlock)

render

public void render(Renderer rend)

Puts this state in 'render' mode.

process

public void process(Processor proc)

Puts this state in 'process' mode

Throws:

IllegalStateException - If the renderer for block block was already rendered. or when the belonging request was already 'ended'.

getRenderer

public Renderer getRenderer()

getProcessor

public Processor getProcessor()

getId

public String getId()

Returns the id of the current block, which uniquely identifies it on the current page (or http request).

generateId

protected String generateId(int c)

getUpcomingId

public String getUpcomingId()

If rendering not yet started, this returns the id of a component which would begin now.

toString

public String toString()

Overrides:

toString in class Object