|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.web.component.ContentRenderingInstruction
public class ContentRenderingInstruction
Represents an instruction that the container uses to decide whether to render the associated
web component or not during any given rendering cycle. It also instructs the container to either
send or not send the output to the requesting client.
The decision is made based on content ID values which are calculated based on the associated
web component content. Depending on the instruction type these ID values can be calculated from the
rendered content or custom custom values can be used to avoid unnecessary rendering.
Instances of this class are returned by ContentRenderingInstructionsProvider
implementations.
Method Summary | |
---|---|
static ContentRenderingInstruction |
customContentId(String contentId)
Instruction to use the passed content ID value to make a desicion. |
static ContentRenderingInstruction |
dontRender()
The associated component will not be rendered and output will not be sent to the client. |
String |
getContentId()
|
boolean |
isDontRender()
|
boolean |
isRenderHtml()
|
static ContentRenderingInstruction |
renderHtml()
The associated component will be rendered. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static ContentRenderingInstruction dontRender()
public static ContentRenderingInstruction renderHtml()
public static ContentRenderingInstruction customContentId(String contentId)
public String getContentId()
public boolean isDontRender()
public boolean isRenderHtml()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |