|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IHeaderResponse
Interface that is used to render header elements (usually javascript and CSS references). Implementation of this interface is responsible for filtering duplicate contributions (so that for example the same javascript is not loaded twice) during the same request.
Method Summary | |
---|---|
void |
close()
Mark Header rendering is completed and subsequent usage will be ignored. |
Response |
getResponse()
Returns the response that can be used to write arbitrary text to the head section. |
boolean |
isClosed()
|
void |
markRendered(Object object)
Marks the given object as rendered. |
void |
renderCSS(CharSequence css,
String id)
Renders CSS code to the response, if the CSS has not already been rendered. |
void |
renderCSSReference(ResourceReference reference)
Writes a CSS reference, if the specified reference hasn't been rendered yet. |
void |
renderCSSReference(ResourceReference reference,
PageParameters pageParameters,
String media)
Writes a CSS reference with query parameters, if the specified reference hasn't been rendered yet. |
void |
renderCSSReference(ResourceReference reference,
PageParameters pageParameters,
String media,
String condition)
Writes a conditional IE comment with a CSS reference with query parameters, if the specified reference hasn't been rendered yet. |
void |
renderCSSReference(ResourceReference reference,
String media)
Writes a CSS reference, if the specified reference hasn't been rendered yet. |
void |
renderCSSReference(String url)
Writes a CSS reference, if the specified reference hasn't been rendered yet. |
void |
renderCSSReference(String url,
String media)
Writes a link to a CSS resource, if the specified url hasn't been rendered yet. |
void |
renderCSSReference(String url,
String media,
String condition)
Writes a conditional IE comment for a link to a CSS resource, if the specified url hasn't been rendered yet. |
void |
renderJavaScript(CharSequence javascript,
String id)
Renders javascript code to the response, if the javascript has not already been rendered. |
void |
renderJavaScriptReference(ResourceReference reference)
Writes a javascript reference, if the specified reference hasn't been rendered yet. |
void |
renderJavaScriptReference(ResourceReference reference,
PageParameters pageParameters,
String id)
Writes a javascript reference with query parameters, if the specified reference hasn't been rendered yet. |
void |
renderJavaScriptReference(ResourceReference reference,
PageParameters pageParameters,
String id,
boolean defer)
Writes a javascript reference with query parameters, if the specified reference hasn't been rendered yet. |
void |
renderJavaScriptReference(ResourceReference reference,
PageParameters pageParameters,
String id,
boolean defer,
String charset)
Writes a javascript reference with query parameters, if the specified reference hasn't been rendered yet. |
void |
renderJavaScriptReference(ResourceReference reference,
String id)
Writes a javascript reference, if the specified reference hasn't been rendered yet. |
void |
renderJavaScriptReference(String url)
Writes a javascript reference, if the specified reference hasn't been rendered yet. |
void |
renderJavaScriptReference(String url,
String id)
Writes a javascript reference, if the specified reference hasn't been rendered yet. |
void |
renderJavaScriptReference(String url,
String id,
boolean defer)
Writes a javascript reference, if the specified reference hasn't been rendered yet. |
void |
renderJavaScriptReference(String url,
String id,
boolean defer,
String charset)
Writes a javascript reference, if the specified reference hasn't been rendered yet. |
void |
renderOnDomReadyJavaScript(String javascript)
Renders javascript that is executed right after the DOM is built, before external resources (e.g. images) are loaded. |
void |
renderOnEventJavaScript(String target,
String event,
String javascript)
Renders javascript that is executed after the given event happens on specified target |
void |
renderOnLoadJavaScript(String javascript)
Renders javascript that is executed after the entire page is loaded. |
void |
renderString(CharSequence string)
Renders an arbitrary string to the header. |
boolean |
wasRendered(Object object)
Returns whether the given object has been marked as rendered. |
Method Detail |
---|
void renderJavaScriptReference(ResourceReference reference)
reference
- resource reference pointing to the javascript resourcevoid renderJavaScriptReference(ResourceReference reference, String id)
reference
- resource reference pointing to the javascript resourceid
- id that will be used to filter duplicate reference (it's still filtered by URL
too)void renderJavaScriptReference(ResourceReference reference, PageParameters pageParameters, String id)
reference
- resource reference pointing to the javascript resourcepageParameters
- the parameters for this Javascript resource referenceid
- id that will be used to filter duplicate reference (it's still filtered by URL
too)void renderJavaScriptReference(ResourceReference reference, PageParameters pageParameters, String id, boolean defer)
reference
- resource reference pointing to the javascript resourcepageParameters
- the parameters for this Javascript resource referenceid
- id that will be used to filter duplicate reference (it's still filtered by URL
too)defer
- specifies that the execution of a script should be deferred (delayed) until after
the page has been loaded.void renderJavaScriptReference(ResourceReference reference, PageParameters pageParameters, String id, boolean defer, String charset)
reference
- resource reference pointing to the javascript resourcepageParameters
- the parameters for this Javascript resource referenceid
- id that will be used to filter duplicate reference (it's still filtered by URL
too)defer
- specifies that the execution of a script should be deferred (delayed) until after
the page has been loaded.charset
- a non null value specifies the charset attribute of the script tagvoid renderJavaScriptReference(String url)
url
- context-relative url of the the javascript resourcevoid renderJavaScriptReference(String url, String id)
url
- context-relative url of the the javascript resourceid
- id that will be used to filter duplicate reference (it's still filtered by URL
too)void renderJavaScriptReference(String url, String id, boolean defer)
url
- context-relative url of the the javascript resourceid
- id that will be used to filter duplicate reference (it's still filtered by URL
too)defer
- specifies that the execution of a script should be deferred (delayed) until after
the page has been loaded.void renderJavaScriptReference(String url, String id, boolean defer, String charset)
url
- context-relative url of the the javascript resourceid
- id that will be used to filter duplicate reference (it's still filtered by URL
too)defer
- specifies that the execution of a script should be deferred (delayed) until after
the page has been loaded.charset
- a non null value specifies the charset attribute of the script tagvoid renderJavaScript(CharSequence javascript, String id)
script
tags will be added to the output.
javascript
- javascript content to be rendered.id
- unique id for the javascript element. This can be null, however in that case the
ajax header contribution can't detect duplicate script fragments.void renderCSS(CharSequence css, String id)
css
- css content to be rendered.id
- unique id for the <style> element. This can be null
, however in
that case the ajax header contribution can't detect duplicate CSS fragments.void renderCSSReference(ResourceReference reference)
reference
- resource reference pointing to the CSS resourcevoid renderCSSReference(String url)
url
- context-relative url of the CSS resourcevoid renderCSSReference(ResourceReference reference, String media)
reference
- resource reference pointing to the CSS resourcemedia
- the media type for this CSS ("print", "screen", etc.)void renderCSSReference(ResourceReference reference, PageParameters pageParameters, String media)
reference
- resource reference pointing to the CSS resourcepageParameters
- the parameters for this CSS resource referencemedia
- the media type for this CSS ("print", "screen", etc.)void renderCSSReference(ResourceReference reference, PageParameters pageParameters, String media, String condition)
public void renderHead(IHeaderResponse response) {
WebClientInfo clientInfo = (WebClientInfo) getSession().getClientInfo();
ClientProperties properties = clientInfo.getProperties();
if (properties.isBrowserInternetExplorer() && properties.getBrowserVersionMajor() >= 8) {
response.renderCSSReference(new PackageResourceReference(MyPage.class, "my-conditional.css" ));
}
}
reference
- resource reference pointing to the CSS resourcepageParameters
- the parameters for this CSS resource referencemedia
- the media type for this CSS ("print", "screen", etc.)condition
- the condition to use for Internet Explorer conditional comments. E.g. "IE 7".void renderCSSReference(String url, String media)
url
- context-relative url of the CSS resourcemedia
- the media type for this CSS ("print", "screen", etc.)void renderCSSReference(String url, String media, String condition)
public void renderHead(IHeaderResponse response) {
WebClientInfo clientInfo = (WebClientInfo) getSession().getClientInfo();
ClientProperties properties = clientInfo.getProperties();
if (properties.isBrowserInternetExplorer() && properties.getBrowserVersionMajor() >= 8) {
response.renderCSSReference(new PackageResourceReference(MyPage.class, "my-conditional.css" ));
}
}
url
- context-relative url of the CSS resourcemedia
- the media type for this CSS ("print", "screen", etc.)condition
- the condition to use for Internet Explorer conditional comments. E.g. "IE 7".void renderString(CharSequence string)
Note: This method is kind of dangerous as users are able to write to the output whatever they like.
string
- string to be rendered to headvoid markRendered(Object object)
object
- object to be marked as rendered.boolean wasRendered(Object object)
renderJavaScriptReference
and renderCSSReference
mark
the specified ResourceReference
as rendered.
renderJavaScript
marks List of two elements (first is javascript body
CharSequence and second is id) as rendered.
renderString
marks the whole string as rendered.
markRendered
can be used to mark an arbitrary object as rendered
object
- Object that is queried to be rendered
Response getResponse()
Note: This method is kind of dangerous as users are able to write to the output whatever they like.
void renderOnDomReadyJavaScript(String javascript)
javascript
- void renderOnLoadJavaScript(String javascript)
javascript
- void renderOnEventJavaScript(String target, String event, String javascript)
target
- event
- javascript
- void close()
close
in interface Closeable
boolean isClosed()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |