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
Interface IWorkbenchPropertyPage

All Superinterfaces:
IDialogPage, IPreferencePage
All Known Implementing Classes:
PropertyPage, WizardPropertyPage

public interface IWorkbenchPropertyPage
extends IPreferencePage

Interface for workbench property pages. Property pages generally show up in the workbench's Property Pages dialog.

Clients should implement this interface and include the name of their class in an extension contributed to the workbench's property page extension point (named "org.eclipse.ui.propertyPages"). For example, the plug-in's XML markup might contain:

 <extension point="org.eclipse.ui.propertyPages">
      <page id="com.example.myplugin.props"
         name="Knobs"
         objectClass="org.eclipse.core.resources.IResource"
         class="com.example.myplugin.MyPropertyPage" />
 </extension>
 


Method Summary
  IAdaptable getElement ()
          Returns the object that owns the properties shown in this page.
 void setElement ( IAdaptable element)
          Sets the object that owns the properties shown in this page.
 
Methods inherited from interface org.eclipse.jface.preference. IPreferencePage
computeSize, isValid, okToLeave, performCancel, performOk, setContainer, setSize
 
Methods inherited from interface org.eclipse.jface.dialogs. IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
 

Method Detail

getElement

IAdaptable getElement()
Returns the object that owns the properties shown in this page.

Returns:
the object that owns the properties shown in this page

setElement

void setElement(
IAdaptable element)
Sets the object that owns the properties shown in this page. The page is expected to store this object and provide it if getElement is called.

As of Eclipse 3.2 the org.eclipse.ui.propertyPages extension point now supports non IAdaptable inputs. An input that is not an IAdaptable will be wrapped in an IAdaptable by the workbench before it is forwarded to this method.

Parameters:
element - the object that owns the properties shown in this page
See Also:
PropertyDialogAction

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