scaffold API Documentation: Index











Overview 
Package 
Class 
Tree 
Deprecated 
 Index 
Help 










 PREV 
 NEXT

FRAMES  
 NO FRAMES




B C D E F G I K L M N O P R S T V X Y

B

BaseAction - class org.apache.struts.scaffold.BaseAction.Enhanced base Action.BaseAction() -
Constructor for class org.apache.struts.scaffold.BaseAction
 
BaseActionMapping - class org.apache.struts.scaffold.BaseActionMapping.Enhanced base ActionMapping.BaseActionMapping() -
Constructor for class org.apache.struts.scaffold.BaseActionMapping
 
BaseForm - class org.apache.struts.scaffold.BaseForm.Enhanced base ActionForm.BaseForm() -
Constructor for class org.apache.struts.scaffold.BaseForm
 
BaseHelperAction - class org.apache.struts.scaffold.BaseHelperAction.Base class to instantiate helper objects from parameter property.BaseHelperAction() -
Constructor for class org.apache.struts.scaffold.BaseHelperAction
 
BaseMapForm - class org.apache.struts.scaffold.BaseMapForm.Enhanced base ActionForm for Struts 1.1 and later.BaseMapForm() -
Constructor for class org.apache.struts.scaffold.BaseMapForm
 



C

