com.sapportals.htmlb

Class HTMLFragment

java.lang.Object
  extended bycom.sapportals.htmlb.Component
      extended bycom.sapportals.htmlb.HTMLFragment

public class HTMLFragment
extends Component

Special container for raw HTML. Note that using this class might cause Browser dependencies.


Field Summary
static String UI_ID
           
 
Constructor Summary
HTMLFragment(String htmlText)
           
 
Method Summary
 String getHtml()
          gets the raw HTML data that should be rendered by this component
 String getUI()
          get a identification String for the renderer that is unique across all supported components.
 boolean requiresForm()
          an HTMLFragment does not require a Form.
 void setHtml(String html)
          sets the raw HTML data that should be rendered by this component
 
Methods inherited from class com.sapportals.htmlb.Component
getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, preRender, render, renderAsString, setId, setJsObjectNeeded, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UI_ID

public static final String UI_ID
See Also:
Constant Field Values
Constructor Detail

HTMLFragment

public HTMLFragment(String htmlText)
Method Detail

getHtml

public String getHtml()
gets the raw HTML data that should be rendered by this component

Returns:
the raw HTML

setHtml

public void setHtml(String html)
sets the raw HTML data that should be rendered by this component

Parameters:
html - the raw HTML

getUI

public String getUI()
get a identification String for the renderer that is unique across all supported components. E.g. you could simply return the class name of the component class. The reason for using a separate method and not some internal reflection method is that you can more easily extend the functionality or your Component class without having to rewrite the view class.

Specified by:
getUI in class Component
Returns:
a unique identification string for this Component

requiresForm

public boolean requiresForm()
an HTMLFragment does not require a Form.

Overrides:
requiresForm in class Component
Returns:
false


Copyright 2006 SAP AG Complete Copyright Notice