Package org.loboevolution.component

Class HtmlRendererContextImpl

java.lang.Object

org.loboevolution.component.HtmlRendererContextImpl

All Implemented Interfaces:

HtmlRendererContext

public class HtmlRendererContextImpl
extends Object
implements HtmlRendererContext

The HtmlRendererContextImpl class implements the HtmlRendererContextImpl interface. Note that this class provides rudimentary implementations of most callback methods. Overridding some methods in this class will usually be necessary in a professional application.

A simple way to load a URL into the HtmlPanel of the renderer context is to invoke navigate(String).

Field Summary

Fields

Modifier and Type	Field	Description
protected URLConnection	currentConnection

Constructor Summary

Constructors

Constructor	Description
HtmlRendererContextImpl(HtmlPanel htmlPanel, HtmlRendererContext parentRcontext, HtmlRendererConfig config)	Constructs a HtmlRendererContextImpl that is a child of another HtmlRendererContextImpl.
HtmlRendererContextImpl(HtmlPanel htmlPanel, UserAgentContext ucontext, HtmlRendererConfig config)	Constructs a HtmlRendererContextImpl.

Method Summary

Modifier and Type	Method	Description
void	alert(String message)	Opens a simple message dialog.
void	back()	It should navigate back one page.
void	blur()	It should give up focus on the current browser window.
void	close()	It should close the current browser window.
boolean	confirm(String message)	Opens a simple confirmation window.
void	error(String message)	error.
void	error(String message, Throwable throwable)	error.
void	focus()	It should request focus for the current browser window.
void	forward()	forward.
String	getCurrentURL()	Gets the current URL in history.
String	getDefaultStatus()	Should return true if and only if the current browser window is closed.
int	getHistoryLength()	getHistoryLength.
HtmlPanel	getHtmlPanel()	Getter for the field htmlPanel.
int	getInnerHeight()	getInnerHeight.
int	getInnerWidth()	getInnerWidth.
String	getNextURL()	getNextURL.
HtmlRendererContext	getOpener()	Getter for the field opener.
int	getOuterHeight()	getOuterHeight.
int	getOuterWidth()	getOuterWidth.
HtmlRendererContext	getParent()	Getter parent.
String	getPreviousURL()	getPreviousURL.
double	getScrollx()
double	getScrolly()
String	getStatus()	getStatus.
HtmlRendererContext	getTop()	Getter top.
UserAgentContext	getUserAgentContext()	If a UserAgentContext instance was provided in the constructor, then that instance is returned.
boolean	isClosed()	Should return true if and only if the current browser window is closed.
boolean	isTestEnabled()	isTest.
boolean	isVisitedLink(HTMLAnchorElement link)	isVisitedLink.
void	linkClicked(URL url, boolean isNewTab)	Implements the link click.
void	moveInHistory(int offset)	moveInHistory.
void	navigate(String fullURL)	Convenience method provided to allow loading a document into the renderer.
void	navigate(URL href, String target)	Implements simple navigation with incremental rendering by invoking HtmlRendererContext.submitForm(String, URL, String, String, FormInput[]) with a GET request method.
boolean	onContextMenu(HTMLElement element, MouseEvent event)	This method must be overridden to implement a context menu.
HtmlRendererContext	open(URL url, String windowName, String windowFeatures, boolean replace)	It should open a new browser window.
void	openImageViewer(String fullURL, InputStream stream)	openImageViewer.
void	openImageViewer(URL srcUrl)	openImageViewer.
String	prompt(String message, String inputDefault)	Shows a simple prompt dialog.
void	reload()	Implements reload as navigation to current URL.
void	resizeBy(double byWidth, double byHeight)	resizeBy.
void	resizeTo(double width, double height)	resizeTo.
void	scroll(double x, double y)	Changes the origin of the HTML block's scrollable area according to the position given.
void	scrollBy(double x, double y)	scrollBy.
void	setCursor(Cursor cursorOpt)	setCursor.
void	setDefaultStatus(String message)	setDefaultStatus.
void	setHtmlPanel(HtmlPanel panel)	Setter for the field htmlPanel.
void	setOpener(HtmlRendererContext opener)	Setter for the field opener.
void	setScrollx(double scrollx)
void	setScrolly(double scrolly)
void	setStatus(String message)	setStatus.
void	submitForm(String method, URL action, String target, String enctype, FormInput[] formInputs)	Implements simple navigation and form submission with incremental rendering and target processing, including frame lookup.
void	warn(String message)	warn.
void	warn(String message, Throwable throwable)	warn.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

