Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.actions
Class SelectionListenerAction

java.lang.Object
  extended by 

org.eclipse.core.commands.common.EventManager
      extended by 

org.eclipse.jface.action.AbstractAction
          extended by 

org.eclipse.jface.action.Action
              extended by 

org.eclipse.ui.actions.BaseSelectionListenerAction
                  extended by 
org.eclipse.ui.actions.SelectionListenerAction
All Implemented Interfaces:
IAction, ISelectionChangedListener
Direct Known Subclasses:
AddBookmarkAction, AddTaskAction, CopyProjectAction, CopyResourceAction, CreateFileAction, CreateFolderAction, DeleteResourceAction, OpenSystemEditorAction, WorkspaceAction

public abstract class SelectionListenerAction
extends BaseSelectionListenerAction

The abstract superclass for resource-based actions that listen to selection change events. This implementation tracks the current selection (see getStructuredSelection) and provides a convenient place to monitor selection changes that could affect the availability of the action.

Subclasses must implement the following IAction method:

  • run - to do the action's work

Subclasses may extend the updateSelection method to update the action determine its availability based on the current selection.

The object instantiating the subclass is responsible for registering the instance with a selection provider. Alternatively, the object can notify the subclass instance directly of a selection change using the methods:

  • selectionChanged(IStructuredSelection) - passing the selection
  • selectionChanged(ISelectionChangedEvent) - passing the selection change event


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
protected SelectionListenerAction ( String text)
          Creates a new action with the given text.
 
Method Summary
protected  void clearCache ()
          The SelectionListenerAction implementation of this BaseSelectionListenerAction method clears the cached resources and non-resources.
protected   List getSelectedNonResources ()
          Returns the elements in the current selection that are not IResources.
protected   List getSelectedResources ()
          Returns the elements in the current selection that are IResources.
protected  boolean resourceIsType ( IResource resource, int resourceMask)
          Returns whether the type of the given resource is among those in the given resource type mask.
protected  boolean selectionIsOfType (int resourceMask)
          Returns whether the current selection consists entirely of resources whose types are among those in the given resource type mask.
 
Methods inherited from class org.eclipse.ui.actions. BaseSelectionListenerAction
getStructuredSelection, runWithEvent, selectionChanged, selectionChanged, updateSelection
 
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, run, 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

SelectionListenerAction

protected SelectionListenerAction(
String text)
Creates a new action with the given text.

Parameters:
text - the string used as the text for the action, or null if there is no text
Method Detail

clearCache

protected void clearCache()
The SelectionListenerAction implementation of this BaseSelectionListenerAction method clears the cached resources and non-resources.

Overrides:
clearCache in class BaseSelectionListenerAction

getSelectedNonResources

protected 
List getSelectedNonResources()
Returns the elements in the current selection that are not IResources.

Returns:
list of elements (element type: Object)

getSelectedResources

protected 
List getSelectedResources()
Returns the elements in the current selection that are IResources.

Returns:
list of resource elements (element type: IResource)

resourceIsType

protected boolean resourceIsType(
IResource resource,
                                 int resourceMask)
Returns whether the type of the given resource is among those in the given resource type mask.

Parameters:
resource - the resource
resourceMask - a bitwise OR of resource types: IResource.{FILE, FOLDER, PROJECT, ROOT}
Returns:
true if the resource type matches, and false otherwise
See Also:
IResource

selectionIsOfType

protected boolean selectionIsOfType(int resourceMask)
Returns whether the current selection consists entirely of resources whose types are among those in the given resource type mask.

Parameters:
resourceMask - a bitwise OR of resource types: IResource.{FILE, FOLDER, PROJECT, ROOT}
Returns:
true if all resources in the current selection are of the specified types or if the current selection is empty, and false if some elements are resources of a different type or not resources
See Also:
IResource

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire