IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.rcp.workingarea.widgets
Class Browser

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Scrollable
              extended by org.eclipse.swt.widgets.Composite
                  extended by com.ibm.btt.rcp.workingarea.widgets.Browser
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable

public class Browser
extends org.eclipse.swt.widgets.Composite

BTT specified Browser, contains status bar, title bar, and web content access functions.


Field Summary
static int STATUSBAR
           
static int TOOLBAR
           
 
Fields inherited from class org.eclipse.swt.widgets.Control
handle
 
Constructor Summary
Browser(org.eclipse.swt.widgets.Composite parent, int style)
          Browser constructor
 
Method Summary
 void addCloseWindowListener(org.eclipse.swt.browser.CloseWindowListener listener)
           
 void addLocationListener(org.eclipse.swt.browser.LocationListener listener)
           
 void addOpenWindowListener(org.eclipse.swt.browser.OpenWindowListener listener)
           
 void addProgressListener(org.eclipse.swt.browser.ProgressListener listener)
           
 void addStatusTextListener(org.eclipse.swt.browser.StatusTextListener listener)
           
 void addTitleListener(org.eclipse.swt.browser.TitleListener listener)
           
 void addVisibilityWindowListener(org.eclipse.swt.browser.VisibilityWindowListener listener)
           
 void click(java.lang.String id)
          Invoke the click method for a button in browser by the id.
 void fireEvent(java.lang.String id, java.lang.String event)
          Fire a event for a element in browser by the id. the event name usually start with 'on'.
 void forceFocus(java.lang.String id)
          Invoke the focus method for a element in browser by the id.
 org.eclipse.swt.browser.Browser getBrowser()
          Get wrapped SWT browser widget
 java.util.Map<java.lang.String,java.lang.String> getDOM(java.lang.String id)
          Get a map which stands for the DOM object.
 java.lang.String getURL()
          Get the URL which the browser display in it.
 java.lang.String getValue(java.lang.String id)
          Get the value of an element with the specified ID.
 java.lang.String getValueByName(java.lang.String name, int index)
          Get a String array by the element name.
 java.lang.String[] getValuesByName(java.lang.String name)
          Get a String array by the element name.
 void invoke(java.lang.String id, java.lang.String method)
          Invoke a method for a element in browser by the id.
 boolean isEnabled()
           
 void removeCloseWindowListener(org.eclipse.swt.browser.CloseWindowListener listener)
           
 void removeLocationListener(org.eclipse.swt.browser.LocationListener listener)
           
 void removeOpenWindowListener(org.eclipse.swt.browser.OpenWindowListener listener)
           
 void removeProgressListener(org.eclipse.swt.browser.ProgressListener listener)
           
 void removeStatusTextListener(org.eclipse.swt.browser.StatusTextListener listener)
           
 void removeTitleListener(org.eclipse.swt.browser.TitleListener listener)
           
 void removeVisibilityWindowListener(org.eclipse.swt.browser.VisibilityWindowListener listener)
           
 void select(java.lang.String id)
          Invoke the select method for a element in browser by the id.
 void setEnabled(boolean enable)
           
 void setHTML(java.lang.String html)
          Set the HTML content of the browser widget.
 void setURL(java.lang.String url)
          Set the URL the browser will open to display in it.
 void setValue(java.lang.String id, java.lang.Object value)
          Set the value of the element with the specified ID
 
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, 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.Control
addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TOOLBAR

public static final int TOOLBAR
See Also:
Constant Field Values

STATUSBAR

public static final int STATUSBAR
See Also:
Constant Field Values
Constructor Detail

Browser

public Browser(org.eclipse.swt.widgets.Composite parent,
               int style)
Browser constructor

Parameters:
parent - parent composite
style - widget style
Method Detail

isEnabled

public boolean isEnabled()
Overrides:
isEnabled in class org.eclipse.swt.widgets.Control

setEnabled

public void setEnabled(boolean enable)
Overrides:
setEnabled in class org.eclipse.swt.widgets.Control

setURL

public void setURL(java.lang.String url)
Set the URL the browser will open to display in it.

Parameters:
url -

getURL

public java.lang.String getURL()
Get the URL which the browser display in it.

Returns:
url

setHTML

public void setHTML(java.lang.String html)
Set the HTML content of the browser widget.

Parameters:
html -

getValue

public java.lang.String getValue(java.lang.String id)
Get the value of an element with the specified ID. This function is the same with the document.getElementById(id) in JavaScript.

Parameters:
id -
Returns:

setValue

public void setValue(java.lang.String id,
                     java.lang.Object value)
Set the value of the element with the specified ID

Parameters:
id -
value -

getValueByName

public java.lang.String getValueByName(java.lang.String name,
                                       int index)
Get a String array by the element name. For a HTML document, more than one element can have the same name property. The index specified stands for which element's value will be returned;

Parameters:
name -
index -
Returns:

getValuesByName

public java.lang.String[] getValuesByName(java.lang.String name)
Get a String array by the element name. For a HTML document, more than one element can have the same name property.

Parameters:
name -
Returns:

getDOM

public java.util.Map<java.lang.String,java.lang.String> getDOM(java.lang.String id)
Get a map which stands for the DOM object.

Parameters:
id -
Returns:

click

public void click(java.lang.String id)
Invoke the click method for a button in browser by the id.

Parameters:
id -

forceFocus

public void forceFocus(java.lang.String id)
Invoke the focus method for a element in browser by the id.

Parameters:
id -

select

public void select(java.lang.String id)
Invoke the select method for a element in browser by the id.

Parameters:
id -

invoke

public void invoke(java.lang.String id,
                   java.lang.String method)
Invoke a method for a element in browser by the id.

Parameters:
id -
method -

fireEvent

public void fireEvent(java.lang.String id,
                      java.lang.String event)
Fire a event for a element in browser by the id. the event name usually start with 'on'. If the event fired, the listener function binded to the event will be run.

Parameters:
id -
method -

addProgressListener

public void addProgressListener(org.eclipse.swt.browser.ProgressListener listener)
Parameters:
listener -

removeProgressListener

public void removeProgressListener(org.eclipse.swt.browser.ProgressListener listener)
Parameters:
listener -

addOpenWindowListener

public void addOpenWindowListener(org.eclipse.swt.browser.OpenWindowListener listener)
Parameters:
listener -

removeOpenWindowListener

public void removeOpenWindowListener(org.eclipse.swt.browser.OpenWindowListener listener)
Parameters:
listener -

addStatusTextListener

public void addStatusTextListener(org.eclipse.swt.browser.StatusTextListener listener)
Parameters:
listener -

removeStatusTextListener

public void removeStatusTextListener(org.eclipse.swt.browser.StatusTextListener listener)
Parameters:
listener -

addCloseWindowListener

public void addCloseWindowListener(org.eclipse.swt.browser.CloseWindowListener listener)
Parameters:
listener -

removeCloseWindowListener

public void removeCloseWindowListener(org.eclipse.swt.browser.CloseWindowListener listener)
Parameters:
listener -

addLocationListener

public void addLocationListener(org.eclipse.swt.browser.LocationListener listener)
Parameters:
listener -

removeLocationListener

public void removeLocationListener(org.eclipse.swt.browser.LocationListener listener)
Parameters:
listener -

addVisibilityWindowListener

public void addVisibilityWindowListener(org.eclipse.swt.browser.VisibilityWindowListener listener)
Parameters:
listener -

removeVisibilityWindowListener

public void removeVisibilityWindowListener(org.eclipse.swt.browser.VisibilityWindowListener listener)
Parameters:
listener -

addTitleListener

public void addTitleListener(org.eclipse.swt.browser.TitleListener listener)
Parameters:
listener -

removeTitleListener

public void removeTitleListener(org.eclipse.swt.browser.TitleListener listener)
Parameters:
listener -

getBrowser

public org.eclipse.swt.browser.Browser getBrowser()
Get wrapped SWT browser widget

Returns:
SWT browser widget

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010