org.eclipse.eclipsemonkey.ui.scriptableView
Class BrowserView

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.ui.part.WorkbenchPart
          extended by org.eclipse.ui.part.ViewPart
              extended by org.eclipse.eclipsemonkey.ui.scriptableView.BrowserView
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation
Direct Known Subclasses:
GenericScriptableView

public abstract class BrowserView
extends org.eclipse.ui.part.ViewPart

Author:
Paul Colton (Aptana, Inc.)

Field Summary
protected  org.eclipse.jface.action.Action backAction
          backAction
static java.lang.String Browser_backwardButton_tooltip
          Browser_backwardButton_tooltip
static java.lang.String Browser_forwardButton_tooltip
          Browser_forwardButton_tooltip
static java.lang.String Browser_homeButton_tooltip
          Browser_homeButton_tooltip
static java.lang.String Browser_invalidConfig
          Browser_invalidConfig
protected  org.eclipse.jface.action.Action forwardAction
          forwardAction
protected  org.eclipse.eclipsemonkey.ui.scriptableView.BrowserView.History history
          history
protected  org.eclipse.jface.action.Action homeAction
          homeAction
protected  org.eclipse.eclipsemonkey.ui.scriptableView.BrowserView.BrowserIntroPartLocationListener urlListener
          urlListener
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
BrowserView()
          The constructor.
 
Method Summary
protected  void addToolBarActions()
          Pulled from BrowserIntroPartImplementation
 void createPartControl(org.eclipse.swt.widgets.Composite parent)
          This is a callback that will allow us to create the viewer and initialize it.
 org.eclipse.swt.browser.Browser getBrowser()
          Return a reference to the browser
abstract  java.lang.String getPartId()
          Returns the "part ID" which is used in the contexts.xml file
abstract  java.lang.String getStartUrl()
          Returns the startup URL (to display when this control initially loads
 void init(org.eclipse.ui.IViewSite site, org.eclipse.ui.IMemento memento)
           
 boolean navigateBackward()
          navigateBackward
 boolean navigateForward()
          navigateForward
 boolean navigateHome()
          navigateHome
 void saveState(org.eclipse.ui.IMemento memento)
           
 void sendMessage(java.lang.String url)
           
 void setFocus()
          Passing the focus request to the viewer's control.
 void updateHistory(java.lang.String location)
          Updates the UI navigation history with either a real URL.
protected  void updateNavigationActionsState()
          updateNavigationActionsState
 
Methods inherited from class org.eclipse.ui.part.ViewPart
checkSite, getViewSite, init, setContentDescription, setInitializationData, setPartName
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, dispose, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Field Detail

Browser_homeButton_tooltip

public static java.lang.String Browser_homeButton_tooltip
Browser_homeButton_tooltip


Browser_forwardButton_tooltip

public static java.lang.String Browser_forwardButton_tooltip
Browser_forwardButton_tooltip


Browser_backwardButton_tooltip

public static java.lang.String Browser_backwardButton_tooltip
Browser_backwardButton_tooltip


Browser_invalidConfig

public static java.lang.String Browser_invalidConfig
Browser_invalidConfig


urlListener

protected org.eclipse.eclipsemonkey.ui.scriptableView.BrowserView.BrowserIntroPartLocationListener urlListener
urlListener


history

protected org.eclipse.eclipsemonkey.ui.scriptableView.BrowserView.History history
history


backAction

protected org.eclipse.jface.action.Action backAction
backAction


forwardAction

protected org.eclipse.jface.action.Action forwardAction
forwardAction


homeAction

protected org.eclipse.jface.action.Action homeAction
homeAction

Constructor Detail

BrowserView

public BrowserView()
The constructor.

Method Detail

getStartUrl

public abstract java.lang.String getStartUrl()
Returns the startup URL (to display when this control initially loads

Returns:
String

getPartId

public abstract java.lang.String getPartId()
Returns the "part ID" which is used in the contexts.xml file

Returns:
String

init

public void init(org.eclipse.ui.IViewSite site,
                 org.eclipse.ui.IMemento memento)
          throws org.eclipse.ui.PartInitException
Specified by:
init in interface org.eclipse.ui.IViewPart
Overrides:
init in class org.eclipse.ui.part.ViewPart
Throws:
org.eclipse.ui.PartInitException
See Also:
IViewPart.init(org.eclipse.ui.IViewSite, org.eclipse.ui.IMemento)

saveState

public void saveState(org.eclipse.ui.IMemento memento)
Specified by:
saveState in interface org.eclipse.ui.IPersistable
Specified by:
saveState in interface org.eclipse.ui.IViewPart
Overrides:
saveState in class org.eclipse.ui.part.ViewPart
See Also:
IPersistable.saveState(org.eclipse.ui.IMemento)

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)
This is a callback that will allow us to create the viewer and initialize it.

Specified by:
createPartControl in interface org.eclipse.ui.IWorkbenchPart
Specified by:
createPartControl in class org.eclipse.ui.part.WorkbenchPart
Parameters:
parent -

addToolBarActions

protected void addToolBarActions()
Pulled from BrowserIntroPartImplementation


getBrowser

public org.eclipse.swt.browser.Browser getBrowser()
Return a reference to the browser

Returns:
Browser

setFocus

public void setFocus()
Passing the focus request to the viewer's control.

Specified by:
setFocus in interface org.eclipse.ui.IWorkbenchPart
Specified by:
setFocus in class org.eclipse.ui.part.WorkbenchPart

sendMessage

public void sendMessage(java.lang.String url)
Parameters:
url -

updateNavigationActionsState

protected void updateNavigationActionsState()
updateNavigationActionsState


navigateBackward

public boolean navigateBackward()
navigateBackward

Returns:
boolean

navigateForward

public boolean navigateForward()
navigateForward

Returns:
boolean

navigateHome

public boolean navigateHome()
navigateHome

Returns:
boolean

updateHistory

public void updateHistory(java.lang.String location)
Updates the UI navigation history with either a real URL.

Parameters:
location -