PageContext (rendersnake - parent 1.9 API)

java.lang.Object
- org.rendersnake.PageContext

All Implemented Interfaces:

ContextMap

Direct Known Subclasses:

LoggingPageContext
```
public class PageContext
extends Object
implements ContextMap
```
PageContext provides the interface to page-render scoped variables. During rendering, each component can set or get values from a PageContext. Values set by a component are only visible to the component and all its child components.

Author:

ernestmicklei

Field Summary

Fields
Modifier and Type	Field and Description
`StackedMap`	`attributes` Storage of the values for each component nesting level
`static String`	`REQUEST_COOKIES`
`static String`	`REQUEST_HEADERS`
`static String`	`REQUEST_PARAMETERS`
`static String`	`REQUEST_PATH` Reserved keys for accessing data provided by the HttpRequest.
`static String`	`REQUEST_URIQ`
`static String`	`SESSION`

Constructor Summary

Constructors
Constructor and Description

PageContext()

Constructors
Constructor and Description
`PageContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`beginRender()` The HtmlCanvas is about to render a new component.
`Object`	`clear(String key)` Remove all entries from the Map.
`protected void`	`endRender()` The HtmlCanvas is finished rendering a component.
`Boolean`	`getBoolean(String key, Boolean... optional)` Return the Boolean value stored a the key, or the value of optional if absent.
`ContextMap`	`getContextMap(String key)` Answer a ContextAttributesAccess by a key
`Float`	`getFloat(String key, Float... optional)` Return the Float value stored a the key, or the value of optional if absent.
`Integer`	`getInteger(String key, Integer... optional)` Return the Integer value stored a the key, or the value of optional if absent.
`Long`	`getLong(String key, Long... optional)` Return the Float value stored a the key, or the value of optional if absent.
`Object`	`getObject(String key, Object... optional)` Answer the value stored by a key
`String`	`getString(String key, String... optional)` Answer the String value stored by a key
`void`	`renderForErrorOn(HtmlCanvas html)` Render error reporting information using the (debug) html
`void`	`renderForInpectorOn(Inspector inspector, HtmlCanvas html)` Render inspection information using the (debug) html
`Map<Object,Object>`	`toMap()` Return a new Map containing all the context key,value pairs.
`String`	`toString()`
`PageContext`	`withBoolean(String key, Boolean trueOrFalse)` Add (or overwrite) a key,Boolean pair to the Map.
`PageContext`	`withFloat(String key, Float aFloat)` Add (or overwrite) a key,Float pair to the Map.
`PageContext`	`withInteger(String key, Integer number)` Add (or overwrite) a key,Integer pair to the Map.
`PageContext`	`withLong(String key, Long aLong)` Add (or overwrite) a key,Long pair to the Map.
`PageContext`	`withObject(String key, Object value)` Store a value accessed by a key
`PageContext`	`withString(String key, String value)` Store a value accessed by a key

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - REQUEST_PATH
```
public static final String REQUEST_PATH
```
    Reserved keys for accessing data provided by the HttpRequest.
    
    See Also:
    
    Constant Field Values
  - REQUEST_URIQ
```
public static final String REQUEST_URIQ
```
    See Also:
    
    Constant Field Values
  - REQUEST_PARAMETERS
```
public static final String REQUEST_PARAMETERS
```
    See Also:
    
    Constant Field Values
  - SESSION
```
public static final String SESSION
```
    See Also:
    
    Constant Field Values
  - REQUEST_HEADERS
```
public static final String REQUEST_HEADERS
```
    See Also:
    
    Constant Field Values
  - REQUEST_COOKIES
```
public static final String REQUEST_COOKIES
```
    See Also:
    
    Constant Field Values
  - attributes
```
public StackedMap attributes
```
    Storage of the values for each component nesting level
- Constructor Detail
  - PageContext
```
public PageContext()
```
- Method Detail
  - getContextMap
```
public ContextMap getContextMap(String key)
```
    Answer a ContextAttributesAccess by a key
  - withObject
```
public PageContext withObject(String key,
                              Object value)
```
    Store a value accessed by a key
    
    Specified by:
    
    withObject in interface ContextMap
    
    Parameters:
    
    key - , not null
    
    value, - any object
    
    Returns:
    
    this
  - getObject
```
public Object getObject(String key,
                        Object... optional)
```
    Answer the value stored by a key
    
    Specified by:
    
    getObject in interface ContextMap
    
    Parameters:
    
    key - , not null
    
    Returns:
    
    Object | null | optional[0]
  - withString
```
public PageContext withString(String key,
                              String value)