catchException(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseAction
Process the exception handling for this Action.
CHANNEL_KEY -
Static variable in class org.apache.struts.scaffold.rss.ParseRss
Request attribute key for saving Channel bean ["CHANNEL"].
checkData(ActionMapping, HttpServletRequest, ProcessResult) -
Method in class org.apache.struts.scaffold.ProcessAction
Save result object to servlet context.
checkDataSingle(ActionMapping, HttpServletRequest, ProcessResult) -
Method in class org.apache.struts.scaffold.ProcessAction
Save result object to servlet context.
checkDispatch(ActionMapping, HttpServletRequest, ProcessResult) -
Method in class org.apache.struts.scaffold.ProcessAction
Process new dispatch advice passed by the business tier.
checkMessages(ActionMapping, HttpServletRequest, ProcessResult) -
Method in class org.apache.struts.scaffold.ProcessAction
Stores informational messages for display.
checkOutcome(ActionMapping, HttpServletRequest, ProcessResult) -
Method in class org.apache.struts.scaffold.ProcessAction
Check outcome, if any; recurse if container for other outcomes.
configured -
Static variable in class org.apache.struts.scaffold.BaseActionMapping
Forward compatabilty with Struts 1.1.
CONFIRM_MAX -
Static variable in class org.apache.struts.scaffold.BaseAction
Number of replacement parameters permitted in Struts 1.0.
ContinueAction - class org.apache.struts.scaffold.ContinueAction.Standard Action to forward control to continue.ContinueAction() -
Constructor for class org.apache.struts.scaffold.ContinueAction
 
createHelperBean(HttpServletRequest, String) -
Method in class org.apache.struts.scaffold.BaseAction
Return an instance of the form-bean associated with the specified name, if any; otherwise return null.
createHelperObject(HttpServletRequest, String) -
Method in class org.apache.struts.scaffold.BaseAction
Create an object of the specified class, throwing a runtime exception if any error occurs.



D

describe() -
Method in class org.apache.struts.scaffold.BaseForm
Return map of properties for this bean.
DETAILS -
Static variable in class org.apache.struts.scaffold.BaseAction
Token to print between short and long description of an exception.
dispatch -
Variable in class org.apache.struts.scaffold.BaseForm
The dispatch property.
dispatch -
Variable in class org.apache.struts.scaffold.MenuForm
The name of a logical forward for use in mapping a forward to a menu option.



E

EMPTY -
Static variable in class org.apache.struts.scaffold.BaseForm
A static, empty String used by isBlank.
ERROR -
Static variable in class org.apache.struts.scaffold.BaseAction
Token to print before short description of an exception.
execute(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseAction
Skeleton method that calls the other extension points (or "hotspots") provided by this class.
executeLogic(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseAction
Execute the business logic for this Action.
executeLogic(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseHelperAction
Instantiate helper objects from the type given as the ActionMapping parameter (delimited with semicolons), and call the alternate executeLogic.
executeLogic(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.ProcessDispatchAction
Instantiate helper object from the type given as the first ActionMapping parameter and execute the method given as the second parameter (delimited with semicolons).
executeLogic(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.rss.RenderRss
(* // :FIXME: Hasn't been tested.
executeLogic(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.rss.ParseRss
Read and parse RSS file found at a given path, save the Channel bean in request scope, and forward to "success".
executeLogic(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse, Object[]) -
Method in class org.apache.struts.scaffold.BaseHelperAction
Simple test to render String version of instantiated helpers.
executeLogic(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse, Object[]) -
Method in class org.apache.struts.scaffold.ProcessAction
Assume that helpers are ProcessBeans, execute each, and process outcome.
ExistsAttributeAction - class org.apache.struts.scaffold.ExistsAttributeAction.Remove an object from the user's session.ExistsAttributeAction() -
Constructor for class org.apache.struts.scaffold.ExistsAttributeAction
 
exposeInScope(HttpServletRequest, String, String, Object) -
Method in class org.apache.struts.scaffold.ProcessAction
Exposes result in a servlet context.
exposeInScope(HttpServletRequest, String, String, Object) -
Method in class org.apache.struts.scaffold.ProcessFormAction
Exposes result in a servlet context.



F

findFailure(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseAction
Return the appropriate ActionForward for an error condition.
findFailure(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.ProcessAction
Return the appropriate ActionForward for error or failure conditions.
FindForwardAction - class org.apache.struts.scaffold.FindForwardAction.Scan request parameters for the name of a local or global forward.FindForwardAction() -
Constructor for class org.apache.struts.scaffold.FindForwardAction
 
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseAction
Return the appropriate ActionForward for the nominal, non-error state.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.ParameterAction
Append parameter to a query string.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.ProcessAction
Return the appropriate ActionForward for the nominal, non-error state.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.RecreateSessionAction
Creates a new session, perserving any prior Locale attribute.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.RemoveAttributeAction
// :FIXME: Needs to be tested.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.ContinueAction
Forward to the "continue" ActionForward.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.ExistsAttributeAction
Find "success" if attribute exists, or "failure" if not.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.RelayAction
Looks for a runtime parameter named "dispatch", and uses its value to search for an ActionForward.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.FindForwardAction
Scan request parameters for the name of a local or global forward.
findSuccess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.rss.RenderRss
Return null to the controller, indicating that the response has been rendered.
FROZEN_MESSAGE -
Static variable in class org.apache.struts.scaffold.BaseActionMapping
Message if they try to set a frozen configuration property.



G

getDispatch() -
Method in class org.apache.struts.scaffold.BaseForm
Get the dispatch.
getDispatch() -
Method in class org.apache.struts.scaffold.MenuForm
Return the dispatch.
getErrors(HttpServletRequest, boolean) -
Method in class org.apache.struts.scaffold.BaseAction
Return whether there is an errors alert collection pending.
getException(HttpServletRequest) -
Method in class org.apache.struts.scaffold.BaseAction
Return exception stored in request under public key [Action.EXCEPTION].
getKeyName() -
Method in class org.apache.struts.scaffold.MenuForm
Return the keyName.
getKeyValue() -
Method in class org.apache.struts.scaffold.MenuForm
Return the value.
getLocale(HttpServletRequest) -
Method in class org.apache.struts.scaffold.BaseAction
Return the framework locale object for the user session for given request.
getLocaleDisplay() -
Method in class org.apache.struts.scaffold.BaseForm
Display the user's locale setting or the default locale.
getMap() -
Method in class org.apache.struts.scaffold.BaseMapForm
Get the properties map.
getMessageResources() -
Method in class org.apache.struts.scaffold.BaseAction
Return the application resources for this web application, if any.
getMessages(HttpServletRequest, boolean) -
Method in class org.apache.struts.scaffold.BaseAction
Check for pending message collection.
getN() -
Method in class org.apache.struts.scaffold.MenuForm
Return the keyName abbreviated as N.
getO() -
Method in class org.apache.struts.scaffold.MenuForm
Return the Option (alias for name).
getPage() -
Method in class org.apache.struts.scaffold.MenuForm
Return the page.
getProperties() -
Method in class org.apache.struts.scaffold.BaseAction
Return the application properties for this web application, if any.
getRemoteAddr() -
Method in class org.apache.struts.scaffold.BaseForm
Return our remoteAddr property.
getRemoteServer() -
Method in class org.apache.struts.scaffold.BaseAction
Checks application scope for the remote server object specified by getRemoteServerName
getRemoteServerName() -
Method in class org.apache.struts.scaffold.BaseAction
Returns name of result server to be used by this Action, e.g, RESULT_SERVER_KEY.
getSessionLocale() -
Method in class org.apache.struts.scaffold.BaseForm
Retrieve our locale property.
getSubmitPath() -
Method in class org.apache.struts.scaffold.BaseActionMapping
 
getT() -
Method in class org.apache.struts.scaffold.MenuForm
Return the Text (alias for value).
getTokenSep() -
Method in class org.apache.struts.scaffold.BaseAction
Return separator character for list of tokens
getUserProfile(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.ProcessAction
Retrieve from session under known key (ProcessBean.USER_PROFILE_KEY).
getV() -
Method in class org.apache.struts.scaffold.MenuForm
Return the value abbreviated as V.
getValue(String) -
Method in class org.apache.struts.scaffold.BaseMapForm
Returns the value to which this map maps the specified key -- the equivalent of Object getMap().get(key).
getX() -
Method in class org.apache.struts.scaffold.ImageButtonBean
 
getY() -
Method in class org.apache.struts.scaffold.ImageButtonBean
 



I

ImageButtonBean - class org.apache.struts.scaffold.ImageButtonBean.Generic bean to use with image buttons.ImageButtonBean() -
Constructor for class org.apache.struts.scaffold.ImageButtonBean
 
isBlank(String) -
Method in class org.apache.struts.scaffold.BaseForm
Convenience method to check for a null or empty String.
isDebug() -
Method in class org.apache.struts.scaffold.BaseAction
Is logging set to debugging?
isErrors(HttpServletRequest) -
Method in class org.apache.struts.scaffold.BaseAction
Return whether there is an errors alert collection pending.
isLogLevel(int) -
Method in class org.apache.struts.scaffold.BaseAction
Is logging set this level or higher?
isMessages(HttpServletRequest) -
Method in class org.apache.struts.scaffold.BaseAction
Return whether there is an informational alert collection pending.
isMutable() -
Method in class org.apache.struts.scaffold.BaseForm
Retrieve the mutable state.
isSelected() -
Method in class org.apache.struts.scaffold.ImageButtonBean
 
isStruts_1_0() -
Method in class org.apache.struts.scaffold.BaseAction
Deprecated. Will be removed after Struts 1.1 final ships.
isVerbose() -
Method in class org.apache.struts.scaffold.BaseAction
Is logging set to verbose?



K

keyName -
Variable in class org.apache.struts.scaffold.MenuForm
A generic name field, use to store a selected option or the name of a property.
keyValue -
Variable in class org.apache.struts.scaffold.MenuForm
A generic value field, use to store a value associated with an option or the value of a property.



L

locale -
Variable in class org.apache.struts.scaffold.BaseForm
Our locale property.



M

map -
Variable in class org.apache.struts.scaffold.BaseMapForm
The map for field properties [null].
MenuForm - class org.apache.struts.scaffold.MenuForm.Generic properties for use with menu items.MenuForm() -
Constructor for class org.apache.struts.scaffold.MenuForm
 
merge(Object) -
Method in class org.apache.struts.scaffold.BaseForm
// :FIXME: Needs testing.
mergeAlerts(HttpServletRequest, ActionErrors, List) -
Method in class org.apache.struts.scaffold.BaseAction
Retrieves a base messages and up to four replaceable parameters from a List, and adds them to an ActionErrors collection.
mutable -
Variable in class org.apache.struts.scaffold.BaseForm
The mutable state.



N

NullForm - class org.apache.struts.scaffold.NullForm.Empty (or "null") form for use with "formless" forms.NullForm() -
Constructor for class org.apache.struts.scaffold.NullForm
 



O

org.apache.struts.scaffold - package org.apache.struts.scaffold org.apache.struts.scaffold.rss - package org.apache.struts.scaffold.rss 


P

page -
Variable in class org.apache.struts.scaffold.MenuForm
The page, for use in workflows.
ParameterAction - class org.apache.struts.scaffold.ParameterAction.Standard Action to append a passed parameter to query string.ParameterAction() -
Constructor for class org.apache.struts.scaffold.ParameterAction
 
ParseRss - class org.apache.struts.scaffold.rss.ParseRss.Read and parse RSS file found at a given path, save the Channel bean in request scope, and forward to "success".ParseRss() -
Constructor for class org.apache.struts.scaffold.rss.ParseRss
 
perform(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseAction
Wrapper around original perform() method to call now-preferred execute() method, This provides forward compatibility for Struts 1.0.x a applications.
perform(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.SuccessAction
Forward to "success" [Tokens.SUCCESS].
populate(Object) -
Method in class org.apache.struts.scaffold.BaseForm
Populate matching properties on given object.
postProcess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseAction
Optional extension point for post-processing.
preProcess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.BaseAction
Optional extension point for pre-processing.
preProcess(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) -
Method in class org.apache.struts.scaffold.ProcessAction
Optional extension point for pre-processing.
ProcessAction - class org.apache.struts.scaffold.ProcessAction.Advanced framework class to instantiate and execute helper beans and process the result.ProcessAction() -
Constructor for class org.apache.struts.scaffold.ProcessAction
 
ProcessDispatchAction - class org.apache.struts.scaffold.ProcessDispatchAction.ProcessFormAction that accepts the name of a class and a method with the signature "Object method(Object)" as the parameter.ProcessDispatchAction() -
Constructor for class org.apache.struts.scaffold.ProcessDispatchAction
 
processError(ProcessResult, String, ActionMapping) -
Method in class org.apache.struts.scaffold.ProcessDispatchAction
Error handler.
ProcessFormAction - class org.apache.struts.scaffold.ProcessFormAction.ProcessAction subclass that checks to see if a another bean exists in the request scope before overwriting it.ProcessFormAction() -
Constructor for class org.apache.struts.scaffold.ProcessFormAction
 
putSessionLocale(HttpServletRequest) -
Method in class org.apache.struts.scaffold.BaseForm
Change the locale property in the session to our locale object, or the default Locale if ours is null.



R

RecreateSessionAction - class org.apache.struts.scaffold.RecreateSessionAction.Create a new session, perserving any locale attribute from the current session.RecreateSessionAction() -
Constructor for class org.apache.struts.scaffold.RecreateSessionAction
 
RelayAction - class org.apache.struts.scaffold.RelayAction.Standard Action to forward control to another mapping given as a runtime parameter (?dispatch=).RelayAction() -
Constructor for class org.apache.struts.scaffold.RelayAction
 
REMOTE_SERVER_KEY -
Static variable in class org.apache.struts.scaffold.BaseAction
Default name for a remote server that may be found in application scope ["REMOTE_SERVER"].
remoteAddr -
Variable in class org.apache.struts.scaffold.BaseForm
The network address making this request.
RemoveAttributeAction - class org.apache.struts.scaffold.RemoveAttributeAction.Remove an object from the user's session.RemoveAttributeAction() -
Constructor for class org.apache.struts.scaffold.RemoveAttributeAction
 
RenderRss - class org.apache.struts.scaffold.rss.RenderRss.Convert result bean to channel and render as response.RenderRss() -
Constructor for class org.apache.struts.scaffold.rss.RenderRss
 
reset(ActionMapping, HttpServletRequest) -
Method in class org.apache.struts.scaffold.BaseForm
If bean is set to mutable, calls resetSessionLocale and setRemoteAddr.
resetSessionLocale(HttpServletRequest) -
Method in class org.apache.struts.scaffold.BaseForm
Reset our locale property to the locale object found in the session associated with this request.



S

saveErrors(HttpServletRequest, List) -
Method in class org.apache.struts.scaffold.BaseAction
Merge incoming messages and save to errors collection.
saveMessages(HttpServletRequest, List) -
Method in class org.apache.struts.scaffold.BaseAction
Merge incoming messages and save to messages collection.
set(Object) -
Method in class org.apache.struts.scaffold.BaseForm
Set properties from given object.
setDispatch(String) -
Method in class org.apache.struts.scaffold.BaseForm
Set dispatch.
setDispatch(String) -
Method in class org.apache.struts.scaffold.MenuForm
Set the dispatch
setException(HttpServletRequest, Exception) -
Method in class org.apache.struts.scaffold.BaseAction
Set exception to request under public key [Action.EXCEPTION].
setKeyName(String) -
Method in class org.apache.struts.scaffold.MenuForm
Set the keyName.
setKeyValue(String) -
Method in class org.apache.struts.scaffold.MenuForm
Set the value.
setLocale(HttpServletRequest, Locale) -
Method in class org.apache.struts.scaffold.BaseAction
Set the framework locale object in the session for this request.
setLocaleDisplay(String) -
Method in class org.apache.struts.scaffold.BaseForm
Set our locale to given ISO Language Code.
setMap(Map) -
Method in class org.apache.struts.scaffold.BaseMapForm
Set the properties map.
setMutable(boolean) -
Method in class org.apache.struts.scaffold.BaseForm
Set the mutable state.
setN(String) -
Method in class org.apache.struts.scaffold.MenuForm
Set the keyName abbreviated as N.
setO(String) -
Method in class org.apache.struts.scaffold.MenuForm
Set the Option (alias for name)
setPage(int) -
Method in class org.apache.struts.scaffold.MenuForm
Set the page key
setRemoteAddr(String) -
Method in class org.apache.struts.scaffold.BaseForm
Set our remoteAddr property.
setSessionLocale(Locale) -
Method in class org.apache.struts.scaffold.BaseForm
Set our locale property.
setSubmitPath(String) -
Method in class org.apache.struts.scaffold.BaseActionMapping
 
setT(String) -
Method in class org.apache.struts.scaffold.MenuForm
Set the Text (alias for value)
setV(String) -
Method in class org.apache.struts.scaffold.MenuForm
Set the value abbreviated as V.
setValue(String, Object) -
Method in class org.apache.struts.scaffold.BaseMapForm
Associates the specified value with the specified key in the property map for this object -- the equivalent of getMap().put(key,value).
setX(String) -
Method in class org.apache.struts.scaffold.ImageButtonBean
 
setY(String) -
Method in class org.apache.struts.scaffold.ImageButtonBean
 
submitPath -
Variable in class org.apache.struts.scaffold.BaseActionMapping
Adds submitPath to RequestActionMapping.
SuccessAction - class org.apache.struts.scaffold.SuccessAction.Standard Action to forward control to "success".SuccessAction() -
Constructor for class org.apache.struts.scaffold.SuccessAction
 



T

TOKEN_SEP -
Static variable in class org.apache.struts.scaffold.BaseAction
Default separator character for list of tokens [";"] (semi-colon).
tokenize(String) -
Method in class org.apache.struts.scaffold.BaseAction
Return array of tokens, using the result of getTokeSep() as the separator.
types -
Static variable in class org.apache.struts.scaffold.ProcessDispatchAction
The set of argument type classes for the reflected method call.



V

validate(ActionMapping, HttpServletRequest) -
Method in class org.apache.struts.scaffold.BaseForm
Return an empty ActionErrors or the result of calling the superclass validate.



X

x -
Variable in class org.apache.struts.scaffold.ImageButtonBean
 



Y

y -
Variable in class org.apache.struts.scaffold.ImageButtonBean
 


B C D E F G I K L M N O P R S T V X Y






Overview 
Package 
Class 
Tree 
Deprecated 
 Index 
Help 










 PREV 
 NEXT

FRAMES  
 NO FRAMES





Copyright © 2001-2002 - Apache Software Foundation