currentConnection

protected URLConnection currentConnection

Constructor Details

HtmlRendererContextImpl

public HtmlRendererContextImpl(HtmlPanel htmlPanel,
 HtmlRendererContext parentRcontext,
 HtmlRendererConfig config)

Constructs a HtmlRendererContextImpl that is a child of another HtmlRendererContextImpl.

Parameters:

htmlPanel - a HtmlPanel object.

parentRcontext - The parent's renderer context.

config - a HtmlRendererConfig object.

HtmlRendererContextImpl

public HtmlRendererContextImpl(HtmlPanel htmlPanel,
 UserAgentContext ucontext,
 HtmlRendererConfig config)

Constructs a HtmlRendererContextImpl.

Parameters:

htmlPanel - a HtmlPanel object.

ucontext - a UserAgentContext object.

config - a HtmlRendererConfig object.

Method Details

alert

public void alert(String message)

Opens a simple message dialog.

Specified by:

alert in interface HtmlRendererContext

Parameters:

message - a String object.

back

public void back()

It should navigate back one page. This implementation does nothing and should be overridden.

Specified by:

back in interface HtmlRendererContext

blur

public void blur()

It should give up focus on the current browser window. This implementation does nothing and should be overridden.

Specified by:

blur in interface HtmlRendererContext

close

public void close()

It should close the current browser window. This implementation does nothing and should be overridden.

Specified by:

close in interface HtmlRendererContext

confirm

public boolean confirm(String message)

Opens a simple confirmation window.

Specified by:

confirm in interface HtmlRendererContext

Parameters:

message - a String object.

Returns:

a boolean.

error

public void error(String message)

error.

Specified by:

error in interface HtmlRendererContext

Parameters:

message - a String object.

error

public void error(String message,
 Throwable throwable)

error.

Specified by:

error in interface HtmlRendererContext

Parameters:

message - a String object.

throwable - a Throwable object.

focus

public void focus()

It should request focus for the current browser window. This implementation does nothing and should be overridden.

Specified by:

focus in interface HtmlRendererContext

forward

public void forward()

forward.

Specified by:

forward in interface HtmlRendererContext

getCurrentURL

public String getCurrentURL()

Gets the current URL in history.

Specified by:

getCurrentURL in interface HtmlRendererContext

getDefaultStatus

public String getDefaultStatus()

Should return true if and only if the current browser window is closed. This implementation returns false and should be overridden.

Specified by:

getDefaultStatus in interface HtmlRendererContext

Returns:

a String object.

getHtmlPanel

public HtmlPanel getHtmlPanel()

Getter for the field htmlPanel.

Specified by:

getHtmlPanel in interface HtmlRendererContext

getOpener

public HtmlRendererContext getOpener()

Getter for the field opener.

Specified by:

getOpener in interface HtmlRendererContext

Returns:

a HtmlRendererContext object.

getParent

public HtmlRendererContext getParent()

Getter parent.

Specified by:

getParent in interface HtmlRendererContext

Returns:

a HtmlRendererContext object.

getTop

public HtmlRendererContext getTop()

Getter top.

Specified by:

getTop in interface HtmlRendererContext

Returns:

a HtmlRendererContext object.

getUserAgentContext

public UserAgentContext getUserAgentContext()

If a UserAgentContext instance was provided in the constructor, then that instance is returned. Otherwise, an instance of UserAgentContext is created and returned.

