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.dialogs
Class PropertyDialogAction

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.SelectionProviderAction
                  extended by 
org.eclipse.ui.dialogs.PropertyDialogAction
All Implemented Interfaces:
IAction, ISelectionChangedListener

public class PropertyDialogAction
extends SelectionProviderAction

Standard action for opening a Property Pages Dialog on the currently selected element.

This class may be instantiated; it is not intended to be subclassed.

Generally speaking, this action is useful in pop-up menus because it allows the user to browse and change properties of selected elements. When performed, the action will bring up a Property Pages Dialog containing property pages registered with the workbench for elements of the selected type.

Although the action is capable of calculating if there are any applicable pages for the current selection, this calculation is costly because it require searching the workbench registry. Where performance is critical, the action can simply be added to the pop-up menu. In the event of no applicable pages, the action will just open an appropriate message dialog.

Restriction:
This class is not intended to be subclassed by clients.

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
PropertyDialogAction ( IShellProvider shell, ISelectionProvider provider)
          Creates a new action for opening a property dialog on the elements from the given selection provider.
PropertyDialogAction ( Shell shell, ISelectionProvider provider)
          Deprecated. use PropertyDialogAction(IShellProvider, ISelectionProvider)
 
Method Summary
  PreferenceDialog createDialog ()
          Create the dialog for the receiver.
 boolean isApplicableForSelection ()
          Returns whether this action is actually applicable to the current selection.
 boolean isApplicableForSelection ( IStructuredSelection selection)
          Returns whether this action is applicable to the current selection.
 void run ()
          The default implementation of this IAction method does nothing.
 void selectionChanged ( IStructuredSelection selection)
          Notifies this action that the given structured selection has changed in the selection provider.
 
Methods inherited from class org.eclipse.ui.actions. SelectionProviderAction
dispose, getSelection, getSelectionProvider, getStructuredSelection, selectionChanged, selectionChanged
 
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

PropertyDialogAction

public PropertyDialogAction(
Shell shell,
                            
ISelectionProvider provider)
Deprecated. use PropertyDialogAction(IShellProvider, ISelectionProvider)

Creates a new action for opening a property dialog on the elements from the given selection provider.

Parameters:
shell - the shell in which the dialog will open
provider - the selection provider whose elements the property dialog will describe

PropertyDialogAction

public PropertyDialogAction(
IShellProvider shell,
                            
ISelectionProvider provider)
Creates a new action for opening a property dialog on the elements from the given selection provider.

Parameters:
shell - provides the shell in which the dialog will open
provider - the selection provider whose elements the property dialog will describe
Since:
3.1
Method Detail

isApplicableForSelection

public boolean isApplicableForSelection()
Returns whether this action is actually applicable to the current selection. If this action is disabled, it will return false without further calculation. If it is enabled, it will check with the workbench's property page manager to see if there are any property pages registered for the selected element's type.

This method is generally too expensive to use when updating the enabled state of the action on each selection change.

Returns:
true if the selection is of size 1 and there are property pages for the selected element, and false otherwise

isApplicableForSelection

public boolean isApplicableForSelection(
IStructuredSelection selection)
Returns whether this action is applicable to the current selection. This checks that the selection is of size 1, and checks with the workbench's property page manager to see if there are any property pages registered for the selected element's type.

This method is generally too expensive to use when updating the enabled state of the action on each selection change.

Parameters:
selection - The selection to test
Returns:
true if the selection is of size 1 and there are property pages for the selected element, and false otherwise

run

public void run()
Description copied from class: Action
The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.

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

createDialog

public 
PreferenceDialog createDialog()
Create the dialog for the receiver. If no pages are found, an informative message dialog is presented instead.

Returns:
PreferenceDialog or null if no applicable pages are found.
Since:
3.1

selectionChanged

public void selectionChanged(
IStructuredSelection selection)
Description copied from class: SelectionProviderAction
Notifies this action that the given structured selection has changed in the selection provider.

The SelectionProviderAction implementation of this method does nothing. Subclasses may reimplement to react to this selection change.

Overrides:
selectionChanged in class SelectionProviderAction
Parameters:
selection - the new selection

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