Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.businessobjects.rebean.wi
Interface HTMLView

All Superinterfaces:
CharacterView
public interface HTMLView
extends CharacterView

The HTMLView interface provides HTML output format encapsulation.

Method Summary
 void getContent(java.io.Writer writer, java.lang.String headExtension, java.lang.String bodyParameters)
          Improved performance return of a documents HTML content.
 java.lang.String getStringPart(java.lang.String part)
          Deprecated. use HTMLView.getContent(Writer, String, String)
 java.lang.String getStringPart(java.lang.String part, boolean delimIncluded)
          Deprecated. use HTMLView.getContent(Writer, String, String)
 java.lang.String getUserAgent()
          Returns the HTTP user agent request header field used to generate HTML output.
 void setUserAgent(java.lang.String userAgent)
          Sets the HTTP user agent request header field used to generate HTML output.
 
Methods inherited from interface com.businessobjects.rebean.wi.CharacterView
getContent, getEncoding, getStream
 

Method Detail

getStringPart

@Deprecated
java.lang.String getStringPart(java.lang.String part)
                               throws REException
Deprecated. use HTMLView.getContent(Writer, String, String)

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the content of the document in HTML output format. This function is the equivalent of calling getStringPart(part, false).

Parameters:
part - the part of the output format to return.
Returns:
the document's content.
Throws:
REException
See Also:
HTMLView.getStringPart(String, boolean)

getStringPart

@Deprecated
java.lang.String getStringPart(java.lang.String part,
                                          boolean delimIncluded)
                               throws REException
Deprecated. use HTMLView.getContent(Writer, String, String)

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the content of the document in HTML output format.
Note: Any HTML part of the document can be specified to be returned. If you want to retrieve the document's entire HTML content, use the HTMLView.getContent(Writer writer, String headExtension, String bodyParameters) method.

Parameters:
part - part of the output format to return:
  • head
  • body

delimIncluded - True The delimiter tag, such as <body></body> is included.
False The delimiter tag is not included.
Returns:
a string containing a document's content in HTML format.
Throws:
REException

getUserAgent

java.lang.String getUserAgent()
Returns the HTTP user agent request header field used to generate HTML output. UserAgent is used for transforming XML to HTML according to the client's browser.

Note: If this value is not set, the report engine will generate an HTML output compatible with Microsoft Internet Explorer

Returns:
the User Agent of the client

setUserAgent

void setUserAgent(java.lang.String userAgent)
Sets the HTTP user agent request header field used to generate HTML output. UserAgent is used for transforming XML to HTML according to the client's browser.

Note: If this value is not set, the report engine will generate an HTML output compatible with Microsoft Internet Explorer

Parameters:
userAgent - the User Agent of the client

getContent

void getContent(java.io.Writer writer,
                java.lang.String headExtension,
                java.lang.String bodyParameters)
Improved performance return of a documents HTML content. The HTML is directly streamed to the Writer given as the first parameter.
Note: headExtension and bodyParameters are not used if they are passed an empty string.

Parameters:
writer - the writer to which the SDK writes the HTML result.
headExtension - scripts to go at the end of the the <head></head> tags.
bodyParameters - extra parameters appended to the current <body> tag. These parameters should be provided as an escaped string, such as "onLoad=\"onInit()\""
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD