EncodedMarkupOutput

Class Overview

This object is used to perform everything MakrupOuptput is supposed to do but with js encoding performed upon appending a string. This object is used when the final output of a transform is in a form of a json object and the HTML is just a value of its "content" attribute.

Summary

[Expand] Inherited Methods

From interface com.microstrategy.web.beans.MarkupOutput abstract void addBlock(Block block) Adds a "root-level" Block to this MarkupOutput instance. abstract void addErrorInfo(String error) Append more error information to the MarkupOutput. abstract void addHeader(String key, String value) Adds a header with the specified key value pair. abstract void append(byte[] element) Adds data at the end of the MarkupOutput object. abstract void append(MarkupOutput element) Adds data at the end of the MarkupOutput object. abstract void append(ComponentBlock child) Append a ComponentBlock object to the MarkupOutput if the "primary" ComponentBlock is set it will be appended as its children otherwise it will be appended to a list field and then gets appended to a ComponentBlock later abstract void append(String element) Adds data at the end of the MarkupOutput object. abstract void append(Object element) Adds data at the end of the MarkupOutput object. abstract void append(MarkupOutput element, boolean encode) Adds data at the end of the EncodedMarkupOutput object. abstract void appendHtml(String element) Adds encoded HTML data at the end of the MarkupOutput object. abstract void appendJS(String element) Adds encoded JSON data at the end of the MarkupOutput object. abstract int chunkCount() Returns the number of chunks contained in the MarkupOutput object. abstract byte[] getBinaryChunkAt(int i) Returns the byte array chunk at the specified index. abstract byte[] getBinaryContent() Get all of the binary data in the MarkupOutput at once. abstract boolean getBinaryMode() Returns whether the output is set to collate binary or text data. abstract Block getBlock(int index) Returns the ith "root level" Block associated with this MarkupOutput object. abstract BlockContext getBlockContext() Returns the current "block context" object which is used for BlockProperty value expansion and overall Block serialization. abstract int getBlockCount() Returns the number of "root level" Blocks populated by a transform or layout file and associated with this MarkupOutput instance. abstract List<ComponentBlock> getChildBlocks() Gets the list of child ComponentBlocks abstract ComponentBlock getComponentBlock() Returns the "primpary" ComponentBlock this MarkupOutput instance holds abstract int getContentLength() Returns the length of the content. abstract String getContentType() Returns the content-type associated with this output. abstract String getCopyAsString() Returns the content of this object in the String format. abstract StringBuffer getErrorInfo() Returns the error information that is held by this MarkupOutput instance. abstract int getHeaderCount() Returns the header count. abstract String getHeaderKey(int i) Returns the header key at the specified index. abstract String getHeaderValue(String key) Returns the header value for the given header key. abstract String getTextChunkAt(int i) Returns the String chunk at the specified index. abstract Object getUnserializedObject() Gets the UnserializedObject member which is used to contain the actual unprocessed output object. abstract boolean hasChildBlocks() Returns a flag indicating whether the child ComponentBlocks list is empty or not abstract boolean hasComponentBlock() Returns a flag indicating whether the "primary" ComponentBlock is set or not abstract boolean hasErrorInfo() Returns the flag which indicates whether this MarkupOutput instance has with error information recorded or not abstract void send(OutputStream outStream) The results are sent back to the user via the supplied OutputStream object. abstract void send(Writer writer) The results are sent back to the user via the implicit out object. abstract void setBinaryContent(byte[] bytes) Replaces the existing binary content with a new byte array. abstract void setBlockContext(BlockContext blockContext) Sets the current "block context" object which is used for BlockProperty value expansion and overall Block serialization. abstract void setComponentBlock(ComponentBlock cb) Sets the "primary" ComponentBlock on the MarkupOutput instance once it's set all the other ComponentBlock will be appended as its children abstract void setContentType(String contentType) Sets the Content-Type associated with this output. abstract void setErrorInfo(StringBuffer error) Set error information onto the MarkupOutput. abstract void setUnserializedObject(Object unserializedObject) Sets the UnserializedObject member which is used to contain the actual unprocessed output object.