Eclipse RSE Development Guide (Galileo) - SystemRefreshAllAction (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.ui.actions
Class SystemRefreshAllAction


java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.jface.action.AbstractAction
          

org.eclipse.jface.action.Action
              

org.eclipse.rse.ui.actions.SystemBaseAction
                  
org.eclipse.rse.ui.actions.SystemRefreshAllAction

All Implemented Interfaces:: IAction, ISelectionChangedListener, ISystemAction

public class SystemRefreshAllAction
extends SystemBaseAction
extends SystemBaseAction

The action allows users to refresh the entire Remote System Explorer tree view

Field Summary

Fields inherited from class org.eclipse.rse.ui.actions. SystemBaseAction

allowOnMultipleSelection, arrowCursor, helpId, selectionSensitive, shell, sSelection, traceSelections, traceTarget, viewer, waitCursor

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

SystemRefreshAllAction ( Shell parent)
          Constructor for SystemRefreshAllAction

Method Summary

void run ()
          This is the method called when the user selects this action.

void setRootObject ( Object object)


boolean updateSelection ( IStructuredSelection selection)
          First opportunity to decide if the action should be enabled or not based on the current selection.

Methods inherited from class org.eclipse.rse.ui.actions. SystemBaseAction

allowOnMultipleSelection, checkObjectType, getContextMenuGroup, getCurrentTreeView, getFirstSelection, getHelpContextId, getNextSelection, getRemoteAdapter, getSelection, getSelectionProvider, getShell, getShell, getSystemConnection, getViewAdapter, getViewer, isDummy, isEnabled, isSelectionSensitive, issueTraceMessage, selectionChanged, setAvailableOffline, setBusyCursor, setContextMenuGroup, setDisplayCursor, setDisplayCursor, setHelp, setHost, setInputs, setSelection, setSelectionProvider, setSelectionSensitive, setShell, setTracing, setTracing, setViewer

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, 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, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isHandled, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Constructor Detail

SystemRefreshAllAction

public SystemRefreshAllAction(
Shell parent)

Constructor for SystemRefreshAllAction

Method Detail

setRootObject

public void setRootObject(
Object object)

updateSelection

public boolean updateSelection(
IStructuredSelection selection)

Description copied from class: SystemBaseAction

First opportunity to decide if the action should be enabled or not based on the current selection. Called by default implementation of selectionChanged, which converts the ISelection to an IStructuredSelection, which is all we support. The return result is used to enable or disable this action.

The default implementation of this method:

Returns false if calling checkObjectType on any object in the selection list returns false.
Returns true otherwise.

If desired, override this method for a different algorithm to decide enablement.

Overrides:: updateSelection in class SystemBaseAction

See Also:: SystemBaseAction.updateSelection(IStructuredSelection)

run

public void run()

This is the method called when the user selects this action.

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

See Also:: Action.run()