|
JDIC API V2006 Release 0308 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Canvas
org.jdesktop.jdic.browser.WebBrowser
public class WebBrowser
A WebBrowser
component represents a blank rectangular area of
the screen onto which the application can load webpages or from which the
application can trap events from the browser window. In order to show
WebBrowser
component in GUI, users need to add WebBrowser
to a top-level
container, such as Frame
.
The class that is interested in processing a WebBrowser
event
should implement interface WebBrowserListener
, and the object
created with that class should use WebBrowser's addWebBrowserListener
method to register as a listener.
As an AWT component, a WebBrowser
component must be hosted by
a native container somewhere higher up in the component tree (for example, by
a JPanel object).
WebBrowserEvent
,
WebBrowserListener
,
Serialized FormNested 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.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 | |
---|---|
WebBrowser()
Constructs a new WebBrowser object with no URL specified. |
|
WebBrowser(boolean autoDispose)
Constructs a new WebBrowser object with the specified
boolean value autoDispose as the flag which indicates
whether this instance will automatically dispose itself in
removeNotify()
or should be disposed by the developer directly calling
dispose() . |
|
WebBrowser(java.net.URL url)
Constructs a new WebBrowser with an URL specified. |
|
WebBrowser(java.net.URL url,
boolean autoDispose)
Constructs a new WebBrowser with an specified URL and
boolean flag to indicate the dispose schema. |
Method Summary | |
---|---|
void |
addNotify()
Creates the peer for this WebBrowser component. |
void |
addWebBrowserListener(WebBrowserListener listener)
Adds a WebBrowserEvent listener to the listener list. |
java.awt.Component |
asComponent()
Returns the component to which the Browser paints. |
void |
back()
Navigates backward one item in the history list. |
void |
dispatchWebBrowserEvent(WebBrowserEvent e)
|
void |
dispose()
Release this instance's resource and make it undisplayable. |
java.lang.String |
executeScript(java.lang.String javaScript)
Executes the specified JavaScript code on the currently loaded document. |
void |
forward()
Navigates forward one item in the history list. |
static java.lang.String |
getBrowserBinary()
Deprecated. As of release 0.9 of JDIC. This method was unnecessarily exposed and will be removed in a future release. |
IBrowserEngine |
getBrowserEngine()
The BrowserEngine that was responsible for creating the browser instance. |
java.lang.String |
getContent()
Returns the HTML content of a document, loaded in a browser. |
java.lang.String |
getInitFailureMessage()
|
int |
getInstanceNum()
A IWebBrowser must have a ticket to identify itself, here is the instance num.For a IWebBrowser instance, a native browser instance will be created to deal with its requests, this instance num will be used get according native browser instance. |
int |
getNativeWindow()
Get the windows' handler of native window |
java.net.URL |
getURL()
Returns the URL of the resource that is currently being loaded. |
WebBrowserListener[] |
getWebBrowserListeners()
Returns an array of all the registered WebBrowser listeners. |
boolean |
isAutoDispose()
Return the boolean flag which indicates how to dispose this instance. |
boolean |
isBackEnabled()
Checks whether this WebBrowser object's back command is
enabled. |
boolean |
isForwardEnabled()
Checks whether this WebBrowser object's forward command is
enabled. |
boolean |
isInitialized()
Checks whether this WebBrowser object is initialized
successfully. |
boolean |
isSynchronize()
If the webbrowser works under synchronize model |
void |
paint(java.awt.Graphics g)
Could only get HWND when this method is called.This will fix the can't get awt HWND error. |
void |
print()
Prints the currently loaded document. |
void |
refresh()
Reloads the URL that is currently loaded in the WebBrowser component. |
void |
removeNotify()
Makes this WebBrowser component undisplayable by destroying it native screen resource if the isAutoDispose() return true. |
void |
removeWebBrowserListener(WebBrowserListener listener)
Removes a WebBrowserEvent listener from the listener list. |
void |
setBounds(int x,
int y,
int width,
int height)
Moves and resizes this component. |
void |
setContent(java.lang.String htmlContent)
Sets new HTML content. |
static void |
setDebug(boolean b)
Enables or disables debug message output. |
void |
setInitFailureMessage(java.lang.String msg)
|
void |
setInitialized(boolean b)
Set if the IWebBrowser has been initialized. |
void |
setURL()
Sets the loaded page to be a blank page. |
void |
setURL(java.net.URL url)
Navigates to a resource identified by a URL. |
void |
setURL(java.net.URL url,
java.lang.String postData)
Navigates to a resource identified by a URL, with the HTTP POST data to send to the server. |
void |
setURL(java.net.URL url,
java.lang.String postData,
java.lang.String headers)
Navigates to a resource identified by a URL, with the HTTP POST data and HTTP headers to send to the server. |
void |
stop()
Stops any page loading and rendering activities. |
void |
syncSetURL(java.net.URL url)
Synchronously navigates to a resource identified by a URL. |
void |
syncSetURL(java.net.URL url,
java.lang.String postData)
Synchronously navigates to a resource identified by a URL, with the HTTP POST data to send to the server. |
void |
syncSetURL(java.net.URL url,
java.lang.String postData,
java.lang.String headers)
Synchronously navigates to a resource identified by a URL, with the HTTP POST data and HTTP headers to send to the server. |
protected boolean |
willOpenURL(java.net.URL url)
Called before a navigation occurs. |
protected boolean |
willOpenWindow(java.net.URL url)
Called when a new window is to be created for loading a resource. |
Methods inherited from class java.awt.Canvas |
---|
createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, 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, 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, getMinimumSize, 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, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, 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 |
---|
public WebBrowser()
WebBrowser
object with no URL specified.
This instance will automatically dispose itself when removeNotify()
is called.
This constructor is equivalent to WebBrowser(true)
.
WebBrowser(boolean)
,
removeNotify()
,
dispose()
public WebBrowser(boolean autoDispose)
WebBrowser
object with the specified
boolean value autoDispose
as the flag which indicates
whether this instance will automatically dispose itself in
removeNotify()
or should be disposed by the developer directly calling
dispose()
.
This constructor is equivalent to WebBrowser(null, autoDispose)
.
autoDispose
- ture to indicate this instance will automatically dispose
itself in removeNotify()
; false to indicate
the developer should call dispose()
when this
instance is no longer needed.removeNotify()
,
dispose()
,
isAutoDispose()
public WebBrowser(java.net.URL url)
WebBrowser
with an URL specified. This
instance will automatically dispose itself when removeNotify()
is called.
This constructor is equivalent to WebBrowser(url, true)
.
url
- the URL to be shown in this instance.WebBrowser(boolean)
,
removeNotify()
,
dispose()
public WebBrowser(java.net.URL url, boolean autoDispose)
WebBrowser
with an specified URL and
boolean flag to indicate the dispose schema.
url
- the URL to be shown in this instance.autoDispose
- ture to indicate this instance will automatically dispose
itself in removeNotify()
; false to indicate
the developer should call dispose()
when this
instance is no longer needed.removeNotify()
,
dispose()
,
isAutoDispose()
Method Detail |
---|
public void setInitialized(boolean b)
IWebBrowser
setInitialized
in interface IWebBrowser
public void setInitFailureMessage(java.lang.String msg)
setInitFailureMessage
in interface IWebBrowser
public void paint(java.awt.Graphics g)
paint
in class java.awt.Canvas
public void addNotify()
addNotify
in class java.awt.Canvas
removeNotify()
public void removeNotify()
isAutoDispose()
return true. Or
just make this instance invisible if the isAutoDispose()
return false.
This method is called by the toolkit internally and should not be called directly by programs.
If isAutoDispose()
return false, developer should call
dispose()
when this instance is no longer needed.
Otherwise, it resource will never be released untill this JVM exit.
removeNotify
in class java.awt.Component
addNotify()
,
dispose()
,
isAutoDispose()
public void dispose()
isAutoDispose()
return true, this method will be called by the toolkit internally. If
isAutoDispose()
return false, this method should be called
by developer when this instance is no longer needed.
removeNotify()
,
isAutoDispose()
public boolean isAutoDispose()
removeNotify()
is called. false if this instance
should be disposed by the developer directly calling
dispose()
when it is no longer needed.removeNotify()
,
addNotify()
,
dispose()
public void setBounds(int x, int y, int width, int height)
x
and y
, and the new size
is specified by width
and height
.
setBounds
in class java.awt.Component
x
- -
the new x-coordinate of this componenty
- -
the new y-coordinate of this componentwidth
- -
the new width of this componentheight
- -
the new height of this componentpublic void dispatchWebBrowserEvent(WebBrowserEvent e)
dispatchWebBrowserEvent
in interface IWebBrowser
public void addWebBrowserListener(WebBrowserListener listener)
WebBrowserEvent
listener to the listener list. If
listener is null, no exception is thrown and no action is performed.
addWebBrowserListener
in interface IWebBrowser
listener
- the WebBrowser event listener.public void removeWebBrowserListener(WebBrowserListener listener)
WebBrowserEvent
listener from the listener list.
If listener is null, no exception is thrown and no action is performed.
If the listener is not in the listener list, no listener is removed.
removeWebBrowserListener
in interface IWebBrowser
listener
- the WebBrowser event listener.public WebBrowserListener[] getWebBrowserListeners()
WebBrowserListener
s or an
empty array if no component listeners are currently registered.public java.net.URL getURL()
getURL
in interface IWebBrowser
null
if no URL is
currentlloadayed or the WebBrowser is not yet initialized.public void setURL()
setURL
in interface IWebBrowser
public void setURL(java.net.URL url)
setURL
in interface IWebBrowser
url
- the URL to navigate to.public void setURL(java.net.URL url, java.lang.String postData)
setURL
in interface IWebBrowser
url
- the URL to navigate to.postData
- the post data to send with the HTTP POST transaction. For
example, "username=myid&password=mypasswd"
public void setURL(java.net.URL url, java.lang.String postData, java.lang.String headers)
url
- the URL to navigate to.postData
- the post data to send with the HTTP POST transaction. For
example, "username=myid&password=mypasswd"
headers
- the HTTP headers to send with the HTTP POST transaction.public void syncSetURL(java.net.URL url) throws JdicInitException
url
- the URL to navigate to.
JdicInitException
public void syncSetURL(java.net.URL url, java.lang.String postData) throws JdicInitException
url
- the URL to navigate to.postData
- the post data to send with the HTTP POST transaction. For
example, "username=myid&password=mypasswd"
JdicInitException
public void syncSetURL(java.net.URL url, java.lang.String postData, java.lang.String headers) throws JdicInitException
url
- the URL to navigate to.postData
- the post data to send with the HTTP POST transaction. For
example, "username=myid&password=mypasswd"
headers
- the HTTP headers to send with the HTTP POST transaction.
JdicInitException
public void back()
back
in interface IWebBrowser
public void forward()
forward
in interface IWebBrowser
public void refresh()
refresh
in interface IWebBrowser
public void stop()
stop
in interface IWebBrowser
public void print()
This is a convenience method to use executeScript
to print
the currently loaded document:
WebBrowser webBrowser = new WebBrowser();
......
webBrowser.executeScript("window.print();");
executeScript(java.lang.String)
public void setContent(java.lang.String htmlContent)
setContent
in interface IWebBrowser
htmlContent
- the HTML content to set.public java.lang.String getContent()
getContent
in interface IWebBrowser
public java.lang.String executeScript(java.lang.String javaScript)
documentCompleted
event fired in WebBrowserListener
.
For example, execute JavaScript to show an alert dialog:
// Show a JavaScript alert dialog.
WebBrowser webBrowser = new WebBrowser();
webBrowser.executeScript("alert('Using executeScript')");
executeScript
in interface IWebBrowser
WebBrowserListener.documentCompleted(org.jdesktop.jdic.browser.WebBrowserEvent)
public static void setDebug(boolean b)
b
- if true, debug message output is enabled;
otherwise debug message output is disabled.
public static java.lang.String getBrowserBinary()
public boolean isInitialized()
WebBrowser
object is initialized
successfully.
isInitialized
in interface IWebBrowser
true
if the WebBrowser
object is
initialized successfully; otherwise, false
.public boolean isBackEnabled()
WebBrowser
object's back command is
enabled.
isBackEnabled
in interface IWebBrowser
true
if the WebBrowser can navigate to the
previous session history item, and false
otherwise.back()
public boolean isForwardEnabled()
WebBrowser
object's forward command is
enabled.
isForwardEnabled
in interface IWebBrowser
true
if the WebBrowser can navigate to the next
session history item, and false
otherwise.forward()
protected boolean willOpenURL(java.net.URL url)
A subclass can override this method to block the navigation or allow it to proceed.
url
- the URL to navigate to.
false
will block the navigation from starting;
true
otherwise. By default, it returns
true
.protected boolean willOpenWindow(java.net.URL url)
A subclass can override this method to block the creation of a new window or allow it to proceed.
url
- string value of url to be opened
false
will block the creation of a new window;
true
otherwise. By default, it returns
true
.public int getInstanceNum()
IWebBrowser
getInstanceNum
in interface IWebBrowser
public int getNativeWindow()
IWebBrowser
getNativeWindow
in interface IWebBrowser
public java.awt.Component asComponent()
IWebBrowser
asComponent
in interface IWebBrowser
public IBrowserEngine getBrowserEngine()
IWebBrowser
getBrowserEngine
in interface IWebBrowser
BrowserEngine
that was responsible for
creating this browser instance.public java.lang.String getInitFailureMessage()
getInitFailureMessage
in interface IWebBrowser
public boolean isSynchronize()
IWebBrowser
isSynchronize
in interface IWebBrowser
|
JDIC API V2006 Release 0308 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, working code examples, license terms and bug report information.
Copyright (c) 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.