at.spardat.xma.help
Class HelpView

java.lang.Object
  extended byat.spardat.xma.help.HelpView

public class HelpView
extends java.lang.Object

Instances of this class display the Help Files of a XMA - Component using the SWT browser widget.


Constructor Summary
HelpView()
          Constructor of HelpView.
HelpView(java.lang.String title, boolean showButtons, int width, int height)
          Creates a HelpView object with some customization.
HelpView(java.lang.String title, boolean showButtons, int width, int height, int style)
          Creates a HelpView object with some customization.
 
Method Summary
 boolean isActivated()
          Determine if the browser is activated.
 void Navigate(java.lang.String url)
          Navigates the browser to the given url.
 org.eclipse.swt.widgets.Shell open(org.eclipse.swt.widgets.Display display)
          Opens the browser to show the help page.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HelpView

public HelpView()
Constructor of HelpView. Initializes the resources.


HelpView

public HelpView(java.lang.String title,
                boolean showButtons,
                int width,
                int height)
Creates a HelpView object with some customization. Initializes the resources.

Parameters:
title - showed in titlebar of the browser window. If null the default title "XMA Help" is shown".
showButtons - if true the tool bar is visible
width - of the browser window. SWT.DEFAULT means the default width.
height - of the browser window. SWT.DEFAULT means the default height.

HelpView

public HelpView(java.lang.String title,
                boolean showButtons,
                int width,
                int height,
                int style)
Creates a HelpView object with some customization. Initializes the resources.

Parameters:
title - showed in titlebar of the browser window. If null the default title "XMA Help" is shown".
showButtons - if true the tool bar is visible
width - of the browser window. SWT.DEFAULT means the default width.
height - of the browser window. SWT.DEFAULT means the default height.
style - SWT-Style of the shell containing the browser.
Method Detail

open

public org.eclipse.swt.widgets.Shell open(org.eclipse.swt.widgets.Display display)
Opens the browser to show the help page.

Parameters:
display - the SWT-Display to use.
Returns:
the shell containing the browser window.

Navigate

public void Navigate(java.lang.String url)
Navigates the browser to the given url.

Parameters:
url - the url to show in the browser.

isActivated

public boolean isActivated()
Determine if the browser is activated.

Returns:
true if the brower is activated.