|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.action.Action
org.eclipse.ui.actions.BaseSelectionListenerAction
org.eclipse.ui.actions.SelectionListenerAction
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 selectionselectionChanged(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 IResource s. |
protected List |
getSelectedResources()
Returns the elements in the current selection that are IResource s. |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected SelectionListenerAction(String text)
text
- the string used as the text for the action,
or null
if there is no textMethod Detail |
protected void clearCache()
SelectionListenerAction
implementation of this
BaseSelectionListenerAction
method clears the cached
resources and non-resources.
clearCache
in class BaseSelectionListenerAction
protected List getSelectedNonResources()
IResource
s.
Object
)protected List getSelectedResources()
IResource
s.
IResource
)protected boolean resourceIsType(IResource resource, int resourceMask)
resource
- the resourceresourceMask
- a bitwise OR of resource types:
IResource
.{FILE
, FOLDER
,
PROJECT
, ROOT
}
true
if the resource type matches, and false
otherwiseIResource
protected boolean selectionIsOfType(int resourceMask)
resourceMask
- a bitwise OR of resource types:
IResource
.{FILE
, FOLDER
,
PROJECT
, ROOT
}
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 resourcesIResource
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.