|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.turbine.services.intake.IntakeTool
A Pull tool to make intake objects available to a template
Inner Class Summary | |
class |
IntakeTool.PullHelper
Inner class to present a nice interface to the template designer |
Field Summary | |
static java.lang.String |
DEFAULT_KEY
|
Constructor Summary | |
IntakeTool()
|
Method Summary | |
java.lang.String |
declareGroup(Group group)
A convenience method to write out the hidden form fields that notify intake of the group. |
void |
declareGroup(Group group,
java.lang.StringBuffer sb)
xhtml valid hidden input field(s) that notifies intake of the group's presence. |
java.lang.String |
declareGroups()
A convenience method to write out the hidden form fields that notify intake of the relevant groups. |
void |
dispose()
Disposes the object after use. |
java.lang.Object |
get(java.lang.String groupName)
|
Group |
get(java.lang.String groupName,
java.lang.String key)
|
Group |
get(java.lang.String groupName,
java.lang.String key,
boolean create)
|
java.util.Map |
getGroups()
Get a Map containing all the groups. |
void |
init(java.lang.Object runData)
Prepares intake for a single request |
boolean |
isAllValid()
|
boolean |
isDisposed()
Checks whether the recyclable has been disposed. |
void |
newForm()
|
void |
recycle()
Recycles the object for a new client. |
void |
refresh()
Implementation of ApplicationTool interface is not needed for this tool as it is request scoped |
void |
remove(Group group)
Removes group. |
void |
removeAll()
Removes all groups. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String DEFAULT_KEY
Constructor Detail |
public IntakeTool()
Method Detail |
public void init(java.lang.Object runData)
init
in interface ApplicationTool
org.apache.turbine.services.pull.ApplicationTool
data
- initialization datapublic java.lang.String declareGroups()
public java.lang.String declareGroup(Group group)
public void declareGroup(Group group, java.lang.StringBuffer sb)
public void newForm()
public void refresh()
refresh
in interface ApplicationTool
public java.lang.Object get(java.lang.String groupName) throws java.lang.Exception
public boolean isAllValid()
public Group get(java.lang.String groupName, java.lang.String key) throws java.lang.Exception
public Group get(java.lang.String groupName, java.lang.String key, boolean create) throws java.lang.Exception
public void remove(Group group)
public void removeAll()
public java.util.Map getGroups()
public void recycle()
recycle
in interface Recyclable
public void dispose()
dispose
in interface Recyclable
public boolean isDisposed()
isDisposed
in interface Recyclable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |