|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.wicket.request.RequestParameters
public class RequestParameters
Object that abstracts common request parameters. It consists of possible optional parameters that
can be translated from e.g. servlet request parameters and serves as a strongly typed variant of
these that is to be created by the IRequestCycleProcessor
's
IRequestCodingStrategy
.
Though this object can be extended and hence more parameter options can be used, anything other
than in this implementation must be supported by specific
IRequestCycleProcessor
implementations and thus are not
supported by default implementations.
Constructor Summary | |
---|---|
RequestParameters()
Construct. |
Method Summary | |
---|---|
java.lang.String |
getBehaviorId()
Gets the component registration id of any behavior. |
java.lang.String |
getBookmarkablePageClass()
Gets any bookmarkable page class. |
java.lang.String |
getComponentId()
Gets any id of a non-page target component. |
java.lang.String |
getComponentPath()
Gets the full path to a component (might be just the page).. |
RequestListenerInterface |
getInterface()
|
java.lang.String |
getInterfaceName()
Gets any callable interface name (e.g. |
java.lang.String |
getPageMapName()
Gets any name of the page map. |
java.util.Map |
getParameters()
Gets free-to-use map of non-reserved parameters. |
java.lang.String |
getPath()
Gets path info. |
java.lang.String |
getResourceKey()
Gets any resource key. |
int |
getUrlDepth()
Gets the depth for relative URLs. |
int |
getVersionNumber()
Gets any version information string. |
boolean |
isOnlyProcessIfPathActive()
Tells wicket whether this request should only be processed if the page + version specified are pointing to the last page the user accessed. |
void |
setBehaviorId(java.lang.String behaviorId)
Sets the component registration id of any behavior. |
void |
setBookmarkablePageClass(java.lang.String bookmarkablePageClass)
Sets any bookmarkable page class. |
void |
setComponentId(java.lang.String componentId)
Sets any id of a non-page target component. |
void |
setComponentPath(java.lang.String componentPath)
Sets the full path to a component (might be just the page).. |
void |
setInterfaceName(java.lang.String interfaceName)
Sets any callable interface name (e.g. |
void |
setOnlyProcessIfPathActive(boolean onlyProcessIfPathActive)
Sets the only-process-if-path-active flag |
void |
setPageMapName(java.lang.String pageMapName)
Sets any name of the page map. |
void |
setParameters(java.util.Map parameters)
Sets free-to-use map of non-reserved parameters. |
void |
setPath(java.lang.String pathInfo)
Sets path info. |
void |
setResourceKey(java.lang.String resourceKey)
Sets any resource key. |
void |
setUrlDepth(int urlDepth)
Sets the depth for relative URLs. |
void |
setVersionNumber(int versionNumber)
Sets any version information string. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RequestParameters()
Method Detail |
---|
public java.lang.String getBehaviorId()
public java.lang.String getBookmarkablePageClass()
public java.lang.String getComponentId()
public java.lang.String getComponentPath()
public RequestListenerInterface getInterface()
public java.lang.String getInterfaceName()
ILinkListener
).
ILinkListener
)public java.lang.String getPageMapName()
public java.util.Map getParameters()
public java.lang.String getPath()
public java.lang.String getResourceKey()
public int getVersionNumber()
public boolean isOnlyProcessIfPathActive()
WebRequestCodingStrategy.IGNORE_IF_NOT_ACTIVE_PARAMETER_NAME
public void setBehaviorId(java.lang.String behaviorId)
behaviorId
- the idpublic void setBookmarkablePageClass(java.lang.String bookmarkablePageClass)
bookmarkablePageClass
- any bookmarkable page classpublic void setComponentId(java.lang.String componentId)
componentId
- any id of a non-page target componentpublic void setComponentPath(java.lang.String componentPath)
componentPath
- the full path to a component (might be just the page).public void setInterfaceName(java.lang.String interfaceName)
ILinkListener
).
interfaceName
- any callable interface name (e.g. ILinkListener
)public void setOnlyProcessIfPathActive(boolean onlyProcessIfPathActive)
onlyProcessIfPathActive
- isOnlyProcessIfPathActive()
public void setPageMapName(java.lang.String pageMapName)
pageMapName
- any name of the page mappublic void setParameters(java.util.Map parameters)
parameters
- free-to-use map of non-reserved parameterspublic void setPath(java.lang.String pathInfo)
pathInfo
- path infopublic void setResourceKey(java.lang.String resourceKey)
resourceKey
- any resource keypublic void setVersionNumber(int versionNumber)
versionNumber
- any version information stringpublic int getUrlDepth()
public void setUrlDepth(int urlDepth)
urlDepth
- Number of slashes deep the page is that an AJAX request is made from.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |