|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
com.jniwrapper.win32.ie.Browser
This component implements the WebBrowser interface and provides various
capabilities for a Java application, such as Web surfing, documents viewing, etc.
| Nested Class Summary |
| Nested classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
| Nested classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
| Nested classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
| Nested classes inherited from class com.jniwrapper.win32.ie.WebBrowser |
WebBrowser.Properties |
| Field Summary |
| Fields inherited from class javax.swing.JComponent |
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
| 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 | |
Browser()
Creates browser component. |
|
Browser(com.jniwrapper.win32.automation.OleMessageLoop oleMessageLoop)
Creates browser component. |
|
Browser(com.jniwrapper.win32.automation.OleMessageLoop oleMessageLoop,
java.lang.String pathKey)
Creates browser component. |
|
Browser(java.lang.String pathKey)
Creates browser component. |
|
| Method Summary | |
void |
addBrowserWindowListener(BrowserWindowListener listener)
Adds window listener. |
void |
addFocusListener(java.awt.event.FocusListener listener)
|
void |
addNavigationListener(NavigationEventListener listener)
Adds browser navigation event listener. |
void |
addNewWindowListener(NewWindowEventListener listener)
Adds new window listener. |
void |
addNotify()
|
void |
addStatusListener(StatusEventListener listener)
Adds browser status event listener. |
void |
addTrustedSizeToZone(java.lang.String pattern)
|
void |
close()
Closes browser. |
void |
execute(BrowserCommand command)
Executes specified command. |
java.lang.Object |
executeScript(java.lang.String javaScript)
Executes specified JavaScript code in a currently opened document. |
void |
firePropertyChange(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
Fires property change event. |
AuthenticateHandler |
getAuthenticateHandler()
Returns browser authenticate handler. |
java.lang.Object |
getBrowserPeer()
Returns an instance of the native web browser peer. |
BrowserWindowListener[] |
getBrowserWindowListeners()
Returns an array of window listeners. |
java.lang.String |
getContent()
Returns the HTML content of a document, opened in a browser. |
org.w3c.dom.Element |
getContextElement()
Returns element on which the context menu was invoked last time. |
ContextMenuProvider |
getContextMenuProvider()
Returns the context menu provider for the browser. |
java.util.Set |
getCookies(java.lang.String url)
Returns cookies, that are associated with the specified URL. |
DialogEventHandler |
getDialogEventHandler()
Gets dialog event handler. |
HTMLDocument |
getDocument()
Returns DOM document for page loaded into the browser. |
WebBrowserEventsHandler |
getEventHandler()
Returns browser event handler. |
java.awt.event.FocusListener[] |
getFocusListeners()
|
KeyFilter |
getKeyFilter()
Returns key filter. |
java.lang.String |
getLocationURL()
Returns the URL of the resource that Internet Explorer is currently displaying. |
java.util.List |
getNavigationListeners()
Returns browser navigation event listeners. |
NewWindowEventHandler |
getNewWindowHandler()
Returns new window handler. |
java.util.List |
getNewWindowListeners()
Returns new window listeners. |
com.jniwrapper.win32.automation.OleMessageLoop |
getOleMessageLoop()
Return browser OLE message loop. |
WebBrowser |
getParentBrowser()
Returns the parent of the browser. |
WebBrowser.Properties |
getProperties()
Returns extended browser properties. |
ReadyState |
getReadyState()
Returns the current ReadyState of the browser. |
WebBrowser |
getRecentChild()
Returns recent created child object since last trackChildren() method call. |
java.awt.Image |
getScreenShot(boolean wholePage)
Returns an image that represent screen shot of the page. |
ScriptErrorListener |
getScriptErrorListener()
Returns script error listener for current page. |
java.util.List |
getStatusListeners()
Returns browser status event listeners. |
java.lang.String |
getStatusText()
Returns the status text of the browser. |
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 home page. |
boolean |
isSilent()
Return true if alert, confirmation and error dialogs are disabled else returns false. |
void |
navigate(java.lang.String location)
Navigates to a resource specified by a URL or to the file identified by a full path. |
void |
navigate(java.lang.String location,
java.lang.String postData)
Navigates to a resource specified by a HTTP URL. |
void |
navigate(java.lang.String location,
java.lang.String targetName,
java.lang.String postData)
Navigates the browser to a location that might not be able to be expressed as a URL, such as a pointer to an item identifier list (PIDL) for an entity in the Microsoft Windows shell namespace. |
void |
refresh()
Reloads the file that is currently displayed in the object. |
void |
removeBrowserWindowListener(BrowserWindowListener listener)
Removes window listener. |
void |
removeFocusListener(java.awt.event.FocusListener listener)
|
void |
removeNavigationListener(NavigationEventListener listener)
Removes browser navigation event listener. |
void |
removeNewWindowListener(NewWindowEventListener listener)
Removes new window listener. |
void |
removeStatusListener(StatusEventListener listener)
Removes browser status event listener. |
void |
setAuthenticateHandler(AuthenticateHandler handler)
Sets browser authenticate handler. |
void |
setBounds(int x,
int y,
int width,
int height)
|
void |
setContent(java.lang.String htmlContent)
Set new HTML content. |
void |
setContextMenuProvider(ContextMenuProvider contextMenuProvider)
Sets the context menu provider for the browser. |
void |
setCookie(java.lang.String url,
Cookie cookie)
Creates a new cookie for the specified URL using WinINet API. |
void |
setCursor(java.awt.Cursor cursor)
|
void |
setDialogEventHandler(DialogEventHandler handler)
Sets dialog event handler. |
void |
setEnabled(boolean enabled)
|
void |
setEventHandler(WebBrowserEventsHandler handler)
Sets browser event handler. |
void |
setKeyFilter(KeyFilter keyFilter)
Sets key filter. |
void |
setNewWindowHandler(NewWindowEventHandler newWindowHandler)
Sets new window handler. |
void |
setParent(Browser browser)
|
void |
setParentBrowser(WebBrowser browser)
Sets the parent of the browser. |
void |
setScriptErrorListener(ScriptErrorListener listener)
Setups javascript error listener for current page. |
void |
setSilent(boolean isSilent)
Disables or enables alert, confirmation and error dialogs. |
void |
stop()
Cancels any pending navigation or download operation and stops any dynamic page elements, such as background sounds and animations. |
void |
trackChildren()
Starts to collect information about child object creation. |
WebBrowser |
waitChildCreation()
Blocks execution until child is created since last trackChildren() call and returns this child. |
WebBrowser |
waitChildCreation(java.lang.Runnable operationThatCreatesChild)
Executes operation specified in the parameter and returns when child created by the operation is opened. |
void |
waitReady()
Causes a current thread to wait for the completion of the current operation in the browser. |
void |
waitReady(long timeout)
Causes a current thread to wait for the completion of a current operation in the browser for a specified amount of milliseconds. |
| Methods inherited from class javax.swing.JComponent |
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI |
| Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
| Methods inherited from class java.awt.Component |
action, add, addComponentListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.jniwrapper.win32.ie.WebBrowser |
addPropertyChangeListener, removePropertyChangeListener |
| Constructor Detail |
public Browser()
public Browser(java.lang.String pathKey)
pathKey - the registry subkey string where the host stores its registry settingspublic Browser(com.jniwrapper.win32.automation.OleMessageLoop oleMessageLoop)
oleMessageLoop - the browser will be created in this message loop
public Browser(com.jniwrapper.win32.automation.OleMessageLoop oleMessageLoop,
java.lang.String pathKey)
oleMessageLoop - the browser will be created in this message looppathKey - the registry subkey string where the host stores its registry settings| Method Detail |
public void setParent(Browser browser)
public void addFocusListener(java.awt.event.FocusListener listener)
public void removeFocusListener(java.awt.event.FocusListener listener)
public java.awt.event.FocusListener[] getFocusListeners()
public void addNotify()
public void setBounds(int x,
int y,
int width,
int height)
public WebBrowser getParentBrowser()
WebBrowser
getParentBrowser in interface WebBrowsernull if the browser not has the parent.public void setParentBrowser(WebBrowser browser)
WebBrowser
setParentBrowser in interface WebBrowserbrowser - the parent of the browser.public java.lang.Object executeScript(java.lang.String javaScript)
executeScript in interface WebBrowserjavaScript - JavaScript to execute.
public void navigate(java.lang.String location)
navigate in interface WebBrowserlocation - URL to navigate to.public void addTrustedSizeToZone(java.lang.String pattern)
public void navigate(java.lang.String location,
java.lang.String postData)
navigate in interface WebBrowserlocation - URL to navigate to.postData - HTTP post data (for example, "name=Alex&product=Pizza")
public void navigate(java.lang.String location,
java.lang.String targetName,
java.lang.String postData)
navigate in interface WebBrowserlocation - URL to navigate to.targetName - string that contains the name of the frame in which to display the resource.postData - HTTP post data (for example, "name=Alex&product=Pizza").public java.lang.String getLocationURL()
getLocationURL in interface WebBrowserpublic void goForward()
goForward in interface WebBrowserpublic void goBack()
goBack in interface WebBrowserpublic void goHome()
goHome in interface WebBrowserpublic void refresh()
refresh in interface WebBrowserpublic void stop()
stop in interface WebBrowserpublic void execute(BrowserCommand command)
execute in interface WebBrowsercommand - browser command.public HTMLDocument getDocument()
getDocument in interface WebBrowserjava.lang.IllegalStateException - if WebBrowser.waitReady() method isn't called after last call of WebBrowser.navigate() or
WebBrowser.setContent() methods.WebBrowser.waitReady(),
WebBrowser.navigate(String),
WebBrowser.setContent(String)public void setContent(java.lang.String htmlContent)
setContent in interface WebBrowserhtmlContent - HTML content to set.public java.lang.String getContent()
getContent in interface WebBrowserpublic void setContextMenuProvider(ContextMenuProvider contextMenuProvider)
If context menu provider for the browser is null then show default context menu.
If the provider isn't null then show custom menu or don't show any menu
(depends from ContextMenuProvider implementation).
contextMenuProvider - context menu provider instance or null.public ContextMenuProvider getContextMenuProvider()
If context menu provider for the browser is null then show default context menu.
If the provider isn't null then show custom menu or don't show any menu
(depends from ContextMenuProvider implementation).
null.public java.lang.String getStatusText()
getStatusText in interface WebBrowserpublic ReadyState getReadyState()
ReadyState of the browser.
getReadyState in interface WebBrowser
public void firePropertyChange(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
propertyName - property nameoldValue - old property valuenewValue - new property valuepublic java.lang.Object getBrowserPeer()
getBrowserPeer in interface WebBrowserjava.lang.IllegalStateException - if the passed browser does not have a native peer.public void waitReady()
Important: successful call of this method guaranties that you can get DOM document of loaded page.
Please see typical usage of this method in the code below:
// navigate to Google page
browser.navigate("google.com");
// wait until page completely loaded
browser.waitReady();
// DOM document is available
Document document = browser.getDocument();
WebBrowser.waitReady() call after navigation call
then IllegalStateException is thrown in WebBrowser.getDocument() call.
waitReady in interface WebBrowserWebBrowser.navigate(String),
WebBrowser.setContent(String),
WebBrowser.getDocument()public void waitReady(long timeout)
waitReady in interface WebBrowsertimeout - the number of milliseconds to wait.public org.w3c.dom.Element getContextElement()
public void addNavigationListener(NavigationEventListener listener)
addNavigationListener in interface WebBrowserlistener - browser event listener.public void removeNavigationListener(NavigationEventListener listener)
removeNavigationListener in interface WebBrowserlistener - browser event listener.public java.util.List getNavigationListeners()
getNavigationListeners in interface WebBrowserpublic void addStatusListener(StatusEventListener listener)
addStatusListener in interface WebBrowserlistener - browser event listener.public java.util.List getStatusListeners()
getStatusListeners in interface WebBrowserpublic void removeStatusListener(StatusEventListener listener)
removeStatusListener in interface WebBrowserlistener - browser event listener.public void setAuthenticateHandler(AuthenticateHandler handler)
setAuthenticateHandler in interface WebBrowserhandler - authenticate handlerpublic AuthenticateHandler getAuthenticateHandler()
getAuthenticateHandler in interface WebBrowserpublic WebBrowserEventsHandler getEventHandler()
getEventHandler in interface WebBrowserpublic void setEventHandler(WebBrowserEventsHandler handler)
setEventHandler in interface WebBrowserhandler - event handlerpublic void setScriptErrorListener(ScriptErrorListener listener)
setScriptErrorListener in interface WebBrowserlistener - javascript error listenerpublic ScriptErrorListener getScriptErrorListener()
getScriptErrorListener in interface WebBrowserpublic void close()
close in interface WebBrowserpublic void setSilent(boolean isSilent)
setSilent in interface WebBrowserisSilent - if true then enter to silent mode else leave silent mode.public boolean isSilent()
isSilent in interface WebBrowserpublic com.jniwrapper.win32.automation.OleMessageLoop getOleMessageLoop()
getOleMessageLoop in interface SingleThreadedComponentpublic DialogEventHandler getDialogEventHandler()
getDialogEventHandler in interface WebBrowserpublic void setDialogEventHandler(DialogEventHandler handler)
setDialogEventHandler in interface WebBrowserhandler - dialog event handlerpublic void setNewWindowHandler(NewWindowEventHandler newWindowHandler)
setNewWindowHandler in interface WebBrowsernewWindowHandler - new window handlerpublic NewWindowEventHandler getNewWindowHandler()
getNewWindowHandler in interface WebBrowserpublic void addNewWindowListener(NewWindowEventListener listener)
addNewWindowListener in interface WebBrowserlistener - new window listenerpublic void removeNewWindowListener(NewWindowEventListener listener)
removeNewWindowListener in interface WebBrowserlistener - new window listenerpublic java.util.List getNewWindowListeners()
getNewWindowListeners in interface WebBrowserpublic void trackChildren()
ParentWindow
trackChildren in interface ParentWindowpublic WebBrowser getRecentChild()
ParentWindowtrackChildren() method call.
getRecentChild in interface ParentWindowtrackChildren() method call.
If there isn't opened windows after this call then returns null.public WebBrowser waitChildCreation()
ParentWindowtrackChildren() call and returns this child.
In other words, this method waits until getRecentChild() call returns non-null object.
waitChildCreation in interface ParentWindowpublic WebBrowser waitChildCreation(java.lang.Runnable operationThatCreatesChild)
ParentWindow
waitChildCreation in interface ParentWindowoperationThatCreatesChild - operation
public void setCookie(java.lang.String url,
Cookie cookie)
InternetSetCookie native function.
setCookie in interface WebBrowserurl - specifies an URL, a new cookie will be associated with.cookie - specifies a new cookie.public java.util.Set getCookies(java.lang.String url)
InternetGetCookie native function.
getCookies in interface WebBrowserurl - specifies an URL.
public void setKeyFilter(KeyFilter keyFilter)
WebBrowser
setKeyFilter in interface WebBrowserkeyFilter - key filterpublic KeyFilter getKeyFilter()
WebBrowser
getKeyFilter in interface WebBrowserpublic java.awt.Image getScreenShot(boolean wholePage)
wholePage - if true returns the whole page not just what is visible
public WebBrowser.Properties getProperties()
WebBrowser
getProperties in interface WebBrowserpublic void addBrowserWindowListener(BrowserWindowListener listener)
WebBrowser
addBrowserWindowListener in interface WebBrowserlistener - the window listenerpublic void removeBrowserWindowListener(BrowserWindowListener listener)
WebBrowser
removeBrowserWindowListener in interface WebBrowserlistener - the window listenerpublic BrowserWindowListener[] getBrowserWindowListeners()
WebBrowser
getBrowserWindowListeners in interface WebBrowserpublic void setCursor(java.awt.Cursor cursor)
public void setEnabled(boolean enabled)
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||