```
    Store a value accessed by a key
    
    Specified by:
    
    withString in interface ContextMap
    
    Parameters:
    
    key - , not null
    
    value - , any String
    
    Returns:
    
    this
  - getString
```
public String getString(String key,
                        String... optional)
```
    Answer the String value stored by a key
    
    Specified by:
    
    getString in interface ContextMap
    
    Parameters:
    
    key - , not null
    
    Returns:
    
    Object | null | optional[0]
  - withInteger
```
public PageContext withInteger(String key,
                               Integer number)
```
    Description copied from interface: ContextMap
    
    Add (or overwrite) a key,Integer pair to the Map. Return the Map.
    
    Specified by:
    
    withInteger in interface ContextMap
    
    Parameters:
    
    key -
    
    number -
    
    Returns:
    
    this
  - getInteger
```
public Integer getInteger(String key,
                          Integer... optional)
```
    Description copied from interface: ContextMap
    
    Return the Integer value stored a the key, or the value of optional if absent.
    
    Specified by:
    
    getInteger in interface ContextMap
    
    Returns:
  - withBoolean
```
public PageContext withBoolean(String key,
                               Boolean trueOrFalse)
```
    Description copied from interface: ContextMap
    
    Add (or overwrite) a key,Boolean pair to the Map. Return the Map.
    
    Specified by:
    
    withBoolean in interface ContextMap
    
    Parameters:
    
    key -
    
    trueOrFalse -
    
    Returns:
  - getBoolean
```
public Boolean getBoolean(String key,
                          Boolean... optional)
```
    Description copied from interface: ContextMap
    
    Return the Boolean value stored a the key, or the value of optional if absent.
    
    Specified by:
    
    getBoolean in interface ContextMap
    
    Returns:
  - withFloat
```
public PageContext withFloat(String key,
                             Float aFloat)
```
    Description copied from interface: ContextMap
    
    Add (or overwrite) a key,Float pair to the Map. Return the Map.
    
    Specified by:
    
    withFloat in interface ContextMap
    
    Parameters:
    
    key -
    
    aFloat -
    
    Returns:
    
    this
  - getFloat
```
public Float getFloat(String key,
                      Float... optional)
```
    Description copied from interface: ContextMap
    
    Return the Float value stored a the key, or the value of optional if absent.
    
    Specified by:
    
    getFloat in interface ContextMap
    
    Returns:
  - withLong
```
public PageContext withLong(String key,
                            Long aLong)
```
    Description copied from interface: ContextMap
    
    Add (or overwrite) a key,Long pair to the Map. Return the Map.
    
    Specified by:
    
    withLong in interface ContextMap
    
    Parameters:
    
    key -
    
    aLong -
    
    Returns:
    
    this
  - getLong
```
public Long getLong(String key,
                    Long... optional)
```
    Description copied from interface: ContextMap
    
    Return the Float value stored a the key, or the value of optional if absent.
    
    Specified by:
    
    getLong in interface ContextMap
    
    Returns:
  - beginRender
```
protected void beginRender()
```
    The HtmlCanvas is about to render a new component. This means values are stored on the next nesting level.
  - endRender
```
protected void endRender()
```
    The HtmlCanvas is finished rendering a component. This means values are the current nesting level are unavailable.
  - renderForInpectorOn
```
public void renderForInpectorOn(Inspector inspector,
                                HtmlCanvas html)
                         throws IOException
```
    Render inspection information using the (debug) html
    
    Parameters:
    
    html -
    
    Throws:
    
    IOException
  - renderForErrorOn
```
public void renderForErrorOn(HtmlCanvas html)
                      throws IOException
```
    Render error reporting information using the (debug) html
    
    Parameters:
    
    html -
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clear
```
public Object clear(String key)
```
    Description copied from interface: ContextMap
    
    Remove all entries from the Map.
    
    Specified by:
    
    clear in interface ContextMap
    
    Returns:
  - toMap
```
public Map<Object,Object> toMap()
```
    Description copied from interface: ContextMap
    
    Return a new Map containing all the context key,value pairs.
    
    Specified by:
    
    toMap in interface ContextMap
    
    Returns:

Class PageContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REQUEST_PATH

REQUEST_URIQ

REQUEST_PARAMETERS

SESSION

REQUEST_HEADERS

REQUEST_COOKIES

attributes

Constructor Detail

PageContext

Method Detail

getContextMap

withObject

getObject

withString

getString

withInteger

getInteger

withBoolean

getBoolean

withFloat

getFloat

withLong

getLong

beginRender

endRender

renderForInpectorOn

renderForErrorOn

toString

clear

toMap