The context returned by this method is used by local request facilities and other parts of the renderer.

Specified by:

getUserAgentContext in interface HtmlRendererContext

isClosed

public boolean isClosed()

Should return true if and only if the current browser window is closed. This implementation returns false and should be overridden.

Specified by:

isClosed in interface HtmlRendererContext

Returns:

a boolean.

isVisitedLink

public boolean isVisitedLink(HTMLAnchorElement link)

isVisitedLink.

Specified by:

isVisitedLink in interface HtmlRendererContext

Parameters:

link - a HTMLAnchorElement object.

Returns:

a boolean.

linkClicked

public void linkClicked(URL url,
 boolean isNewTab)

Implements the link click.

Specified by:

linkClicked in interface HtmlRendererContext

moveInHistory

public void moveInHistory(int offset)

moveInHistory.

Specified by:

moveInHistory in interface HtmlRendererContext

Parameters:

offset - a Integer object.

getPreviousURL

public String getPreviousURL()

getPreviousURL.

Specified by:

getPreviousURL in interface HtmlRendererContext

Returns:

a String object.

getNextURL

public String getNextURL()

getNextURL.

Specified by:

getNextURL in interface HtmlRendererContext

Returns:

a String object.

getHistoryLength

public int getHistoryLength()

getHistoryLength.

Specified by:

getHistoryLength in interface HtmlRendererContext

Returns:

a Integer object.

navigate

public void navigate(String fullURL)
              throws Exception

Convenience method provided to allow loading a document into the renderer.

Specified by:

navigate in interface HtmlRendererContext

Parameters:

fullURL - The absolute URL of the document.

Throws:

Exception

See Also:

• HtmlRendererContext.navigate(URL, String)

navigate

public void navigate(URL href,
 String target)

Implements simple navigation with incremental rendering by invoking HtmlRendererContext.submitForm(String, URL, String, String, FormInput[]) with a GET request method.

Specified by:

navigate in interface HtmlRendererContext

Parameters:

href - a URL object.

target - a String object.

onContextMenu

public boolean onContextMenu(HTMLElement element,
 MouseEvent event)

This method must be overridden to implement a context menu.

Specified by:

onContextMenu in interface HtmlRendererContext

Parameters:

element - a HTMLElement object.

event - a MouseEvent object.

Returns:

a boolean.

open

public HtmlRendererContext open(URL url,
 String windowName,
 String windowFeatures,
 boolean replace)

It should open a new browser window. This implementation does nothing and should be overridden.

Specified by:

open in interface HtmlRendererContext

Parameters:

url - The requested URL.

windowName - A window identifier.

windowFeatures - WindowImpl features specified in a format equivalent to that of window.open() in Javascript.

replace - Whether an existing window with the same name should be replaced.

Returns:

a HtmlRendererContext object.

openImageViewer

public void openImageViewer(URL srcUrl)

openImageViewer.

Specified by:

openImageViewer in interface HtmlRendererContext

Parameters:

srcUrl - a URL object.

openImageViewer

public void openImageViewer(String fullURL,
 InputStream stream)

openImageViewer.

Specified by:

openImageViewer in interface HtmlRendererContext

Parameters:

fullURL - a String object.

stream - a InputStream object.

prompt

public String prompt(String message,
 String inputDefault)

Shows a simple prompt dialog.

Specified by:

prompt in interface HtmlRendererContext

Parameters:

message - a String object.

inputDefault - a String object.

Returns:

a String object.

reload

public void reload()

Implements reload as navigation to current URL. Override to implement a more robust reloading mechanism.

Specified by:

reload in interface HtmlRendererContext

resizeBy

public void resizeBy(double byWidth,
 double byHeight)

resizeBy.

Specified by:

resizeBy in interface HtmlRendererContext

Parameters:

byWidth - a Double object.

byHeight - a Double object.

resizeTo

public void resizeTo(double width,
 double height)

resizeTo.

Specified by:

resizeTo in interface HtmlRendererContext

Parameters:

