|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.dynamide.DynamideObject com.dynamide.event.ScriptEvent
public class ScriptEvent
In order to make this class as easy to use as possible from multiple scripting languages supported by events, the important fields are available as public fields and as bean properties with proper getters and setters. That is, foo, getFoo() and setFoo() are all public.
Field Summary | |
---|---|
java.lang.String |
action
|
Page |
currentPage
|
java.lang.String |
currentPageID
|
static java.lang.String |
DUMPHTML_END
|
static java.lang.String |
DUMPHTML_ROWEND
|
static java.lang.String |
DUMPHTML_ROWMID
|
static java.lang.String |
DUMPHTML_ROWSTART
|
static java.lang.String |
DUMPHTML_START
|
int |
errorLineNumber
|
java.lang.String |
evalErrorMsg
The Object returned by the event. |
java.lang.String |
eventName
This is informational only. |
java.lang.Object |
inputObject
|
java.lang.String |
nextPageID
|
java.lang.Object |
outputObject
|
boolean |
prettyPrint
|
static int |
RA_DEFAULT
This is the default value, which means dynamide will continue with the default loading of pages according to other page order rules, such as calling onQueryNextPage. |
static int |
RA_JUMP_TO_PAGE
Use this value for resultAction to jump directly to the page named by nextPageID. |
static int |
RA_RETURN_SOURCE
If your event generates html/xml and you wish to return exactly the source you generate, set the resultAction to this value, and set the resultSrc to the source. |
static int |
RA_SEND_REDIRECT
Use this value for resultAction to send the client's web browser to a URL. |
static int |
RA_SHOW_ERRORS
Use this value for resultAction to re-show the current page, but with errors flagged. |
static int |
RA_THROW_EXCEPTION
If your event would like to throw an exception to be caught by the error page, you should set resultAction to RA_THROW_EXCEPTION, and set the outputObject to the exception, otherwise dynamide catches all ScriptEvent exceptions, and handles them a little differently, though in most cases you'll end up with the error page anyway. |
static int |
RC_ERROR
For internal use by dynamide. |
static int |
RC_NO_EVENT_SOURCE
For internal use by dynamide. |
static int |
RC_OK
For internal use by dynamide. |
java.lang.String |
redirectURL
|
javax.servlet.http.HttpServletRequest |
request
|
javax.servlet.http.HttpServletResponse |
response
|
int |
resultAction
|
int |
resultCode
For internal use by dynamide, changes to this field in the event will be ignored. |
java.lang.String |
resultSrc
|
java.lang.Object |
sender
|
Session |
session
|
java.lang.Throwable |
throwable
|
Fields inherited from class com.dynamide.DynamideObject |
---|
m_id |
Constructor Summary | |
---|---|
ScriptEvent()
|
|
ScriptEvent(DynamideObject owner)
|
Method Summary | |
---|---|
java.lang.String |
dump()
Subclasses can override this with something more descriptive, for logging and debugging. |
java.lang.String |
dump(java.lang.String dstart,
java.lang.String d1,
java.lang.String d2,
java.lang.String d3,
java.lang.String dend,
boolean escapeHTML)
|
java.lang.String |
dumpHTML()
Subclasses can override this with something more descriptive, for logging and debugging. |
void |
finalize()
|
Page |
getCurrentPage()
|
java.lang.String |
getCurrentPageID()
|
java.lang.String |
getDMAction()
|
int |
getErrorLineNumber()
|
java.lang.String |
getEvalErrorMsg()
|
java.lang.String |
getEventName()
This is informational only. |
HandlerResult |
getHandlerResult()
|
java.lang.Object |
getInputObject()
|
java.lang.String |
getNextPageID()
|
java.lang.Object |
getOutputObject()
|
java.lang.String |
getQueryParam(java.lang.String paramName)
|
javax.servlet.http.HttpServletRequest |
getRequest()
|
javax.servlet.http.HttpServletResponse |
getResponse()
|
int |
getResultAction()
|
int |
getResultCode()
|
java.lang.String |
getResultSrc()
|
java.lang.Object |
getSender()
If this event is triggered from a specific object, that object will be the sender, e.g. |
Session |
getSession()
|
java.lang.Throwable |
getThrowable()
|
java.lang.String |
getURL()
|
boolean |
hasQueryParam(java.lang.String paramName)
|
void |
jumpToPage(java.lang.String nextPageID)
Sets the event resultAction to ..., and sets the resultSrc property, but the action will occur when the event returns. |
void |
print(java.lang.String msg)
|
void |
println(java.lang.String msg)
|
java.lang.String |
printResultAction()
|
java.lang.String |
printResultCode()
|
void |
returnError(java.lang.String error,
java.lang.Throwable t)
Sets the event resultCode RC_ERROR, the action will occur when the event returns. |
void |
returnSource(java.lang.String src)
|
void |
returnSource(java.lang.String src,
boolean prettyPrint)
Sets the event resultAction to RA_RETURN_SOURCE, and sets the resultSrc property, but the action will occur when the event returns. |
void |
sendRedirect(java.lang.String url)
Send the client a redirect, rather than a rendered page, to avoid POST data being re-posted on a refresh. |
void |
sendRedirectToPage(java.lang.String pageID)
Send the client a redirect, to the named page, using the current SESSIONID and applicationPath. |
void |
sendRedirectToPage(java.lang.String pageID,
java.lang.String theAction)
Send the client a redirect, to the named page, using the current SESSIONID and applicationPath, and the supplied action parameter. |
void |
sendRedirectToPage(java.lang.String pageID,
java.lang.String action,
java.lang.String moreParams)
Send the client a redirect, to the named page, using the current SESSIONID and applicationPath, and the supplied action parameter, but allowing additional parameters to be sent. |
void |
setCurrentPage(Page new_value)
|
void |
setCurrentPageID(java.lang.String new_value)
|
void |
setDMAction(java.lang.String new_value)
|
void |
setErrorLineNumber(int new_value)
|
void |
setEventName(java.lang.String new_value)
|
void |
setInputObject(java.lang.Object new_value)
|
void |
setNextPageID(java.lang.String new_value)
|
void |
setOutputObject(java.lang.Object new_value)
|
void |
setRequest(javax.servlet.http.HttpServletRequest new_value)
|
void |
setResponse(javax.servlet.http.HttpServletResponse new_value)
|
void |
setResultAction(int new_value)
|
ScriptEvent |
setResultsFrom(ScriptEvent other)
Sets all results from the ScriptEvent passed in, so that you can chain events. |
void |
setResultSrc(java.lang.String new_value)
|
void |
setSender(java.lang.Object new_value)
|
void |
setSession(Session new_value)
|
java.lang.String |
toString()
|
Methods inherited from class com.dynamide.DynamideObject |
---|
clearProfiler, dump, expand, findParentExpander, findParentPage, findParentSession, findTopParentPage, get, getCategoryID, getDotName, getID, getNextGetter, getObjectID, getOwner, getProfiler, isDebugEnabled, isInfoEnabled, logDebug, logDebug, logDebug, logDebug, logError, logError, logError, logError, logInfo, logInfo, logInfo, logInfo, logWarn, logWarn, logWarn, logWarn, popLogContext, printf, printProfiler, profileEnter, profileLeave, pushLogContext, setDotName, setID, setNextGetter, setObjectID, setOwner, sprintf, useProfiler, walkParents |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int RA_DEFAULT
public static final int RA_SHOW_ERRORS
public static final int RA_JUMP_TO_PAGE
public static final int RA_RETURN_SOURCE
public static final int RA_THROW_EXCEPTION
public static final int RA_SEND_REDIRECT
public int resultAction
public boolean prettyPrint
public java.lang.String redirectURL
public transient Session session
public transient javax.servlet.http.HttpServletRequest request
public transient javax.servlet.http.HttpServletResponse response
public transient java.lang.Object sender
public transient Page currentPage
public java.lang.String action
public java.lang.String currentPageID
public java.lang.String nextPageID
public java.lang.String resultSrc
public transient java.lang.Object inputObject
public transient java.lang.Object outputObject
public int errorLineNumber
public java.lang.String eventName
public java.lang.String evalErrorMsg
public java.lang.Throwable throwable
public static final int RC_OK
public static final int RC_ERROR
public static final int RC_NO_EVENT_SOURCE
public int resultCode
public static final java.lang.String DUMPHTML_START
public static final java.lang.String DUMPHTML_ROWSTART
public static final java.lang.String DUMPHTML_ROWMID
public static final java.lang.String DUMPHTML_ROWEND
public static final java.lang.String DUMPHTML_END
Constructor Detail |
---|
public ScriptEvent()
public ScriptEvent(DynamideObject owner)
Method Detail |
---|
public void finalize() throws java.lang.Throwable
finalize
in class DynamideObject
java.lang.Throwable
public int getResultAction()
public void setResultAction(int new_value)
public java.lang.String printResultAction()
public void sendRedirect(java.lang.String url)
public void sendRedirectToPage(java.lang.String pageID)
public void sendRedirectToPage(java.lang.String pageID, java.lang.String theAction)
sendRedirectToPage("page1", "display");
theAction
- contains a single string value that is the action to be sent to the
application_onAction or {pageID}_onAction event.public void sendRedirectToPage(java.lang.String pageID, java.lang.String action, java.lang.String moreParams)
action
- contains a single string value that is the action to be sent to the
application_onAction or {pageID}_onAction event.moreParams
- contains name-value pairs URL encoded. Here are some examples:
sendRedirectToPage("page1", "display", "category=sales"); sendRedirectToPage("page1", "display", "topic=My+Preferences");Note that you typically do not send additional parameters, since these would best be set in the Session as Fields before leaving the current event. If you need to send a redirect to another web site or application, use sendRedirect(String url).
public void jumpToPage(java.lang.String nextPageID)
if (condition){ return event.jumpToPage("page1"); }Rather than:
if (condition){ event.jumpToPage("page1"); return; }Both styles will work, and are exactly equivalent, but the first is easier to read.
public void returnSource(java.lang.String src, boolean prettyPrint)
public void returnSource(java.lang.String src)
public void returnError(java.lang.String error, java.lang.Throwable t)
t
- can be null.public ScriptEvent setResultsFrom(ScriptEvent other)
ScriptEvent res = event.setResultsFrom(widget.fireEvent(inputObject, "onClick");
public Session getSession()
public void setSession(Session new_value)
public javax.servlet.http.HttpServletRequest getRequest()
public void setRequest(javax.servlet.http.HttpServletRequest new_value)
public javax.servlet.http.HttpServletResponse getResponse()
public void setResponse(javax.servlet.http.HttpServletResponse new_value)
public HandlerResult getHandlerResult()
public java.lang.Object getSender()
public void setSender(java.lang.Object new_value)
public Page getCurrentPage()
public void setCurrentPage(Page new_value)
public java.lang.String getDMAction()
public void setDMAction(java.lang.String new_value)
public java.lang.String getCurrentPageID()
public void setCurrentPageID(java.lang.String new_value)
public java.lang.String getNextPageID()
public void setNextPageID(java.lang.String new_value)
public java.lang.String getResultSrc()
public void setResultSrc(java.lang.String new_value)
public java.lang.Object getInputObject()
public void setInputObject(java.lang.Object new_value)
public java.lang.Object getOutputObject()
public void setOutputObject(java.lang.Object new_value)
public int getErrorLineNumber()
public void setErrorLineNumber(int new_value)
public java.lang.String getEventName()
public void setEventName(java.lang.String new_value)
public java.lang.String getEvalErrorMsg()
public java.lang.Throwable getThrowable()
public int getResultCode()
public java.lang.String printResultCode()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String dump()
DynamideObject
dump
in class DynamideObject
public java.lang.String dumpHTML()
DynamideObject
dumpHTML
in class DynamideObject
public java.lang.String dump(java.lang.String dstart, java.lang.String d1, java.lang.String d2, java.lang.String d3, java.lang.String dend, boolean escapeHTML)
public void print(java.lang.String msg)
public void println(java.lang.String msg)
public java.lang.String getQueryParam(java.lang.String paramName)
public boolean hasQueryParam(java.lang.String paramName)
public java.lang.String getURL()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |