com.teamdev.jexplorer

Class Browser

java.lang.Object

java.awt.Component

java.awt.Canvas

com.teamdev.jexplorer.Browser

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class Browser
extends java.awt.Canvas

Represents AWT component that can be embedded into Java Swing container to display web pages loaded in web browser engine associated with the Browser instance. When you create Browser instance, its MS IE web engine will be automatically created and initialized. MS IE web engine is running in a separate native process.

When you don't need to use Browser instance, you must destroy it using dispose() method to free allocated memory and terminate appropriate native process. Before you dispose it, it's recommended that you remove component from Swing container where it was embedded.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Canvas

java.awt.Canvas.AccessibleAWTCanvas

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
Browser() Constructs a new Browser instance with new BrowserContext.
Browser(BrowserContext context) Constructs a new Browser instance with specific context.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDisposeListener(DisposeListener listener)
void	addMouseEventListener(MouseEventListener listener)
void	addNavigationListener(NavigationListener listener)
void	addNotify()
void	addPrintEventListener(PrintEventListener listener)
void	addScriptErrorListener(ScriptErrorListener listener)
void	addStatusListener(StatusListener listener)
void	addWindowListener(WindowListener listener)
void	clearCache(InternetCacheEntry cacheEntry) Clears the Internet Explorer cache.
void	dispose() Disposes web browser engine associated with the current Browser instance, clears allocated memory and terminates corresponding native process if it's necessary.
JSValue	executeScript(java.lang.String javaScript) Executes javaScript code in the main frame of the currently loaded document.
AuthenticationHandler	getAuthenticationHandler() Returns authentication handler or null if handler isn't installed.
java.lang.String	getContent() Returns the string that represents HTML content of a currently loaded document in WebBrowser.
java.lang.String	getContent(boolean original) Returns the string that represents HTML content of a currently loaded document in WebBrowser.
BrowserContext	getContext() Returns context associated with the current Browser instance.
ContextMenuProvider	getContextMenuProvider()
java.util.List<Cookie>	getCookies(java.lang.String url) Returns cookies associated with the url or empty collection is no cookies available for this URL.
java.lang.String	getDefaultUserAgent() Returns default user-agent string.
DialogHandler	getDialogHandler()
java.util.List<DisposeListener>	getDisposeListeners()
DOMDocument	getDocument() Returns DOM document of the currently loaded web page or null if web page isn't loaded completely or it's not HTML document.
java.lang.String	getDocumentType() Returns string that represents type of the currently loaded document.
EventsHandler	getEventsHandler()
HTMLDialogListener	getHTMLDialogListener() Returns the current HTML Dialog listener or null if it's not registered.
HttpSecurityHandler	getHttpSecurityHandler() Returns http security handler that allows processing any security problems or null if it's not present.
KeyFilter	getKeyFilter()
java.lang.String	getLocationURL() Returns location of the currently loaded HTML document.
java.awt.Dimension	getMinimumSize()
java.util.List<NavigationListener>	getNavigationListeners()
PopupHandler	getPopupHandler()
java.util.List<PrintEventListener>	getPrintEventListeners()
ProxyConfiguration	getProxy() Returns proxy settings for the current Browser instance.
java.awt.Image	getScreenShot(boolean wholePage) Returns an image that represent screen shot of the page.
java.awt.Image	getScreenShot(java.awt.Dimension dimension) Returns an image that represent screen shot of the page.
java.util.List<ScriptErrorListener>	getScriptErrorListeners()
SecurityPolicyHandler	getSecurityPolicyHandler()
java.util.List<StatusListener>	getStatusListeners()
java.lang.String	getTitle() Returns string that represents title of the currently loaded document.
java.lang.String	getUserAgent() Returns user-agent string of the current Browser instance that was set using the setUserAgent(String) method.
java.util.List<WindowListener>	getWindowListeners()
int	getZoomLevel() Returns zoom level for the current Browser instance.
void	goBack() Navigates backward one item in the history list.
void	goForward() Navigates forward one item in the history list.
void	goHome() Navigates to the current home or start page.
static void	invokeAndWaitLoadMainFrame(Browser browser, Callback<Browser> callback) Invokes callback and waits until main frame is loaded completely blocking current thread execution.
static void	invokeAndWaitLoadMainFrame(Browser browser, Callback<Browser> callback, int timeoutInSeconds) Invokes callback and waits until main frame is loaded completely blocking current thread execution.
boolean	isDisposed() Returns true if current Browser instance is disposed.
boolean	isInternetFeatureEnabled(InternetFeature feature) Indicates whether MS Internet Explorer feature is enabled or not.
boolean	isSilent() Indicates whether silent mode is enabled or not.
void	navigate(java.lang.String url) Navigates to an entire web resource specified by url.
void	navigate(java.lang.String url, java.lang.String postData) Navigates to an entire web resource specified by url.
void	navigate(java.lang.String url, java.lang.String target, java.lang.String postData) Navigates to an entire web resource specified by url.
void	navigate(java.lang.String url, java.lang.String target, java.lang.String postData, java.lang.String headers) Navigates to an entire web resource specified by url.
void	navigate(java.lang.String url, java.lang.String target, java.lang.String postData, java.lang.String headers, int flags) Navigates to an entire web resource specified by url with HTTP postData and additional custom headers into a specified window defined by target.
void	print() Prints currently loaded web page silently with empty header and footer.
void	print(boolean prompt, java.lang.String header, java.lang.String footer) Prints currently loaded web page.
void	refresh() Reloads the file that is currently displayed in the object.
void	registerFunction(java.lang.String functionName, BrowserFunction function) Registers a browser function on the currently loaded document.
void	removeDisposeListener(DisposeListener listener)
void	removeMouseEventListener(MouseEventListener listener)
void	removeNavigationListener(NavigationListener listener)
void	removeNotify()
void	removePrintEventListener(PrintEventListener listener)
void	removeScriptErrorListener(ScriptErrorListener listener)
void	removeStatusListener(StatusListener listener)
void	removeWindowListener(WindowListener listener)
void	requestFocus() Request browser focus
void	setAuthenticationHandler(AuthenticationHandler authenticationHandler) Sets a new handler for basic, digest and NTLM authentication.
void	setBrowserProperties(BrowserProperties properties)
void	setContent(java.lang.String htmlContent) Sets the specified HTML content to the current WebBrowser document.
void	setContextMenuProvider(ContextMenuProvider contextMenuProvider)
void	setCookie(java.lang.String url, Cookie... cookie) Sets/updates cookie associated with specified url.
void	setCookies(java.lang.String url, java.util.Collection<Cookie> cookies) Sets/updates list of cookies associated with specified url.
void	setDialogHandler(DialogHandler handler)
void	setEventsHandler(EventsHandler handler)
void	setHTMLDialogListener(HTMLDialogListener listener) Sets the specified HTML Dialog listener that allows receiving event when the HTML Dialog is shown and its document is loaded completely.
void	setHttpSecurityHandler(HttpSecurityHandler securityHandler) Sets the specified HTTP security handler that allows processing any security problems such as Invalid Certificate error, Invalid Certificate Name, Invalid Certificate Date, Moving from a non-SSL to an SSL connection because of a redirect or The redirection requires user confirmation problems.
void	setInternetFeatureEnabled(InternetFeature feature, boolean enable) Enables/disables MS Internet Explorer feature.
void	setKeyFilter(KeyFilter keyFilter)
void	setPopupHandler(PopupHandler handler)
void	setProxy(ProxyConfiguration conf) Updates proxy configuration for the current Browser instance.
void	setSecurityPolicyHandler(SecurityPolicyHandler handler)
void	setSilent(boolean silent) Enables or disables silent mode.
void	setUserAgent(java.lang.String userAgent) Configures Browser instance to use a custom userAgent string.
void	setZoomLevel(int zoomLevel) Updates zoom level for all web pages in the current Browser instance.
void	stop() Cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations.

Methods inherited from class java.awt.Canvas

createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, paint, update

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Browser

public Browser()

Constructs a new Browser instance with new BrowserContext.

Browser

public Browser(BrowserContext context)

Constructs a new Browser instance with specific context.

Parameters:

context - associated with the Browser instance. Cannot be null.

Throws:

java.lang.IllegalArgumentException - when context is null.

Method Detail

getDocument

public DOMDocument getDocument()

Returns DOM document of the currently loaded web page or null if web page isn't loaded completely or it's not HTML document.

Returns:

DOM document of the currently loaded web page.

setAuthenticationHandler

public void setAuthenticationHandler(AuthenticationHandler authenticationHandler)

Sets a new handler for basic, digest and NTLM authentication.

Parameters:

authenticationHandler - a new authentication handler. Can be null.

getHttpSecurityHandler

public HttpSecurityHandler getHttpSecurityHandler()

Returns http security handler that allows processing any security problems or null if it's not present. By default this method always returns null and all security problems are processing by default Internet Explorer security handler.

Returns:

the current http security handler that allows processing any security problems or null if it's not present

setHttpSecurityHandler

public void setHttpSecurityHandler(HttpSecurityHandler securityHandler)

Sets the specified HTTP security handler that allows processing any security problems such as Invalid Certificate error, Invalid Certificate Name, Invalid Certificate Date, Moving from a non-SSL to an SSL connection because of a redirect or The redirection requires user confirmation problems.

Parameters:

securityHandler - the specified HTTP security handler.

getAuthenticationHandler

public AuthenticationHandler getAuthenticationHandler()

Returns authentication handler or null if handler isn't installed.

Returns:

authentication handler or null if handler isn't installed.

addNotify

public void addNotify()

Overrides:

addNotify in class java.awt.Canvas

removeNotify

public void removeNotify()

Overrides:

removeNotify in class java.awt.Component

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class java.awt.Component

getContext

public BrowserContext getContext()

Returns context associated with the current Browser instance.

setProxy

public void setProxy(ProxyConfiguration conf)

Updates proxy configuration for the current Browser instance.

Parameters:

conf - new proxy configuration.

getProxy

public ProxyConfiguration getProxy()

Returns proxy settings for the current Browser instance.

Returns:

proxy settings for the current Browser instance.

setInternetFeatureEnabled

public void setInternetFeatureEnabled(InternetFeature feature,
                             boolean enable)

Enables/disables MS Internet Explorer feature.

Parameters:

feature - to enable/disable.

enable - true to enable feature, false to disable.

isInternetFeatureEnabled

public boolean isInternetFeatureEnabled(InternetFeature feature)

Indicates whether MS Internet Explorer feature is enabled or not.

Parameters:

feature - MS IE feature.

Returns:

true when feature is enabled, otherwise - false.

executeScript

public JSValue executeScript(java.lang.String javaScript)

Executes javaScript code in the main frame of the currently loaded document.

Parameters:

javaScript - JavaScript code to execute. Cannot be null or empty string.

Returns:

result of JavaScript execution. Always returns a valid JSValue.

Throws:

java.lang.IllegalArgumentException - when javaScript is null or empty.

setHTMLDialogListener

public void setHTMLDialogListener(HTMLDialogListener listener)

Sets the specified HTML Dialog listener that allows receiving event when the HTML Dialog is shown and its document is loaded completely. The HTML Dialog can be opened using the window.showModalDialog and window.showModelessDialog JavaScript functions.

Parameters:

listener - the specified HTML Dialog listener.

See Also:

getHTMLDialogListener()

getHTMLDialogListener

public HTMLDialogListener getHTMLDialogListener()

Returns the current HTML Dialog listener or null if it's not registered.

Returns:

the current HTML Dialog listener or null if it's not registered.

addPrintEventListener

public void addPrintEventListener(PrintEventListener listener)

removePrintEventListener

public void removePrintEventListener(PrintEventListener listener)

addMouseEventListener

public void addMouseEventListener(MouseEventListener listener)

removeMouseEventListener

public void removeMouseEventListener(MouseEventListener listener)

getPrintEventListeners

public java.util.List<PrintEventListener> getPrintEventListeners()

print

public void print()

Prints currently loaded web page silently with empty header and footer.

print

public void print(boolean prompt,
         java.lang.String header,
         java.lang.String footer)

Prints currently loaded web page.

Parameters:

prompt - indicates whether printing should be silent or Print dialog should be displayed.

header - page header text.

footer - page footer text.

navigate

public void navigate(java.lang.String url)

Navigates to an entire web resource specified by url.

This method is executed asynchronously. To make sure that required URL is loaded completely use the NavigationListener.mainDocumentCompleted(Browser, String) event.

Parameters:

url - the URL of the resource to load and display. Cannot be null or empty string.

navigate

public void navigate(java.lang.String url,
            java.lang.String postData)

