com.goldencode.p2j.ui

Interface HtmlBrowser

All Superinterfaces:

Sizeable, WrappedResource

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

HtmlBrowserWidget

public interface HtmlBrowser
extends WrappedResource, Sizeable

Definitions of APIs required by the HTML-BROWSER widget.

Method Summary

Modifier and Type	Method and Description
character	getContextPath() Getter for the CONTEXT-PATH attribute.
character	getResourceBase() Getter for the RESOURCE-BASE attribute.
void	openHTMLString(character html) Assigns the supplied string as the html content in the widget.
void	openHTMLString(longchar html) Assigns the supplied string as the html content in the widget.
logical	openWebPage(character url) Open the specified web page.
logical	openWebPage(character url, BaseDataType unused, character target) Open the specified web page.
logical	openWebPage(character url, character target) Open the specified web page.
void	postMessage(character message) Posts a message to the HTML loaded by the widget.
void	postMessage(longchar message) Posts a message to the HTML loaded by the widget.
void	print() Prints the currently opened web page.
void	setContextPath(character value) Setter for the CONTEXT-PATH attribute.
void	setResourceBase(character value) Setter for the RESOURCE-BASE attribute.

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.util.Sizeable

getHeight, getHeightChars, getHeightPixels, getWidth, getWidthChars, getWidthPixels, setHeight, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidth, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels

Method Detail

getContextPath

character getContextPath()

Getter for the CONTEXT-PATH attribute.

Returns:

the attribute value.

setContextPath

void setContextPath(character value)

Setter for the CONTEXT-PATH attribute.

Parameters:

value - the attribute value

getResourceBase

character getResourceBase()

Getter for the RESOURCE-BASE attribute.

Returns:

the attribute value.

setResourceBase

void setResourceBase(character value)

Setter for the RESOURCE-BASE attribute.

Parameters:

value - the attribute value

openWebPage

logical openWebPage(character url,
                    character target)

Open the specified web page.

Parameters:

url - The target URL.

target - The page target - unused.

Returns:

true if opening the page was possible.

openWebPage

logical openWebPage(character url,
                    BaseDataType unused,
                    character target)

Open the specified web page.

Parameters:

url - The target URL.

unused - The parameter is currently unused.

target - The page target - unused.

Returns:

true if opening the page was possible.

openWebPage

logical openWebPage(character url)

Open the specified web page.

Parameters:

url - The target URL.

Returns:

true if opening the page was possible.

openHTMLString

void openHTMLString(longchar html)

Assigns the supplied string as the html content in the widget.

Parameters:

html - The html string.

openHTMLString

void openHTMLString(character html)

Assigns the supplied string as the html content in the widget.

Parameters:

html - The html string.

print

void print()

Prints the currently opened web page.

postMessage

void postMessage(character message)

Posts a message to the HTML loaded by the widget.

Parameters:

message - The string representation of the message.

postMessage

void postMessage(longchar message)

Posts a message to the HTML loaded by the widget.

Parameters:

message - The string representation of the message.