org.pentaho.di.ui.spoon
Class SpoonBrowser

java.lang.Object
  extended by 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

Constructor Summary
SpoonBrowser(Composite parent, Spoon spoon, String stringUrl, boolean isURL)
           
SpoonBrowser(Composite parent, Spoon spoon, String stringUrl, boolean isURL, boolean showControls, LocationListener listener)
           
SpoonBrowser(Composite parent, Spoon spoon, String stringUrl, boolean isURL, LocationListener listener)
           
 
Method Summary
 void addLocationListener(LocationListener listener)
           
 boolean applyChanges()
           
 void browseBack()
           
 void browseForward()
           
 boolean canBeClosed()
          Closes the content behind the tab, de-allocates resources.
 boolean canHandleSave()
           
 Browser getBrowser()
           
 ChangedWarningInterface getChangedWarning()
           
 Composite getComposite()
           
 Object getData()
           
 Object getManagedObject()
           
 EngineMetaInterface getMeta()
           
 String getName()
           
 Shell getShell()
           
 Spoon getSpoon()
           
 org.pentaho.ui.xul.XulDomContainer getXulDomContainer()
           
 boolean hasContentChanged()
           
 void openFile()
           
 void setComposite(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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpoonBrowser

public SpoonBrowser(Composite parent,
                    Spoon spoon,
                    String stringUrl,
                    boolean isURL)
             throws SWTError
Throws:
SWTError

SpoonBrowser

public SpoonBrowser(Composite parent,
                    Spoon spoon,
                    String stringUrl,
                    boolean isURL,
                    LocationListener listener)
             throws SWTError
Throws:
SWTError

SpoonBrowser

public SpoonBrowser(Composite parent,
                    Spoon spoon,
                    String stringUrl,
                    boolean isURL,
                    boolean showControls,
                    LocationListener listener)
             throws SWTError
Throws:
SWTError
Method Detail

addLocationListener

public void addLocationListener(LocationListener listener)

openFile

public void openFile()

browseBack

public void browseBack()

browseForward

public void browseForward()

getBrowser

public Browser getBrowser()
Returns:
the browser

getShell

public 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 Composite getComposite()
Returns:
the composite

setComposite

public void setComposite(Composite composite)
Parameters:
composite - the composite to set

getMeta

public 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