Navigates to an entire web resource specified by url.

This method is executed asynchronously. To make sure that required URL is loaded completely use the NavigationListener.mainDocumentCompleted(Browser, String) event.

Parameters:

url - the URL of the resource to load and display. Cannot be null or empty string.

postData - HTTP post data (for example, "name=Alex&product=Pizza").

navigate

public void navigate(java.lang.String url,
            java.lang.String target,
            java.lang.String postData)

Navigates to an entire web resource specified by url.

This method is executed asynchronously. To make sure that required URL is loaded completely use the NavigationListener.mainDocumentCompleted(Browser, String) event.

Parameters:

url - the URL of the resource to load and display. Cannot be null or empty string.

target - the string that contains the name of the frame in which to display the resource. The possible values for this parameter are.

• _blank - Load the link into a new unnamed window.
• _parent - Load the link into the immediate parent of the document the link is in.
• _self - Load the link into the same window the link was clicked in.
• _top - Load the link into the full body of the current window.
• WindowName - A named HTML frame. If no frame or window exists that matches the specified target name, a new window is opened for the specified link.

postData - HTTP post data (for example, "name=Alex&product=Pizza").

navigate

public void navigate(java.lang.String url,
            java.lang.String target,
            java.lang.String postData,
            java.lang.String headers)

Navigates to an entire web resource specified by url.

This method is executed asynchronously. To make sure that required URL is loaded completely use the NavigationListener.mainDocumentCompleted(Browser, String) event.

Parameters:

url - the URL of the resource to load and display. Cannot be null or empty string.

target - the string that contains the name of the frame in which to display the resource. The possible values for this parameter are.

• _blank - Load the link into a new unnamed window.
• _parent - Load the link into the immediate parent of the document the link is in.
• _self - Load the link into the same window the link was clicked in.
• _top - Load the link into the full body of the current window.
• WindowName - A named HTML frame. If no frame or window exists that matches the specified target name, a new window is opened for the specified link.

postData - HTTP post data (for example, "name=Alex&product=Pizza").

headers - the string that contains additional HTTP headers to send to the server. These headers are added to the default Windows Internet Explorer headers. For example, headers can specify the action required of the server, the type of data being passed to the server, or a status code. This parameter is ignored if the URL is not an HTTP (or HTTPS) URL.

navigate

public void navigate(java.lang.String url,
            java.lang.String target,
            java.lang.String postData,
            java.lang.String headers,
            int flags)

Navigates to an entire web resource specified by url with HTTP postData and additional custom headers into a specified window defined by target.

This method is executed asynchronously. To make sure that required URL is loaded completely use the NavigationListener.mainDocumentCompleted(Browser, String) event.

Parameters:

url - the URL of the resource to load and display. Cannot be null or empty string.

target - the string that contains the name of the frame in which to display the resource. The possible values for this parameter are.

• _blank - Load the link into a new unnamed window.
• _parent - Load the link into the immediate parent of the document the link is in.
• _self - Load the link into the same window the link was clicked in.
• _top - Load the link into the full body of the current window.
• WindowName - A named HTML frame. If no frame or window exists that matches the specified target name, a new window is opened for the specified link.

postData - HTTP post data (for example, "name=Alex&product=Pizza").

headers - the string that contains additional HTTP headers to send to the server. These headers are added to the default Windows Internet Explorer headers. For example, headers can specify the action required of the server, the type of data being passed to the server, or a status code. This parameter is ignored if the URL is not an HTTP (or HTTPS) URL.

flags - browser navigation flag. Description of every flag can be found at http://msdn.microsoft.com/en-us/library/aa768360(v=vs.85).aspx

Throws:

java.lang.IllegalArgumentException - when url is null or empty.

getLocationURL

public java.lang.String getLocationURL()

Returns location of the currently loaded HTML document.

getTitle

public java.lang.String getTitle()

Returns string that represents title of the currently loaded document.

Returns:

title of the currently loaded document.

getScreenShot

public java.awt.Image getScreenShot(boolean wholePage)

Returns an image that represent screen shot of the page.

Parameters:

wholePage - if true returns the whole page not just what is visible

Returns:

an image that represent screen shot of the page

getScreenShot

public java.awt.Image getScreenShot(java.awt.Dimension dimension)

Returns an image that represent screen shot of the page.

