Package org.eclipse.swt.browser
Class BrowserFunction
- java.lang.Object
-
- org.eclipse.swt.browser.BrowserFunction
-
public class BrowserFunction extends java.lang.Object
Instances of this class represent java-side "functions" that are invokable from javascript. Browser clients define these functions by subclassingBrowserFunction
and overriding itsfunction(Object[])
method. This method will be invoked whenever javascript running in the Browser makes a call with the function's name.Application code must explicitly invoke the
BrowserFunction.dispose()
method to release the resources managed by each instance when those instances are no longer required.Note that disposing a Browser automatically disposes all BrowserFunctions associated with it.
- Since:
- 1.3
- See Also:
dispose()
,function(Object[])
-
-
Constructor Summary
Constructors Constructor Description BrowserFunction(Browser browser, java.lang.String name)
Constructs a new instance of this class, which will be invokable by javascript running in the specified Browser.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
dispose()
Disposes of the resources associated with this BrowserFunction.java.lang.Object
function(java.lang.Object[] arguments)
Subclasses should override this method.Browser
getBrowser()
Returns the Browser whose pages can invoke this BrowserFunction.java.lang.String
getName()
Returns the name that javascript can use to invoke this BrowserFunction.boolean
isDisposed()
Returnstrue
if this BrowserFunction has been disposed andfalse
otherwise.
-
-
-
Constructor Detail
-
BrowserFunction
public BrowserFunction(Browser browser, java.lang.String name)
Constructs a new instance of this class, which will be invokable by javascript running in the specified Browser.You must dispose the BrowserFunction when it is no longer required.
- Parameters:
browser
- the browser whose javascript can invoke this functionname
- the name that javascript will use to invoke this function- Throws:
java.lang.IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the browser is null
- ERROR_NULL_ARGUMENT - if the name is null
SWTException
-- ERROR_WIDGET_DISPOSED - if the browser has been disposed
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
- See Also:
dispose()
-
-
Method Detail
-
dispose
public void dispose()
Disposes of the resources associated with this BrowserFunction. Applications must dispose of all BrowserFunctions that they create.Note that disposing a Browser automatically disposes all BrowserFunctions associated with it.
-
function
public java.lang.Object function(java.lang.Object[] arguments)
Subclasses should override this method. This method is invoked when the receiver's function is called from javascript. If all of the arguments that are passed to the javascript function call are of supported types then this method is invoked with the argument values converted as follows: javascript null or undefined ->null
javascript number ->java.lang.Double
javascript string ->java.lang.String
javascript boolean ->java.lang.Boolean
javascript array whose elements are all of supported types ->java.lang.Object[]
If any of the Javascript arguments are of unsupported types then the function invocation will fail and this method will not be called. This method must return a value with one of these supported types to the javascript caller (note that any subclass ofjava.lang.Number
will be successfully converted to a javascript number).- Parameters:
arguments
- the javascript arguments converted to java equivalents- Returns:
- the value to return to the javascript caller
- Throws:
SWTException
-- ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
- ERROR_FUNCTION_DISPOSED when the BrowserFunction has been disposed
-
getBrowser
public Browser getBrowser()
Returns the Browser whose pages can invoke this BrowserFunction.- Returns:
- the Browser associated with this BrowserFunction
- Throws:
SWTException
-- ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
- ERROR_FUNCTION_DISPOSED when the BrowserFunction has been disposed
-
getName
public java.lang.String getName()
Returns the name that javascript can use to invoke this BrowserFunction.- Returns:
- the BrowserFunction's name
- Throws:
SWTException
-- ERROR_THREAD_INVALID_ACCESS when called from the wrong thread
- ERROR_FUNCTION_DISPOSED when the BrowserFunction has been disposed
-
isDisposed
public boolean isDisposed()
Returnstrue
if this BrowserFunction has been disposed andfalse
otherwise.This method gets the dispose state for the BrowserFunction. When a BrowserFunction has been disposed it is an error to invoke any of its methods.
Note that disposing a Browser automatically disposes all BrowserFunctions associated with it.
- Returns:
true
if this BrowserFunction has been disposed andfalse
otherwise
-
-