org.eclipse.rse.core
Class SystemPropertyPageExtension

java.lang.Object
  org.eclipse.rse.core.SystemPropertyPageExtension

All Implemented Interfaces:

IObjectContributor, IPropertyPageContributor

public class SystemPropertyPageExtension

extends Object

implements IPropertyPageContributor

Represents a registered remote system property page. These are registered via our propertyPages extension point.

This class encapsulates all the information supplied by the extension xml.

1. id. Unique identifier
2. name. Displayable property page name
3. class. The class which implements IWorkbenchPropertyPage
4. subsystemconfigurationid. For scoping to remote objects for a given subsystem configuration
5. subsystemconfigurationCategory. For scoping to remote objects for a given subsystem configuration category
6. systemTypes. For scoping to remote objects from systems of a given type, or semicolon-separated types.
7. namefilter. For scoping to remote objects of a given name
8. typecategoryfilter. For scoping to remote objects for a given remote object type category
9. typefilter. For scoping to remote objects of a given type
10. subtypefilter. For scoping to remote objects of a given subtype
11. subsubtypefilter. For scoping to remote objects of a given sub-subtype

See Also:

ISystemRemoteElementAdapter

Constructor Summary

SystemPropertyPageExtension(IConfigurationElement element)
Constructor

Method Summary

boolean	appliesTo(ISystemRemoteElementAdapter adapter, Object element) Given an ISystemRemoteElement, return true if that element should show this property page.
boolean	canAdapt() see IObjectContributor#canAdapt()
boolean	contributePropertyPages(PropertyPageManager manager, Object object) Implement this method to add instances of PropertyPage class to the property page manager.
IWorkbenchPropertyPage	createPage(Object element) Creates the page based on the information in the configuration element.
protected Bundle	getBundle(IConfigurationElement element)
String	getCategoryFilter() Getter method.
String	getId() Getter method.
ImageDescriptor	getImage() Getter method.
String	getName() Getter method.
String	getNameFilter() Getter method.
protected ImageDescriptor	getPluginImage(IConfigurationElement element, String fileName) Retrieve image in given plugin's directory tree, given its file name.
IWorkbenchPropertyPage	getPropertyPage() Instantiate and return the class that implements IWorkbenchPropertyPage
String	getSubSubTypeFilter() Getter method.
String	getSubSystemConfigurationCategoryFilter() Getter method.
String	getSubSystemConfigurationId() Getter method.
String	getSubTypeFilter() Getter method.
String	getSystemTypesFilter() Getter method.
String	getTypeFilter() Getter method.
boolean	isApplicableTo(Object object) Returns true if this contributor should be considered for the given object.
boolean	isAtTop() Getter method.
void	setAtTop(boolean atTop) Set the at top attribute
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SystemPropertyPageExtension

public SystemPropertyPageExtension(IConfigurationElement element)

Constructor

Method Detail

getName

public String getName()

Getter method. Return what was specified for the name xml attribute.

getId

public String getId()

Getter method. Return what was specified for the id xml attribute.

getImage

public ImageDescriptor getImage()

Getter method. Return what was specified for the icon xml attribute.

isAtTop

public boolean isAtTop()

Getter method. Return what was last set via call to setAtTop(boolean)

setAtTop

public void setAtTop(boolean atTop)

Set the at top attribute

getCategoryFilter

public String getCategoryFilter()

Getter method. Return what was specified for the typecategoryfilter xml attribute.

getNameFilter

public String getNameFilter()

Getter method. Return what was specified for the namefilter xml attribute.

getTypeFilter

public String getTypeFilter()

Getter method. Return what was specified for the typefilter xml attribute.

getSubTypeFilter

public String getSubTypeFilter()

Getter method. Return what was specified for the subtypefilter xml attribute.

getSubSubTypeFilter

public String getSubSubTypeFilter()

Getter method. Return what was specified for the subsubtypefilter xml attribute.

getSubSystemConfigurationId

public String getSubSystemConfigurationId()

Getter method. Return what was specified for the subsystemconfigurationid xml attribute.

getSubSystemConfigurationCategoryFilter

public String getSubSystemConfigurationCategoryFilter()

Getter method. Return what was specified for the subsystemconfigurationCategory xml attribute.

getSystemTypesFilter

public String getSystemTypesFilter()

Getter method. Return what was specified for the systemTypes xml attribute.

getPluginImage

protected ImageDescriptor getPluginImage(IConfigurationElement element,
                                         String fileName)

Retrieve image in given plugin's directory tree, given its file name. The file name should be relatively qualified with the subdir containing it.

getBundle

protected Bundle getBundle(IConfigurationElement element)

appliesTo

public boolean appliesTo(ISystemRemoteElementAdapter adapter,
                         Object element)

Given an ISystemRemoteElement, return true if that element should show this property page. Looks at the filter criteria.

getPropertyPage

public IWorkbenchPropertyPage getPropertyPage()

Instantiate and return the class that implements IWorkbenchPropertyPage

toString

public String toString()

contributePropertyPages

public boolean contributePropertyPages(PropertyPageManager manager,
                                       Object object)

Implement this method to add instances of PropertyPage class to the property page manager.

Specified by:

contributePropertyPages in interface IPropertyPageContributor

Returns:

true if pages were added, false if not.

isApplicableTo

public boolean isApplicableTo(Object object)

Returns true if this contributor should be considered for the given object.

Specified by:

isApplicableTo in interface IObjectContributor

createPage

public IWorkbenchPropertyPage createPage(Object element)

Creates the page based on the information in the configuration element.

canAdapt

public boolean canAdapt()

see IObjectContributor#canAdapt()

Specified by:

canAdapt in interface IObjectContributor