Eclipse Plug-in Developer Guide (Galileo) - ForwardAction (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.views.framelist
Class ForwardAction


java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.jface.action.AbstractAction
          

org.eclipse.jface.action.Action
              

org.eclipse.ui.views.framelist.FrameAction
                  
org.eclipse.ui.views.framelist.ForwardAction

All Implemented Interfaces:: IAction

public class ForwardAction
extends FrameAction
extends FrameAction

Generic "Forward" action which goes forward one frame.

Field Summary

Fields inherited from interface org.eclipse.jface.action. IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT

Constructor Summary

ForwardAction ( FrameList frameList)
          Constructs a new action for the specified frame list.

Method Summary

void run ()
          Calls forward() on the frame list.

void update ()
          Updates this action's enabled state and tool tip text.

Methods inherited from class org.eclipse.ui.views.framelist. FrameAction

dispose, getFrameList, handlePropertyChange

Methods inherited from class org.eclipse.jface.action. Action

convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class org.eclipse.jface.action. AbstractAction

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

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.jface.action. IAction

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

ForwardAction

public ForwardAction(
FrameList frameList)

Constructs a new action for the specified frame list.

Parameters:: frameList - the frame list

Method Detail

run

public void run()

Calls forward() on the frame list.

Specified by:: run in interface IAction
Overrides:: run in class Action

update

public void update()

Updates this action's enabled state and tool tip text. This action is enabled only when there is a next frame in the frame list. The tool tip text is "Forward to " plus the tool tip text for the next frame.