|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.model.WorkbenchAdapter
org.eclipse.rse.ui.RSEAdapter
org.eclipse.rse.ui.RSESystemTypeAdapter
public class RSESystemTypeAdapter
Adapter for RSE system types.
Field Summary |
---|
Fields inherited from class org.eclipse.ui.model.WorkbenchAdapter |
---|
NO_CHILDREN |
Constructor Summary | |
---|---|
RSESystemTypeAdapter()
|
Method Summary | |
---|---|
boolean |
acceptWizardDescriptor(String wizardConfigurationElementName,
org.eclipse.rse.ui.wizards.registries.IRSEWizardDescriptor descriptor)
Checks if the given wizard descriptor is accepted for the system types the adapter is covering. |
void |
addCustomMenuGroups(IMenuManager menu)
Called from SystemView.createStandardGroups(IMenuManager) to allow dynamic system
type providers to customize the RSE standard menu structure regarding their needs. |
void |
addCustomToolbarGroups(IViewPart view)
Called from SystemViewPart#fillLocalToolBar(boolean) to allow dynamic system
type providers to customize the RSE standard toolbar structure regarding their needs. |
String |
getDefaultUserId(Object object)
Return the default user id for a particular system type. |
String |
getDescription(Object object)
Returns the description of the system type if the object passed in is of type IRSESystemType . |
static ImageDescriptor |
getImage(String value,
Bundle definingBundle)
Create a descriptor from the argument absolute or relative path to an image file. bundle parameter is used as the base for relative paths and is allowed to be null. |
ImageDescriptor |
getImageDescriptor(Object object)
Returns the image descriptor for the icon of this system type. |
String |
getLabel(Object object)
Returns the name of the system type if the object passed in is of type IRSESystemType . |
ImageDescriptor |
getLiveImageDescriptor(Object object)
Returns the "live" image descriptor for this system type. |
static URL |
getUrl(String value,
Bundle definingBundle)
Create a URL from the argument absolute or relative path. |
boolean |
isEnabled(Object object)
Deprecated. Clients should use IRSESystemType.isEnabled() , which is
available without UI dependencies, in order to guarantee consistent
availability of system types.
Providers of custom RSESystemTypeAdapter implementations, which override
this method, should move their code to their IRSESystemType implementations.
See https://bugs.eclipse.org/bugs/show_bug.cgi?id=218655#c1 for details. |
boolean |
isEnableOffline(Object object)
|
void |
setDefaultUserId(Object object,
String defaultUserId)
Deprecated. Use RSEPreferencesManager.setDefaultUserId(IRSESystemType, String) |
void |
setIsEnabled(Object object,
boolean isEnabled)
Deprecated. Use RSEPreferencesManager.setIsSystemTypeEnabled(IRSESystemType, boolean) |
Methods inherited from class org.eclipse.ui.model.WorkbenchAdapter |
---|
getBackground, getChildren, getFont, getForeground, getParent, getStyledText |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.ui.model.IWorkbenchAdapter |
---|
getChildren, getParent |
Methods inherited from interface org.eclipse.ui.model.IWorkbenchAdapter2 |
---|
getBackground, getFont, getForeground |
Constructor Detail |
---|
public RSESystemTypeAdapter()
Method Detail |
---|
public ImageDescriptor getImageDescriptor(Object object)
getImageDescriptor
in interface IWorkbenchAdapter
getImageDescriptor
in class WorkbenchAdapter
WorkbenchAdapter.getImageDescriptor(java.lang.Object)
public ImageDescriptor getLiveImageDescriptor(Object object)
object
- The object to get an image descriptor for.
public static ImageDescriptor getImage(String value, Bundle definingBundle)
value
- the absolute or relative pathdefiningBundle
- bundle to be used for relative paths (may be null)
public static URL getUrl(String value, Bundle definingBundle)
value
- the absolute or relative pathdefiningBundle
- bundle to be used for relative paths (may be null)
public String getLabel(Object object)
IRSESystemType
. Otherwise, returns the value of the parent implementation.
getLabel
in interface IWorkbenchAdapter
getLabel
in class WorkbenchAdapter
WorkbenchAdapter.getLabel(java.lang.Object)
public String getDescription(Object object)
IRSESystemType
.
Otherwise, returns the value of the parent implementation.
getDescription
in interface IRSEAdapter
getDescription
in class RSEAdapter
object
- the object to get the description text for
RSEAdapter.getDescription(java.lang.Object)
public boolean isEnableOffline(Object object)
public final boolean isEnabled(Object object)
IRSESystemType.isEnabled()
, which is
available without UI dependencies, in order to guarantee consistent
availability of system types.
Providers of custom RSESystemTypeAdapter implementations, which override
this method, should move their code to their IRSESystemType implementations.
See https://bugs.eclipse.org/bugs/show_bug.cgi?id=218655#c1 for details.
object
- the object being adapted, usually a system type.
public void setIsEnabled(Object object, boolean isEnabled)
RSEPreferencesManager.setIsSystemTypeEnabled(IRSESystemType, boolean)
Note that system types which are provided by extenders via the dynamic sytemTypeProviders extension point may have their own logic to determine whether they are enabled or not, so changing the enabled setting may not work for them.
object
- The system type being adapted.isEnabled
- true if the system type is enabled. false if it is not.public String getDefaultUserId(Object object)
object
- The system type being adapted.
public void setDefaultUserId(Object object, String defaultUserId)
RSEPreferencesManager.setDefaultUserId(IRSESystemType, String)
object
- the system type that we are adaptingdefaultUserId
- the id to set for this system typepublic void addCustomToolbarGroups(IViewPart view)
SystemViewPart#fillLocalToolBar(boolean)
to allow dynamic system
type providers to customize the RSE standard toolbar structure regarding their needs.
Note: This method is called for each system type. If a single system type adapter is associated with multiple system types, this method is called multiple times. Overriders must check if the required groups are added to the toolbar already and must avoid to add them multiple times!
view
- The view to customize. Must be not null
.public void addCustomMenuGroups(IMenuManager menu)
SystemView.createStandardGroups(IMenuManager)
to allow dynamic system
type providers to customize the RSE standard menu structure regarding their needs.
Note: This method is called for each system type. If a single system type adapter is associated with multiple system types, this method is called multiple times. Overriders must check if the required groups are added to the menu already and must avoid to add them multiple times!
menu
- The menu manager. Must be not null
.public boolean acceptWizardDescriptor(String wizardConfigurationElementName, org.eclipse.rse.ui.wizards.registries.IRSEWizardDescriptor descriptor)
wizardConfigurationElementName
- The wizard configuration element name. Must be not null
.descriptor
- The wizard descriptor. Must be not null
.
True
is accepted, false
otherwise.
|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |