Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.websody
Class Container  view Container download Container.java

java.lang.Object
  extended byorg.websody.Container

public class Container
extends java.lang.Object

Request-time representation of a websody container. It stores the contents of plugs that is later accessed by plug-area tags.


Field Summary
static java.lang.String CONTAINER_ATTR
          The request attribute key
private  Container enclosingContainer
           
private  boolean extended
           
private  int id
           
private static org.apache.log4j.Category log
          The log4j category
private  java.util.HashMap plugs
           
private  javax.servlet.ServletRequest request
           
private  boolean toBeExtended
           
 
Constructor Summary
Container(javax.servlet.ServletRequest request, Container enclosingContainer, int id)
          Creates a new container for the given request with enclosingContainer as enclosing container.
 
Method Summary
 Container close()
          Closes the container.
static Container get(javax.servlet.ServletRequest request)
          Returns the current container for the given request.
 int getId()
           
 java.lang.String getPlug(java.lang.String area)
          Returns the plug for the given area.
 boolean isEmptyArea(java.lang.String area)
          Returns true if the area is empty.
 boolean isExtended()
          Returns true if the container's extended flag is set.
 boolean isToBeExtended()
          Returns true if the container's shall be extended.
static Container open(javax.servlet.ServletRequest request, int id)
          Returns the current container if the extended flag is set or a new container with the current container as enclosing container otherwise.
 void setExtended(boolean extended)
          Sets the container's extended flag.
 void setPlug(java.lang.String area, java.lang.String plug)
          Sets the plug for a given area.
 void setToBeExtended(boolean toBeExtended)
          Sets the container's to-be-extended flag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTAINER_ATTR

public static final java.lang.String CONTAINER_ATTR
The request attribute key

See Also:
Constant Field Values

log

private static org.apache.log4j.Category log
The log4j category


plugs

private java.util.HashMap plugs

extended

private boolean extended

toBeExtended

private boolean toBeExtended

id

private int id

request

private javax.servlet.ServletRequest request

enclosingContainer

private Container enclosingContainer
Constructor Detail

Container

public Container(javax.servlet.ServletRequest request,
                 Container enclosingContainer,
                 int id)
Creates a new container for the given request with enclosingContainer as enclosing container.

Method Detail

getId

public int getId()

isEmptyArea

public boolean isEmptyArea(java.lang.String area)
Returns true if the area is empty.


setPlug

public void setPlug(java.lang.String area,
                    java.lang.String plug)
Sets the plug for a given area.


getPlug

public java.lang.String getPlug(java.lang.String area)
Returns the plug for the given area.


setExtended

public void setExtended(boolean extended)
Sets the container's extended flag.


isExtended

public boolean isExtended()
Returns true if the container's extended flag is set.


setToBeExtended

public void setToBeExtended(boolean toBeExtended)
Sets the container's to-be-extended flag.


isToBeExtended

public boolean isToBeExtended()
Returns true if the container's shall be extended.


close

public Container close()
Closes the container. The enclosing container is put back into the request as current container.


get

public static Container get(javax.servlet.ServletRequest request)
Returns the current container for the given request.


open

public static Container open(javax.servlet.ServletRequest request,
                             int id)
Returns the current container if the extended flag is set or a new container with the current container as enclosing container otherwise.