Parameters:

dimension - - dimension of area to render

Returns:

an image that represent screen shot of the page

goForward

public void goForward()

Navigates forward one item in the history list.

goBack

public void goBack()

Navigates backward one item in the history list.

goHome

public void goHome()

Navigates to the current home or start page.

refresh

public void refresh()

Reloads the file that is currently displayed in the object.

This method is the same as clicking the Refresh button or pressing F5 in Windows Internet Explorer.

To save time and network bandwidth, the WebBrowser control store pages from recently visited sites in cached memory on the user's hard disk. When you revisit a Web site, the page is reloaded from the local disk instead of being downloaded again from the server. To ensure that you are viewing the most current version of the page, you can force a fresh download by using this method. This method adds the "Pragma: No-cache" HTTP header to the request.

stop

public void stop()

Cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations.

setContent

public void setContent(java.lang.String htmlContent)

Sets the specified HTML content to the current WebBrowser document.

Parameters:

htmlContent - a string that represents HTML content to set to the current document. Cannot be null or empty.

getContent

public java.lang.String getContent()

Returns the string that represents HTML content of a currently loaded document in WebBrowser.

Returns:

the string that contains a combination of text and tags.

getContent

public java.lang.String getContent(boolean original)

Returns the string that represents HTML content of a currently loaded document in WebBrowser.

Parameters:

original - if true then returns the original HTML content (like View Source command in context menu of Internet Explorer browser), otherwise this method returns the actual content of a document according to its DOM.

Returns:

the string that contains a combination of text and tags.

getScriptErrorListeners

public java.util.List<ScriptErrorListener> getScriptErrorListeners()

addScriptErrorListener

public void addScriptErrorListener(ScriptErrorListener listener)

removeScriptErrorListener

public void removeScriptErrorListener(ScriptErrorListener listener)

addWindowListener

public void addWindowListener(WindowListener listener)

removeWindowListener

public void removeWindowListener(WindowListener listener)

getWindowListeners

public java.util.List<WindowListener> getWindowListeners()

addNavigationListener

public void addNavigationListener(NavigationListener listener)

removeNavigationListener

public void removeNavigationListener(NavigationListener listener)

getNavigationListeners

public java.util.List<NavigationListener> getNavigationListeners()

addStatusListener

public void addStatusListener(StatusListener listener)

getStatusListeners

public java.util.List<StatusListener> getStatusListeners()

removeStatusListener

public void removeStatusListener(StatusListener listener)

getEventsHandler

public EventsHandler getEventsHandler()

setEventsHandler

public void setEventsHandler(EventsHandler handler)

setPopupHandler

public void setPopupHandler(PopupHandler handler)

getPopupHandler

public PopupHandler getPopupHandler()

dispose

public void dispose()

Disposes web browser engine associated with the current Browser instance, clears allocated memory and terminates corresponding native process if it's necessary. Once you call this method, you cannot use the current Browser instance anymore. To make sure that Browser is disposed use the isDisposed() method.

isDisposed

public boolean isDisposed()

Returns true if current Browser instance is disposed. Otherwise false.

addDisposeListener

public void addDisposeListener(DisposeListener listener)

removeDisposeListener

public void removeDisposeListener(DisposeListener listener)

getDisposeListeners

public java.util.List<DisposeListener> getDisposeListeners()

setDialogHandler

public void setDialogHandler(DialogHandler handler)

getDialogHandler

public DialogHandler getDialogHandler()

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Configures Browser instance to use a custom userAgent string.

Parameters:

userAgent - the string that represents a new user-agent. Cannot be null or empty.

Throws:

java.lang.IllegalArgumentException - when userAgent is null or empty.

getUserAgent

public java.lang.String getUserAgent()

Returns user-agent string of the current Browser instance that was set using the setUserAgent(String) method. Returns empty string if no customer user-agent string was set.

getDefaultUserAgent

public java.lang.String getDefaultUserAgent()

Returns default user-agent string.

getZoomLevel

public int getZoomLevel()

Returns zoom level for the current Browser instance.

setZoomLevel

public void setZoomLevel(int zoomLevel)

Updates zoom level for all web pages in the current Browser instance.

requestFocus

public void requestFocus()

Request browser focus

Overrides:

requestFocus in class java.awt.Component

setSilent

