Package org.pentaho.di.ui.spoon

Class SpoonBrowser

java.lang.Object

org.pentaho.di.ui.spoon.SpoonBrowser

All Implemented Interfaces:

TabItemInterface, org.pentaho.ui.xul.impl.XulEventHandler

public class SpoonBrowser
extends Object
implements TabItemInterface, org.pentaho.ui.xul.impl.XulEventHandler

This class handles the display of help information like the welcome page and JDBC info in an embedded browser.

Since:

November 2006

Author:

Matt

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.swt.browser.Browser	browser
protected org.eclipse.swt.widgets.Composite	composite
protected org.eclipse.swt.widgets.Shell	shell
protected Spoon	spoon
protected org.pentaho.ui.xul.containers.XulToolbar	toolbar

Constructor Summary

Constructors

Constructor	Description
SpoonBrowser(org.eclipse.swt.widgets.Composite parent, Spoon spoon, String stringUrl, boolean isURL)
SpoonBrowser(org.eclipse.swt.widgets.Composite parent, Spoon spoon, String stringUrl, boolean isURL, boolean showControls, org.eclipse.swt.browser.LocationListener listener)
SpoonBrowser(org.eclipse.swt.widgets.Composite parent, Spoon spoon, String stringUrl, boolean isURL, org.eclipse.swt.browser.LocationListener listener)

Method Summary

Modifier and Type	Method	Description
void	addLocationListener(org.eclipse.swt.browser.LocationListener listener)
protected void	addToolBar()
boolean	applyChanges()
void	browseBack()
void	browseForward()
boolean	canBeClosed()	Closes the content behind the tab, de-allocates resources.
boolean	canHandleSave()
protected org.eclipse.swt.browser.Browser	createBrowser()
org.eclipse.swt.browser.Browser	getBrowser()
ChangedWarningInterface	getChangedWarning()
org.eclipse.swt.widgets.Composite	getComposite()
Object	getData()
Object	getManagedObject()
org.pentaho.di.core.EngineMetaInterface	getMeta()
String	getName()
org.eclipse.swt.widgets.Shell	getShell()
Spoon	getSpoon()
org.pentaho.ui.xul.XulDomContainer	getXulDomContainer()
boolean	hasContentChanged()
void	openFile()
void	setComposite(org.eclipse.swt.widgets.Composite composite)
void	setControlStates()
void	setData(Object data)
boolean	setFocus()
void	setName(String name)
void	setSpoon(Spoon spoon)
void	setXulDomContainer(org.pentaho.ui.xul.XulDomContainer xulDomContainer)
int	showChangedWarning()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

shell

protected org.eclipse.swt.widgets.Shell shell

spoon

protected Spoon spoon

composite

protected org.eclipse.swt.widgets.Composite composite

toolbar

protected org.pentaho.ui.xul.containers.XulToolbar toolbar

browser

protected org.eclipse.swt.browser.Browser browser

Constructor Detail

SpoonBrowser

public SpoonBrowser(org.eclipse.swt.widgets.Composite parent,
                    Spoon spoon,
                    String stringUrl,
                    boolean isURL)
             throws org.eclipse.swt.SWTError

Throws:

org.eclipse.swt.SWTError

SpoonBrowser

public SpoonBrowser(org.eclipse.swt.widgets.Composite parent,
                    Spoon spoon,
                    String stringUrl,
                    boolean isURL,
                    org.eclipse.swt.browser.LocationListener listener)
             throws org.eclipse.swt.SWTError

Throws:

org.eclipse.swt.SWTError

SpoonBrowser

public SpoonBrowser(org.eclipse.swt.widgets.Composite parent,
                    Spoon spoon,
                    String stringUrl,
                    boolean isURL,
                    boolean showControls,
                    org.eclipse.swt.browser.LocationListener listener)
             throws org.eclipse.swt.SWTError

Throws:

org.eclipse.swt.SWTError

Method Detail

createBrowser

protected org.eclipse.swt.browser.Browser createBrowser()

addLocationListener

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

addToolBar

protected void addToolBar()

openFile

public void openFile()

browseBack

public void browseBack()

browseForward

public void browseForward()

getBrowser

public org.eclipse.swt.browser.Browser getBrowser()

Returns:

the browser

getShell

public org.eclipse.swt.widgets.Shell getShell()

Returns:

the shell

getSpoon

public Spoon getSpoon()

Returns:

the spoon

setSpoon

public void setSpoon(Spoon spoon)

Parameters:

spoon - the spoon to set

applyChanges

public boolean applyChanges()

Specified by:

applyChanges in interface TabItemInterface

canBeClosed

public boolean canBeClosed()

Description copied from interface: TabItemInterface

Closes the content behind the tab, de-allocates resources.

Specified by:

canBeClosed in interface TabItemInterface

Returns:

true if the tab was closed, false if it was prevented by the user. (are you sure dialog)

getManagedObject

public Object getManagedObject()

Specified by:

getManagedObject in interface TabItemInterface

hasContentChanged

public boolean hasContentChanged()

Specified by:

hasContentChanged in interface TabItemInterface

showChangedWarning

public int showChangedWarning()

Specified by:

showChangedWarning in interface TabItemInterface

getComposite

public org.eclipse.swt.widgets.Composite getComposite()

Returns:

the composite

setComposite

public void setComposite(org.eclipse.swt.widgets.Composite composite)

Parameters:

composite - the composite to set

getMeta

public org.pentaho.di.core.EngineMetaInterface getMeta()

Specified by:

getMeta in interface TabItemInterface

canHandleSave

public boolean canHandleSave()

Specified by:

canHandleSave in interface TabItemInterface

setFocus

public boolean setFocus()

Specified by:

setFocus in interface TabItemInterface

getData

public Object getData()

Specified by:

getData in interface org.pentaho.ui.xul.impl.XulEventHandler

getName

public String getName()

Specified by:

getName in interface org.pentaho.ui.xul.impl.XulEventHandler

getXulDomContainer

public org.pentaho.ui.xul.XulDomContainer getXulDomContainer()

Specified by:

getXulDomContainer in interface org.pentaho.ui.xul.impl.XulEventHandler

setData

public void setData(Object data)

Specified by:

setData in interface org.pentaho.ui.xul.impl.XulEventHandler

setName

public void setName(String name)

Specified by:

setName in interface org.pentaho.ui.xul.impl.XulEventHandler

setXulDomContainer

public void setXulDomContainer(org.pentaho.ui.xul.XulDomContainer xulDomContainer)

Specified by:

setXulDomContainer in interface org.pentaho.ui.xul.impl.XulEventHandler

setControlStates

public void setControlStates()

Specified by:

setControlStates in interface TabItemInterface

getChangedWarning

public ChangedWarningInterface getChangedWarning()

Specified by:

getChangedWarning in interface TabItemInterface