|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.swt.widgets.Widget org.eclipse.swt.widgets.Control org.eclipse.swt.widgets.Scrollable org.eclipse.swt.widgets.Composite org.eclipse.swt.browser.Browser
public class Browser
Instances of this class implement the browser user interface metaphor. It allows the user to visualize and navigate through HTML documents.
Note that although this class is a subclass of Composite
,
it does not make sense to set a layout on it.
IMPORTANT: This class is not intended to be subclassed.
Currently implemented
The enabled property in not (yet) evaluated.
Focus events are not yet implemented
Constructor Summary | |
---|---|
Browser(Composite parent,
int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. |
Method Summary | ||
---|---|---|
void |
addLocationListener(LocationListener listener)
Adds the listener to the collection of listeners who will be notified when the current location has changed or is about to change. |
|
void |
addProgressListener(ProgressListener listener)
Adds the listener to the collection of listeners who will be notified when a progress is made during the loading of the current URL or when the loading of the current URL has been completed. |
|
protected void |
checkWidget()
Throws an SWTException if the receiver can not
be accessed by the caller. |
|
java.lang.Object |
evaluate(java.lang.String script)
Returns the result, if any, of executing the specified script. |
|
boolean |
execute(java.lang.String script)
Execute the specified script. |
|
|
getAdapter(java.lang.Class<T> adapter)
Implementation of the Adaptable interface. |
|
java.lang.String |
getUrl()
Returns the current URL. |
|
java.lang.Object |
getWebBrowser()
Returns the JavaXPCOM nsIWebBrowser for the receiver, or null
if it is not available. |
|
void |
removeLocationListener(LocationListener listener)
Removes the listener from the collection of listeners who will be notified when the current location is changed or about to be changed. |
|
void |
removeProgressListener(ProgressListener listener)
Removes the listener from the collection of listeners who will be notified when a progress is made during the loading of the current URL or when the loading of the current URL has been completed. |
|
boolean |
setText(java.lang.String html)
Renders HTML. |
|
boolean |
setUrl(java.lang.String url)
Loads a URL. |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
changed, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
---|
computeTrim, getClientArea, getHorizontalBar, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkSubclass, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Browser(Composite parent, int style)
The style value is either one of the style constants defined in
class SWT
which is applicable to instances of this
class, or must be built by bitwise OR'ing together
(that is, using the int
"|" operator) two or more
of those SWT
style constants. The class description
lists the style constants that are applicable to the class.
Style bits are also inherited from superclasses.
parent
- a widget which will be the parent of the new instance (cannot be null)style
- the style of widget to construct
java.lang.IllegalArgumentException
- SWTException
- SWTError
- Widget.getStyle()
Method Detail |
---|
public boolean setUrl(java.lang.String url)
url
- the URL to be loaded
java.lang.IllegalArgumentException
- SWTException
- getUrl()
public java.lang.String getUrl()
String
if there is no current URL
SWTException
- setUrl(java.lang.String)
public boolean setText(java.lang.String html)
The html parameter is Unicode encoded since it is a java String
.
As a result, the HTML meta tag charset should not be set. The charset is implied
by the String
itself.
html
- the HTML content to be rendered
java.lang.IllegalArgumentException
- SWTException
- setUrl(java.lang.String)
public boolean execute(java.lang.String script)
Execute a script containing javascript commands in the context of the current document.
Note: Care should be taken when using this method.
The given script
is executed in an IFRAME
inside the document that represents the client-side application.
Since the execution context of an IFRAME
is not fully
isolated from the surrounding document it may break the client-side
application.
This method is not supported when running the application in JEE_COMPATIBILITY mode. Use BrowserUtil#evaluate instead.
script
- the script with javascript commands
true
if the operation was successful and
false
otherwise
java.lang.IllegalArgumentException
- SWTException
- java.lang.UnsupportedOperationException
- when running the application in JEE_COMPATIBILITY modeApplication.OperationMode
public java.lang.Object evaluate(java.lang.String script) throws SWTException
Evaluates a script containing javascript commands in the context of
the current document. If document-defined functions or properties
are accessed by the script then this method should not be invoked
until the document has finished loading (ProgressListener.completed()
gives notification of this).
If the script returns a value with a supported type then a java representation of the value is returned. The supported javascript -> java mappings are:
null
java.lang.Double
java.lang.String
java.lang.Boolean
java.lang.Object[]
SWTException
is thrown if the return value has an
unsupported type, or if evaluating the script causes a javascript
error to be thrown.
Note: Care should be taken when using this method.
The given script
is executed in an IFRAME
inside the document that represents the client-side application.
Since the execution context of an IFRAME
is not fully
isolated from the surrounding document it may break the client-side
application.
This method is not supported when running the application in JEE_COMPATIBILITY mode. Use BrowserUtil#evaluate instead.
script
- the script with javascript commands
java.lang.IllegalArgumentException
- SWTException
- java.lang.UnsupportedOperationException
- when running the application in JEE_COMPATIBILITY modeProgressListener.completed(ProgressEvent)
,
Application.OperationMode
public void addLocationListener(LocationListener listener)
This notification typically occurs when the application navigates
to a new location with setUrl(String)
or when the user
activates a hyperlink.
listener
- the listener which should be notified
java.lang.IllegalArgumentException
- SWTException
- public void removeLocationListener(LocationListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- public void addProgressListener(ProgressListener listener)
listener
- the listener which should be notified
java.lang.IllegalArgumentException
- SWTException
- public void removeProgressListener(ProgressListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- public <T> T getAdapter(java.lang.Class<T> adapter)
Widget
Adaptable
interface.
IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code.
getAdapter
in interface Adaptable
getAdapter
in class Composite
adapter
- the lookup class
null
if
there is no adapter associated with the given class.public java.lang.Object getWebBrowser()
nsIWebBrowser
for the receiver, or null
if it is not available. In order for an nsIWebBrowser
to be returned all
of the following must be true: SWT.MOZILLA
nsIWebBrowser
or null
protected void checkWidget()
Widget
SWTException
if the receiver can not
be accessed by the caller. This may include both checks on
the state of the receiver and more generally on the entire
execution context. This method should be called by
widget implementors to enforce the standard SWT invariants.
Currently, it is an error to invoke any method (other than
isDisposed()
) on a widget that has had its
dispose()
method called. It is also an error
to call widget methods from any thread that is different
from the thread that created the widget.
In future releases of SWT, there may be more or fewer error checks and exceptions may be thrown for different reasons.
checkWidget
in class Widget
|
Eclipse Remote Application Platform | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) EclipseSource and others 2002, 2012. All rights reserved.