com.sapportals.htmlb.htmlcontainer

Class IsolatedHtmlContainer

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.htmlcontainer.IsolatedHtmlContainer

public class IsolatedHtmlContainer

extends Component

The IsolatedHtmlContainer displays a html document, which is represented by its URL, inside an iFrame.
Becaue Netscape 4.7 does not support iFrames, this control is only available for Internet Explorer and Netscape 6.0 and above.
In Netscape 4.7 the URL will be rendered as link with target _blank.

Some html documents take control of the entire browser window although running in an iFrame. Be sure that your document does not take control of the entire browser window!

Note that the html document can cause browser dependencies!

Copyright 2004 SAP AG

Field Summary

static String

UI_ID

Constructor Summary

IsolatedHtmlContainer(String srcUrl)
Creates an IsolatedHtmlContainer

Method Summary

String	getHeight() gets the height of the IsolatedHtmlContainer
String	getName()
Scrolling	getScrolling() gets the scrolling behaviour of the IsolatedHtmlContainer
String	getSrcUrl() gets the URL to be loaded by the iFrame
String	getTooltip() gets the tooltip of the IsolatedHtmlContainer.
String	getUI() get a identification String for the renderer that is unique across all supported components.
String	getWidth() gets the width of the IsolatedHtmlContainer
boolean	isBordered() determines if the IsolatedHtmlContainer has a border.
boolean	requiresForm() check if a special component really requires a form around it.
void	setBordered(boolean border) sets if the IsolatedHtmlContainer has a border.
void	setHeight(String height) sets the the height of the IsolatedHtmlContainer
void	setName(String name)
void	setScrolling(Scrolling scrolling) sets the scrolling behaviour of the IsolatedHtmlContainer
void	setSrcURL(String srcUrl) sets the URL to be loaded by the iFrame
void	setTooltip(String tooltip) sets the tooltip of the IsolatedHtmlContainer.
void	setWidth(String width) sets the the width of the IsolatedHtmlContainer

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

IsolatedHtmlContainer

public IsolatedHtmlContainer(String srcUrl)

Creates an IsolatedHtmlContainer

Parameters:

srcUrl - the URL to be loaded by the iFrame

Method Detail

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

getSrcUrl

public String getSrcUrl()

gets the URL to be loaded by the iFrame

Returns:

the URL

setSrcURL

public void setSrcURL(String srcUrl)

sets the URL to be loaded by the iFrame

Parameters:

srcUrl - the URL to be loaded

getHeight

public String getHeight()

gets the height of the IsolatedHtmlContainer

Returns:

height of the IsolatedHtmlContainer

setHeight

public void setHeight(String height)

sets the the height of the IsolatedHtmlContainer

Parameters:

height - height of the IsolatedHtmlContainer in pixel or percent

getWidth

public String getWidth()

gets the width of the IsolatedHtmlContainer

Returns:

width of the IsolatedHtmlContainer

setWidth

public void setWidth(String width)

sets the the width of the IsolatedHtmlContainer

Parameters:

width - width of the IsolatedHtmlContainer in pixel or percent

getScrolling

public Scrolling getScrolling()

gets the scrolling behaviour of the IsolatedHtmlContainer

Returns:

scrolling scrolling behaviour of the IsolatedHtmlContainer

setScrolling

public void setScrolling(Scrolling scrolling)

sets the scrolling behaviour of the IsolatedHtmlContainer

Parameters:

scrolling - scrolling behaviour of the IsolatedHtmlContainer

isBordered

public boolean isBordered()

determines if the IsolatedHtmlContainer has a border. Default value is false.

Returns:

true if the IsolatedHtmlContainer has a border

setBordered

public void setBordered(boolean border)

sets if the IsolatedHtmlContainer has a border. Default value is false.

Parameters:

border - true if the IsolatedHtmlContainer should have a border

getTooltip

public String getTooltip()

gets the tooltip of the IsolatedHtmlContainer.

Returns:

tooltip of the IsolatedHtmlContainer.

setTooltip

public void setTooltip(String tooltip)

sets the tooltip of the IsolatedHtmlContainer.

requiresForm

public boolean requiresForm()

check if a special component really requires a form around it. The IsolatedHtmlContainer never require a form.

Overrides:

requiresForm in class Component

Returns:

false

getName

public String getName()

Returns:

setName

public void setName(String name)