public void setSilent(boolean silent)

Enables or disables silent mode. When silent mode is enabled, all JavaScript dialogs such as alert, confirm or error dialogs will be suppressed.

Parameters:

silent - true to enable silent mode, otherwise false.

isSilent

public boolean isSilent()

Indicates whether silent mode is enabled or not.

Returns:

true when silent mode is enabled.

setCookies

public void setCookies(java.lang.String url,
              java.util.Collection<Cookie> cookies)

Sets/updates list of cookies associated with specified url.

Parameters:

url - URL address associated with the cookies. Cannot be null or empty.

cookies - list of new cookies.

Throws:

java.lang.IllegalArgumentException - when url or cookies is null.

setCookie

public void setCookie(java.lang.String url,
             Cookie... cookie)

Sets/updates cookie associated with specified url.

Parameters:

url - URL address associated with the cookie. Cannot be null or empty.

cookie - a new cookie.

Throws:

java.lang.IllegalArgumentException - when url or cookie is null.

getCookies

public java.util.List<Cookie> getCookies(java.lang.String url)

Returns cookies associated with the url or empty collection is no cookies available for this URL.

Parameters:

url - URL address for cookies. Cannot be null or empty.

Returns:

list of cookies associated with the url.

registerFunction

public void registerFunction(java.lang.String functionName,
                    BrowserFunction function)

Registers a browser function on the currently loaded document. This function can be invoked on JavaScript side via its functionName. The browser function is not available anymore if document is reloaded or other web page is loaded.

getDocumentType

public java.lang.String getDocumentType()

Returns string that represents type of the currently loaded document.

Returns:

type of the currently loaded document.

setSecurityPolicyHandler

public void setSecurityPolicyHandler(SecurityPolicyHandler handler)

getSecurityPolicyHandler

public SecurityPolicyHandler getSecurityPolicyHandler()

setKeyFilter

public void setKeyFilter(KeyFilter keyFilter)

getKeyFilter

public KeyFilter getKeyFilter()

getContextMenuProvider

public ContextMenuProvider getContextMenuProvider()

setContextMenuProvider

public void setContextMenuProvider(ContextMenuProvider contextMenuProvider)

invokeAndWaitLoadMainFrame

public static void invokeAndWaitLoadMainFrame(Browser browser,
                              Callback<Browser> callback)
                                       throws java.util.concurrent.TimeoutException

Invokes callback and waits until main frame is loaded completely blocking current thread execution. If main frame document wasn't loaded within LatchUtil.WAIT_SECONDS seconds, method throws TimeoutException. You can change default timeout via "jexplorer.ipc.timeout.seconds" System Property.

Parameters:

browser - instance that will wait for main frame loading completion. Cannot be null.

callback - contains task that initiates web page loading. Cannot be null.

Throws:

java.lang.IllegalArgumentException - when browser or callback is null.

java.util.concurrent.TimeoutException - when main document hasn't been loaded completely by the time when operation times out.

invokeAndWaitLoadMainFrame

public static void invokeAndWaitLoadMainFrame(Browser browser,
                              Callback<Browser> callback,
                              int timeoutInSeconds)
                                       throws java.util.concurrent.TimeoutException

Invokes callback and waits until main frame is loaded completely blocking current thread execution. If main frame document wasn't loaded completely within timeoutInSeconds, method throws TimeoutException.

Parameters:

browser - instance that will wait for main frame loading completion. Cannot be null.

callback - contains task that initiates web page loading. Cannot be null.

timeoutInSeconds - contains task that initiates web page loading. Cannot be null.

Throws:

java.lang.IllegalArgumentException - when browser or callback is null, or timeoutInSeconds <= 0;

java.util.concurrent.TimeoutException - when main document hasn't been loaded completely by the time when operation times out.

clearCache

public void clearCache(InternetCacheEntry cacheEntry)

Clears the Internet Explorer cache.

To clear:

Internet Temporary files pass InternetCacheEntry.NORMAL_CACHE_ENTRY value. All stored cookies pass InternetCacheEntry.COOKIE_CACHE_ENTRY value. URL history pass InternetCacheEntry.URLHISTORY_CACHE_ENTRY value.

Parameters:

cacheEntry - Internet cache entry type that will be cleared.

setBrowserProperties

public void setBrowserProperties(BrowserProperties properties)