width - a Double object.

height - a Double object.

getInnerHeight

public int getInnerHeight()

getInnerHeight.

Specified by:

getInnerHeight in interface HtmlRendererContext

getInnerWidth

public int getInnerWidth()

getInnerWidth.

Specified by:

getInnerWidth in interface HtmlRendererContext

getOuterHeight

public int getOuterHeight()

getOuterHeight.

Specified by:

getOuterHeight in interface HtmlRendererContext

getOuterWidth

public int getOuterWidth()

getOuterWidth.

Specified by:

getOuterWidth in interface HtmlRendererContext

scroll

public void scroll(double x,
 double y)

Changes the origin of the HTML block's scrollable area according to the position given.

This method may be called outside of the GUI thread. The operation is scheduled immediately in that thread as needed.

Specified by:

scroll in interface HtmlRendererContext

Parameters:

x - The new x coordinate for the origin.

y - The new y coordinate for the origin.

scrollBy

public void scrollBy(double x,
 double y)

scrollBy.

Specified by:

scrollBy in interface HtmlRendererContext

Parameters:

x - a Double object.

y - a Double object.

getScrollx

public double getScrollx()

Specified by:

getScrollx in interface HtmlRendererContext

setScrollx

public void setScrollx(double scrollx)

Specified by:

setScrollx in interface HtmlRendererContext

getScrolly

public double getScrolly()

Specified by:

getScrolly in interface HtmlRendererContext

setScrolly

public void setScrolly(double scrolly)

Specified by:

setScrolly in interface HtmlRendererContext

setDefaultStatus

public void setDefaultStatus(String message)

setDefaultStatus.

Specified by:

setDefaultStatus in interface HtmlRendererContext

Parameters:

message - a String object.

setHtmlPanel

public void setHtmlPanel(HtmlPanel panel)

Setter for the field htmlPanel.

Specified by:

setHtmlPanel in interface HtmlRendererContext

Parameters:

panel - a HtmlPanel object.

setOpener

public void setOpener(HtmlRendererContext opener)

Setter for the field opener.

Specified by:

setOpener in interface HtmlRendererContext

Parameters:

opener - a HtmlRendererContext object.

setStatus

public void setStatus(String message)

setStatus.

Specified by:

setStatus in interface HtmlRendererContext

Parameters:

message - a String object.

setCursor

public void setCursor(Cursor cursorOpt)

setCursor.

Specified by:

setCursor in interface HtmlRendererContext

Parameters:

cursorOpt - a Cursor object.

submitForm

public void submitForm(String method,
 URL action,
 String target,
 String enctype,
 FormInput[] formInputs)

Implements simple navigation and form submission with incremental rendering and target processing, including frame lookup. Should be overridden to allow for more robust browser navigation and form submission.

Notes:

• Document encoding is defined by {link #getDocumentCharset(URLConnection)}.
• Caching is not implemented.
• Cookies are not implemented.
• Incremental rendering is not optimized for ignorable document change notifications.
• Other HTTP features are not implemented.
• The only form encoding type supported is application/x-www-form-urlencoded.
• Navigation is normally asynchronous.

Specified by:

submitForm in interface HtmlRendererContext

Parameters:

method - a String object.

action - a URL object.

target - a String object.

enctype - a String object.

formInputs - an array of FormInput objects.

See Also:

• HtmlRendererContext.navigate(URL, String)

warn

public void warn(String message)

warn.

Specified by:

warn in interface HtmlRendererContext

Parameters:

message - a String object.

warn

public void warn(String message,
 Throwable throwable)

warn.

Specified by:

warn in interface HtmlRendererContext

Parameters:

message - a String object.

throwable - a Throwable object.

getStatus

public String getStatus()

getStatus.

Specified by:

getStatus in interface HtmlRendererContext

Returns:

a String object.

isTestEnabled

public boolean isTestEnabled()

isTest.

Specified by:

isTestEnabled in interface HtmlRendererContext

Returns:

a boolean.