|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wicket.ajax.AjaxRequestTarget
public class AjaxRequestTarget
A request target that produces ajax response envelopes used on the client side to update component markup as well as evaluate arbitrary javascript.
A component whose markup needs to be updated should be added to this target via AjaxRequestTarget#addComponent(Component) method. Its body will be rendered and added to the envelope when the target is processed, and refreshed on the client side when the ajax response is received.
It is important that the component whose markup needs to be updated contains an id attribute in the generated markup that is equal to the value retrieved from Component#getMarkupId(). This can be accomplished by either setting the id attribute in the html template, or using an attribute modifier that will add the attribute with value Component#getMarkupId() to the tag ( such as MarkupIdSetter )
Any javascript that needs to be evaluated on the client side can be added using AjaxRequestTarget#append/prependJavascript(String). For example, this feature can be useful when it is desirable to link component update with some javascript effects.
The target provides a listener interface AjaxRequestTarget.IListener
that can be used to add code that
responds to various target events by adding listeners via
addListener(org.apache.wicket.ajax.AjaxRequestTarget.IListener)
Nested Class Summary | |
---|---|
static interface |
AjaxRequestTarget.IJavascriptResponse
An ajax javascript response that allows users to add javascript to be executed on the client side |
static interface |
AjaxRequestTarget.IListener
An AjaxRequestTarget listener that can be used to respond to various target-related
events |
static interface |
AjaxRequestTarget.ITargetRespondListener
Components can implement this interface to get a notification when AjaxRequestTarget begins to respond. |
Constructor Summary | |
---|---|
AjaxRequestTarget(Page page)
Constructor |
Method Summary | |
---|---|
void |
addChildren(MarkupContainer parent,
java.lang.Class childCriteria)
Visits all children of the specified parent container and adds them to the target if they are of same type as childCriteria |
void |
addComponent(Component component)
Adds a component to the list of components to be rendered |
void |
addComponent(Component component,
java.lang.String markupId)
Adds a component to the list of components to be rendered |
void |
addJavascript(java.lang.String javascript)
Deprecated. use appendJavascript(String javascript) instead |
void |
addListener(AjaxRequestTarget.IListener listener)
Adds a listener to this target |
void |
appendJavascript(java.lang.String javascript)
Adds javascript that will be evaluated on the client side after components are replaced |
void |
detach(RequestCycle requestCycle)
This method is called at the end of a request cycle to indicate that processing is done and that cleaning up of the subject(s) of this target may be done. |
protected java.lang.String |
encode(java.lang.String str)
Encodes a string so it is safe to use inside CDATA blocks |
boolean |
equals(java.lang.Object obj)
|
void |
focusComponent(Component component)
Sets the focus in the browser to the given component. |
static AjaxRequestTarget |
get()
Static method that returns current AjaxRequestTarget or null of no
AjaxRequestTarget is available. |
protected java.lang.String |
getEncodingName()
|
IHeaderResponse |
getHeaderResponse()
Returns the header response associated with current AjaxRequestTarget. |
java.lang.String |
getLastFocusedElementId()
Returns the HTML id of the last focused element. |
Page |
getPage()
Gets the page instance. |
int |
hashCode()
|
protected boolean |
needsEncoding(java.lang.String str)
|
void |
prependJavascript(java.lang.String javascript)
Adds javascript that will be evaluated on the client side before components are replaced |
void |
registerRespondListener(AjaxRequestTarget.ITargetRespondListener listener)
Register the given respond listener. |
void |
respond(RequestCycle requestCycle)
Generates a response. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AjaxRequestTarget(Page page)
page
- Method Detail |
---|
public Page getPage()
IPageRequestTarget
getPage
in interface IPageRequestTarget
public void addListener(AjaxRequestTarget.IListener listener)
listener
- public final void addChildren(MarkupContainer parent, java.lang.Class childCriteria)
childCriteria
parent
- childCriteria
- public void addComponent(Component component)
component
- component to be renderedpublic final void addComponent(Component component, java.lang.String markupId)
markupId
- id of client-side dom element that will be updatedcomponent
- component to be renderedpublic final void addJavascript(java.lang.String javascript)
javascript
- public final void focusComponent(Component component)
component
- The component to get the focus or null.public final void appendJavascript(java.lang.String javascript)
javascript
- public void detach(RequestCycle requestCycle)
IRequestTarget
detach
in interface IRequestTarget
requestCycle
- the current request cycleIRequestTarget.detach(org.apache.wicket.RequestCycle)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public final void prependJavascript(java.lang.String javascript)
javascript
- public void registerRespondListener(AjaxRequestTarget.ITargetRespondListener listener)
AjaxRequestTarget.ITargetRespondListener.onTargetRespond(AjaxRequestTarget)
method will be invoked when
the AjaxRequestTarget
starts to respond.
listener
- public final void respond(RequestCycle requestCycle)
IRequestTarget
respond
in interface IRequestTarget
requestCycle
- the current request cycleIRequestTarget.respond(org.apache.wicket.RequestCycle)
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
protected java.lang.String encode(java.lang.String str)
str
-
protected java.lang.String getEncodingName()
protected boolean needsEncoding(java.lang.String str)
str
-
public IHeaderResponse getHeaderResponse()
public static AjaxRequestTarget get()
AjaxRequestTarget
or null
of no
AjaxRequestTarget
is available.
AjaxRequestTarget
instance if current request is an Ajax request,
null
otherwise.public java.lang.String getLastFocusedElementId()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |