org.eclipse.rse.ui.view
Class AbstractSystemViewAdapter

java.lang.Object
  
org.eclipse.rse.ui.view.AbstractSystemViewAdapter

All Implemented Interfaces:

IRemoteObjectIdentifier, ISystemDragDropAdapter, ISystemViewElementAdapter, IActionFilter, IWorkbenchAdapter, IDeferredWorkbenchAdapter, IPropertySource

Direct Known Subclasses:

SystemViewRemoteOutputAdapter

public abstract class AbstractSystemViewAdapter
extends 
Object
implements 
ISystemViewElementAdapter, 
IWorkbenchAdapter, 
IDeferredWorkbenchAdapter

Base class for adapters needed for the SystemView viewer. It implements the ISystemViewElementAdapter interface.

See Also:

AbstractSystemRemoteAdapterFactory

Field Summary
protected   Object[]	_lastResults           A variable that can be used in getChildren to cache last returned results, if desired
protected   Object	_lastSelected           A variable that can be used to cache last selection, if desired
protected   SystemMessageObject	cancelledObject           Deprecated. Use getCancelledMessageObject() instead.
protected static  String[]	EMPTY_STRING_LIST           A handy constant of "new String[0]"
protected   Object[]	emptyList           Deprecated. Do not use directly. Use checkForEmptyList(Object[], Object, boolean) when needed.
protected   SystemMessageObject	errorObject           Deprecated. Use getFailedMessageObject() instead.
static  String	MEMENTO_DELIM           Delimiter for each object's key in a memento, used to persist tree view expansion state: "///"
protected static  String	MSG_SUB_PREFIX           Deprecated. use Eclipse NLS or Java Messageformat for String substitution.
protected static  String	MSG_SUB1           Deprecated. use Eclipse NLS or Java Messageformat for String substitution.
protected static  String	MSG_SUB2           Deprecated. use Eclipse NLS or Java Messageformat for String substitution.
protected   Object[]	msgList           Deprecated. Do not use directly. Use getCancelledMessageObject() or getFailedMessageObject() or checkForEmptyList(Object[], Object, boolean) when needed.
protected   SystemMessageObject	nullObject           Deprecated. Use checkForEmptyList(Object[], Object, boolean) instead.
protected   Object	propertySourceInput           Current input provider.
protected   Shell	shell           Deprecated. Use getShell() and setShell(Shell)
protected   Viewer	viewer           Deprecated. use getViewer() and setViewer(Viewer)

 

Fields inherited from interface org.eclipse.rse.ui.view. ISystemViewElementAdapter
noActions

 

Constructor Summary
AbstractSystemViewAdapter ()

 

Method Summary
abstract  void	addActions ( SystemMenuManager menu, IStructuredSelection selection, Shell parent, String menuGroup)           This is your opportunity to add actions to the popup menu for the given selection.
void	addCommonRemoteActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup)           Returns any framework-supplied remote object actions that should be contributed to the popup menu for the given selection list.
void	addDynamicPopupMenuActions ( SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup)           Add or remove custom actions dynamically to a context menu.
boolean	canDelete ( Object element)           Return true if this object is deletable by the user.
boolean	canDrag ( Object element)           Return true if this object can be copied to another location.
boolean	canDrag ( SystemRemoteResourceSet elements)           Return true if this object can be copied to another location.
boolean	canDrop ( Object element)           Return true if another object can be copied into this object.
boolean	canEdit ( Object object)           Indicates whether the specified object can be edited or not.
boolean	canRename ( Object element)           Return true if this object is renameable by the user.
protected   Object[]	checkForEmptyList ( Object[] children, Object parent, boolean returnNullMsg)           In getChildren, return checkForEmptyList(children, parent, true/false)<.samp> versus your array directly.
protected   Object[]	checkForNull ( Object[] children, boolean returnNullMsg)           Deprecated. Use checkForEmptyList(Object[], Object, boolean) instead.
protected static  PropertyDescriptor	createSimplePropertyDescriptor ( String propertyKey, String label, String description)           Create and return a simple string read-only property descriptor.
boolean	doDelete ( Shell shell, Object element, IProgressMonitor monitor)           Perform the delete action on single item. By default does nothing.
boolean	doDeleteBatch ( Shell shell, List resourceSet, IProgressMonitor monitor)           Perform the delete on the given set of items. By default just calls the doDelete method for each item in the resourceSet.
Object	doDrag ( Object element, boolean sameSystemType, IProgressMonitor monitor)           Perform the drag on the given object.
ISystemResourceSet	doDrag ( SystemRemoteResourceSet set, IProgressMonitor monitor)           Perform the drag on the given objects.
ISystemResourceSet	doDrop ( ISystemResourceSet fromSet, Object to, boolean sameSystemType, boolean sameSystem, int srcType, IProgressMonitor monitor)           Perform drop from the "fromSet" of objects to the "to" object.
Object	doDrop ( Object from, Object to, boolean sameSystemType, boolean sameSystem, int srcType, IProgressMonitor monitor)           Perform drop from the "from" object to the "to" object.
Object	doDrop ( Object from, Object to, boolean sameSystemType, boolean sameSystem, IProgressMonitor monitor)           Deprecated. use doDrop(Object from, Object to, boolean sameSystemType, boolean sameSystem, int srcType, IProgressMonitor monitor) instead
boolean	doRename ( Shell shell, Object element, String name, IProgressMonitor monitor)           Perform the rename action.
boolean	exists ( Object element)           {inheritDoc} By default, this method returns true - override this method to customize the behavior.
void	fetchDeferredChildren ( Object o, IElementCollector collector, IProgressMonitor monitor)
String	getAlternateText ( Object element)           Return the alternate label for this object.
protected   Object[]	getCancelledMessageObject ()           Return the "Operation cancelled by user" message as an object array so can be used to answer getChildren().
String	getCanonicalNewName ( Object element, String newName)           Form and return a new canonical (unique) name for this object, given a candidate for the new name.
abstract   Object[]	getChildren ( IAdaptable element, IProgressMonitor monitor)           Return the children of this model object. This should be overridden by subclasses in order to provide deferred query support via the Eclipse Jobs mechanism.
Object[]	getChildren ( IContextObject element, IProgressMonitor monitor)           Return the children of this object. This should be overridden by subclasses in order to provide deferred query support via the Eclipse Jobs mechanism, if your adapter supports context objects.
Object[]	getChildren ( Object object)            Rather than overriding this, adapter implementors should override the getChildren() methods that take a progress monitor.
Object[]	getChildrenUsingExpandToFilter ( Object element, String expandToFilter)           Return the children of this object, using the given Expand-To filter.
protected   ISystemTree	getCurrentTreeView ()           Return the current viewer as an ISystemTree if it is one, or null otherwise.
protected static  IPropertyDescriptor[]	getDefaultDescriptors ()           Return the default descriptors for all system elements.
ISystemEditableRemoteObject	getEditableRemoteObject ( Object object)           Return the remote edit wrapper for this object.
Object	getEditableValue ()           Returns a value for this object that can be edited in a property sheet.
protected   Object[]	getEmptyMessageObject ()           Deprecated. Use checkForEmptyList(Object[], Object, boolean) instead.
protected   Object[]	getFailedMessageObject ()           Return the "Operation failed" message as an object array so can be used to answer getChildren().
String	getFilterString ()           Gets filter context for querying.
String	getFilterStringFor ( Object object)           Return a filter string that corresponds to this object.
protected   Object	getFirstSelection ( IStructuredSelection selection)           Get the first selected object of the given selection.
abstract   ImageDescriptor	getImageDescriptor ( Object element)           Returns an image descriptor for the image. Abstract.
ISystemViewInputProvider	getInput ()           Get the input object used to populate the viewer with the roots.
String	getInputMementoHandle ( Object element)           Return what to save to disk to identify this element when it is the input object to a secondary Remote System Explorer perspective.
String	getLabel ( Object element)           {inheritDoc} We map to getText(element).
String	getMementoHandle ( Object element)           Return what to save to disk to identify this element in the persisted list of expanded elements.
String	getMementoHandleKey ( Object element)           Return a short string to uniquely identify the type of resource.
String	getName ( Object element)           Return the name of this object, which may be different than the display text ({#link #getText(Object)}. By default, returns getText(element);, but child classes can override if display name doesn't equal real name.
ISystemValidator	getNameValidator ( Object element)           Return a validator for verifying the new name is correct.
abstract   Object	getParent ( Object element)           Return the parent of this object. Abstract.
IPropertyDescriptor[]	getPropertyDescriptors ()           Returns the property descriptors defining what properties are seen in the property sheet.
Object	getPropertyValue ( Object key)           Returns the current value for the named property.
Object	getPropertyValue ( Object key, boolean formatted)           Similar to getPropertyValue(Object key) but takes an argument for determining whether to return a raw value or formatted value.
protected   ISystemRemoteElementAdapter	getRemoteAdapter ( Object o)           Deprecated. use SystemAdapterHelpers.getRemoteAdapter(o, getViewer()) instead
String	getRemoteSourceType ( Object element)           From (Object).
String	getRemoteSubSubType ( Object element)           From (Object).
ISchedulingRule	getRule ( Object element)
Shell	getShell ()           Get the shell currently hosting the objects in this adapter.
String	getStatusLineText ( Object element)           Return the string to display in the status line when the given object is selected. The default is: getType(): getName() Overridable by subclasses, but rarely needs to be.
ISubSystem	getSubSystem ( Object element)           Returns the subsystem that contains this object.
protected   SystemFetchOperation	getSystemFetchOperation ( Object o, IElementCollector collector)           Returns the SystemFetchOperation to be used in performing a query.
protected   ISystemTree	getSystemTree ()           Return the current viewer as an ISystemTree if the viewer is set and it implements this interface (SystemView does).
protected   ISystemViewElementAdapter	getSystemViewElementAdapter ( Object o)           Deprecated. use SystemAdapterHelpers.getViewAdapter(o, getViewer()) instead
protected   String	getTranslatedFalse ()           Return "False" translated.
protected   String	getTranslatedNo ()           Return "No" translated.
protected   String	getTranslatedNotApplicable ()           Return "Not applicable" translated.
protected   String	getTranslatedNotAvailable ()           Return "Not available" translated.
protected   String	getTranslatedTrue ()           Return "True" translated.
String	getTranslatedYes ()           Return "Yes" translated.
abstract   String	getType ( Object element)           Return a value for the type property for this object. Abstract.
IPropertyDescriptor[]	getUniquePropertyDescriptors ()           Returns the list of property descriptors that are unique for this particular adapter - that is the difference between the default property descriptors and the total list of property descriptors.
Viewer	getViewer ()           Return the current viewer, as set via setViewer or its deduced from the setInput input object if set.
boolean	handleDoubleClick ( Object element)           User has double clicked on an object.
abstract  boolean	hasChildren ( IAdaptable element)           Return true if this object has children. Abstract.
boolean	hasChildren ( IContextObject element)           Return true if this object has children. Override this to provide context-specific support.
protected  void	initMsgObjects ()           Deprecated. Internal use. Do not call this method.
protected abstract   IPropertyDescriptor[]	internalGetPropertyDescriptors ()           Implement this to return the property descriptors for the properties in the property sheet.
protected abstract   Object	internalGetPropertyValue ( Object key)           Implement this to return the property descriptors for the properties in the property sheet.
boolean	isContainer ()
boolean	isPromptable ( Object element)           Return true if this object is a "prompting" object that prompts the user when expanded.
boolean	isPropertySet ( Object key)           Returns whether the property value has changed from the default.
boolean	isRemote ( Object element)           Return true if this object is remote.
boolean	namesAreEqual ( Object element, String newName)           Compare the name of the given element to the given new name to decide if they are equal.
void	resetPropertyValue ( Object key)           Resets the specified property's value to its default value.
boolean	saveExpansionState ( Object element)           Sometimes we don't want to remember an element's expansion state, such as for temporarily inserted messages.
void	selectionChanged ( Object element)           Selection has changed in the Remote Systems view.
void	setFilterString ( String filterString)           Sets filter context for querying.
void	setInput ( ISystemViewInputProvider input)           Set the input object used to populate the viewer with the roots.
void	setPropertySourceInput ( Object propertySourceInput)           Set input object for property source queries.
void	setPropertyValue ( Object key, Object value)           Sets the named property to the given value.
void	setShell ( Shell shell)           Set the shell to be used by any method that requires it.
void	setViewer ( Viewer viewer)           Set the viewer that is driving this adapter Called by label and content provider.
boolean	showDelete ( Object element)           Return true if we should show the delete action in the popup for the given element.
boolean	showGenericShowInTableAction ( Object element)           Return true if we should show the generic show in table action in the popup for the given element.
boolean	showOpenViewActions ( Object element)           Return true if we should show the Go Into; and Open In New Window and Go To actions in the popup for the given element.
boolean	showProperties ( Object element)           Return true if we should show the properties action in the popup for the given element.
boolean	showRefresh ( Object element)           Return true if we should show the refresh action in the popup for the given element.
boolean	showRename ( Object element)           Return true if we should show the rename action in the popup for the given element.
static  String	sub ( String msg, String subOld, String subNew)           Deprecated. Clients should use Eclipse NLS or Java MessageFormat or String.replaceAll(String, String) to do substring replacement and variable substitution.
boolean	supportsDeferredQueries ( ISubSystem subSys)           Return whether deferred queries are supported.
boolean	testAttribute ( Object target, String name, String value)           From IActionFilter so the popupMenus extension point can use <filter>, <enablement> or <visibility>.
boolean	validateDrop ( ISystemResourceSet set, Object target, boolean sameSystem)           Return true if it is valid for the src objects to be dropped in the target
boolean	validateDrop ( Object src, Object target, boolean sameSystem)           Return true if it is valid for the src object to be dropped in the target.

 

Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface org.eclipse.rse.ui.view. ISystemViewElementAdapter
getText

 

Methods inherited from interface org.eclipse.rse.core.subsystems. IRemoteObjectIdentifier
getAbsoluteName

 

Field Detail

viewer

protected 
Viewer viewer

Deprecated. use getViewer() and setViewer(Viewer)

Current viewer. Set by content provider.

propertySourceInput

protected 
Object propertySourceInput

Current input provider. Set by content provider.

shell

protected 
Shell shell

Deprecated. Use getShell() and setShell(Shell)

Current shell, set by the content provider.

emptyList

protected 
Object[] emptyList

Deprecated. Do not use directly. Use checkForEmptyList(Object[], Object, boolean) when needed.

An empty object list instance, for returning an empty list from getChildren: new Object[0].

msgList

protected 
Object[] msgList

Deprecated. Do not use directly. Use getCancelledMessageObject() or getFailedMessageObject() or checkForEmptyList(Object[], Object, boolean) when needed.

For returning a message object from getChildren. Will be an array with one item, one of nullObject, cancelledObject or errorObject.

nullObject

protected 
SystemMessageObject nullObject

Deprecated. Use checkForEmptyList(Object[], Object, boolean) instead.

Frequently returned message object from getChildren: "empty list"

cancelledObject

protected 
SystemMessageObject cancelledObject

Deprecated. Use getCancelledMessageObject() instead.

Frequently returned message object from getChildren: "operation cancelled". This field was renamed from "canceledObject" in RSE 3.0.

Since:

org.eclipse.rse.ui 3.0

errorObject

protected 
SystemMessageObject errorObject

Deprecated. Use getFailedMessageObject() instead.

Frequently returned message object from getChildren: "operation ended in error"

MSG_SUB_PREFIX

protected static final 
String MSG_SUB_PREFIX

Deprecated. use Eclipse NLS or Java Messageformat for String substitution.

Message substitution prefix: "&"

See Also:

Constant Field Values

MSG_SUB1

protected static final 
String MSG_SUB1

Deprecated. use Eclipse NLS or Java Messageformat for String substitution.

Message substitution variable 1: "&1"

See Also:

Constant Field Values

MSG_SUB2

protected static final 
String MSG_SUB2

Deprecated. use Eclipse NLS or Java Messageformat for String substitution.

Message substitution variable 2: "&2"

See Also:

Constant Field Values

MEMENTO_DELIM

public static final 
String MEMENTO_DELIM

Delimiter for each object's key in a memento, used to persist tree view expansion state: "///"

See Also:

Constant Field Values

EMPTY_STRING_LIST

protected static final 
String[] EMPTY_STRING_LIST

A handy constant of "new String[0]"

_lastResults

protected 
Object[] _lastResults

A variable that can be used in getChildren to cache last returned results, if desired

_lastSelected

protected 
Object _lastSelected

A variable that can be used to cache last selection, if desired

AbstractSystemViewAdapter

public AbstractSystemViewAdapter()

setViewer

public final void setViewer(
Viewer viewer)

Set the viewer that is driving this adapter Called by label and content provider.

Configuration method. Typically called by content provider, viewer or action. Do not override.

Specified by:

setViewer in interface ISystemViewElementAdapter

setShell

public final void setShell(
Shell shell)

Set the shell to be used by any method that requires it.

Configuration method. Typically called by content provider, viewer or action. Do not override.

Specified by:

setShell in interface ISystemViewElementAdapter

setInput

public final void setInput(
ISystemViewInputProvider input)

Set the input object used to populate the viewer with the roots. May be used by an adapter to retrieve context-sensitive information. This is set by the Label and Content providers that retrieve this adapter.

Configuration method. Typically called by content provider, viewer or action. Do not override.

Specified by:

setInput in interface ISystemViewElementAdapter

getShell

public 
Shell getShell()

Get the shell currently hosting the objects in this adapter.

Getter method. Callable by subclasses. Do not override.

Specified by:

getShell in interface ISystemViewElementAdapter

getViewer

public 
Viewer getViewer()

Return the current viewer, as set via setViewer or its deduced from the setInput input object if set. May be null so test it.

Getter method. Callable by subclasses. Do not override.

Specified by:

getViewer in interface ISystemViewElementAdapter

getCurrentTreeView

protected 
ISystemTree getCurrentTreeView()

Return the current viewer as an ISystemTree if it is one, or null otherwise.

Getter method. Callable by subclasses. Do not override.

getInput

public 
ISystemViewInputProvider getInput()

Get the input object used to populate the viewer with the roots. May be used by an adapter to retrieve context-sensitive information.

Getter method. Callable by subclasses. Do not override.

Specified by:

getInput in interface ISystemViewElementAdapter

getSubSystem

public 
ISubSystem getSubSystem(
Object element)

Returns the subsystem that contains this object. By default, if the given element is an instance of AbstractResource, it calls getSubSystem on it, else returns null.

Overridable by subclasses. You should override if not using AbstractResource.

Specified by:

getSubSystem in interface ISystemDragDropAdapter

Specified by:

getSubSystem in interface ISystemViewElementAdapter

Parameters:

element - The element to be identified. May be of type IContextObject (including the context of the element), String (giving the absolute path of a remote object), or the actual remote data element itself.

addCommonRemoteActions

public void addCommonRemoteActions(
SystemMenuManager menu,
                                   
IStructuredSelection selection,
                                   
Shell shell,
                                   
String menuGroup)

Returns any framework-supplied remote object actions that should be contributed to the popup menu for the given selection list. This does nothing if this adapter does not implement ISystemViewRemoteElementAdapter, else it potentially adds menu items for "User Actions" and Compile", for example. It queries the subsystem factory of the selected objects to determine if these actions are appropriate to add.

Called by SystemView viewer. No need to override or call.

Parameters:

menu - The menu to contribute actions to

selection - The window's current selection.

shell - of viewer calling this. Most dialogs require a shell.

menuGroup - recommended menu group to add actions to. If added to another group, you must be sure to create that group first.

addDynamicPopupMenuActions

public void addDynamicPopupMenuActions(
SystemMenuManager menu,
                                       
IStructuredSelection selection,
                                       
Shell shell,
                                       
String menuGroup)

Add or remove custom actions dynamically to a context menu. This method is called by the system viewers. Extenders may override this method in order to modify the context menu shown for elements of the type they adapt to. Unlike addCommonRemoteActions(), these contributions are for any artifact in the RSE views and are contributed independently of subsystem factories.

Parameters:

menu - The menu to contribute actions to

selection - The window's current selection.

shell - of viewer calling this. Most dialogs require a shell.

menuGroup - recommended menu group to add actions to. If added to another group, you must be sure to create that group first.

addActions

public abstract void addActions(
SystemMenuManager menu,
                                
IStructuredSelection selection,
                                
Shell parent,
                                
String menuGroup)

This is your opportunity to add actions to the popup menu for the given selection.

To put your action into the given menu, use the menu's rse.ui.SystemMenuManager#add(String,org.eclipse.jface.action.IAction) add method. If you don't care where it goes within the popup, just pass the given menuGroup location id, otherwise pass one of the GROUP_XXX values from ISystemContextMenuConstants. If you pass one that identifies a predefined cascading menu, such as GROUP_OPENWITH, your action will magically appear in that cascading menu, even if it was otherwise empty.

For the actions themselves, you will probably use one of the base action classes:

• SystemBaseAction . For a simple action doesn't present any UI.
• SystemBaseDialogAction. For an action that presents a dialog.
• SystemBaseWizardAction. For an action that presents a wizard.
• SystemBaseSubMenuAction . For an action that cascades into a submenu with other actions.

Specified by:

addActions in interface ISystemViewElementAdapter

Parameters:

menu - the popup menu you can contribute to

selection - the current selection in the calling tree or table view

parent - the shell of the calling tree or table view

menuGroup - the default menu group to place actions into if you don't care where they. Pass this to the SystemMenuManager add method.

See Also:

ISystemViewElementAdapter.addActions( SystemMenuManager, IStructuredSelection, Shell, String)

getImageDescriptor

public abstract 
ImageDescriptor getImageDescriptor(
Object element)

Returns an image descriptor for the image. More efficient than getting the image. Implements IWorkbenchAdapter.getImageDescriptor(Object). Abstract. Must be overridden by subclasses.

Specified by:

getImageDescriptor in interface ISystemViewElementAdapter

Specified by:

getImageDescriptor in interface IWorkbenchAdapter

Parameters:

element - The element for which an image is desired

getAlternateText

public 
String getAlternateText(
Object element)

Return the alternate label for this object. By default this just returns the regular label. If a custom label is required, this provides the means to it.

Specified by:

getAlternateText in interface ISystemViewElementAdapter

See Also:

getName(Object), IRemoteObjectIdentifier.getAbsoluteName(Object)

getName

public 
String getName(
Object element)

Return the name of this object, which may be different than the display text ({#link #getText(Object)}. By default, returns getText(element);, but child classes can override if display name doesn't equal real name.

Called by common rename and delete actions, and used to populate property sheet.

Overridable by subclasses, but rarely needs to be.

Specified by:

getName in interface ISystemViewElementAdapter

See Also:

ISystemViewElementAdapter.getText(Object), IRemoteObjectIdentifier.getAbsoluteName(Object)

getLabel

public 
String getLabel(
Object element)

{inheritDoc} We map to getText(element).

Internal use. Can be safely ignored.

Specified by:

getLabel in interface IWorkbenchAdapter

getType

public abstract 
String getType(
Object element)

Return a value for the type property for this object.

Abstract. Must be overridden by subclasses.

Specified by:

getType in interface ISystemViewElementAdapter

getStatusLineText

public 
String getStatusLineText(
Object element)

Return the string to display in the status line when the given object is selected. The default is:

 getType(): getName()
 

Overridable by subclasses, but rarely needs to be.

Specified by:

getStatusLineText in interface ISystemViewElementAdapter

exists

public boolean exists(
Object element)

{inheritDoc} By default, this method returns true - override this method to customize the behavior.

Specified by:

exists in interface ISystemViewElementAdapter

Parameters:

element - the element to check

Returns:

true if the element exists

Since:

3.0

getParent

public abstract 
Object getParent(
Object element)

Return the parent of this object. This is required by eclipse UI adapters, but we try desperately not to use in the RSE. So, you are probably safe returning null, but if you can return a parent, why not, go for it. Abstract. Must be overridden by subclasses.

Specified by:

getParent in interface ISystemViewElementAdapter

Specified by:

getParent in interface IWorkbenchAdapter

hasChildren

public abstract boolean hasChildren(
IAdaptable element)

Return true if this object has children.

In case this adapter returns true for ISystemViewElementAdapter.supportsDeferredQueries(ISubSystem), it is expected that the underlying subsystem caches the hasChildren() attribute such that it does not necessarily perform a server round trip. In this case, it has more the semantics of "can have children". In that case, a deferred ISystemViewElementAdapter.getChildren(IAdaptable, IProgressMonitor) call is still allowed to return an empty array indicating no children.

Abstract. Must be overridden by subclasses.

Specified by:

hasChildren in interface ISystemViewElementAdapter

Parameters:

element - the element to check

Returns:

true if this element can have children.

hasChildren

public boolean hasChildren(
IContextObject element)

Return true if this object has children. Override this to provide context-specific support.

Specified by:

hasChildren in interface ISystemViewElementAdapter

Parameters:

element - the context object

Returns:

whether the context has children

See Also:

ISystemViewElementAdapter.hasChildren(IAdaptable)

getChildren

public final 
Object[] getChildren(
Object object)

Rather than overriding this, adapter implementors should override the getChildren() methods that take a progress monitor.

Specified by:

getChildren in interface IWorkbenchAdapter

getChildren

public abstract 
Object[] getChildren(
IAdaptable element,
                                     
IProgressMonitor monitor)

Return the children of this model object. When ISystemViewElementAdapter.supportsDeferredQueries(ISubSystem) returns false, this query will be called in the dispatch thread, so the implementation needs to make sure that SWT thread exceptions are avoided. This should be overridden by subclasses in order to provide deferred query support via the Eclipse Jobs mechanism. Return the children of this object. Return null if children not supported.

Specified by:

getChildren in interface ISystemViewElementAdapter

Parameters:

element - the model object to get children from

monitor - the progress monitor

Returns:

the children of element

getChildren

public 
Object[] getChildren(
IContextObject element,
                            
IProgressMonitor monitor)

Return the children of this object. When a contextObject is passed in instead of an adaptable model object, the adapter needs handle both the model object as well as the associated filter. When ISystemViewElementAdapter.supportsDeferredQueries(ISubSystem) returns false, this query will be called in the dispatch thread, so the implementation needs to make sure that SWT thread exceptions are avoided. This should be overridden by subclasses in order to provide deferred query support via the Eclipse Jobs mechanism, if your adapter supports context objects. If not, this will fall back to the model object version of the method. The context object is passed in in place of the model object. By default, we just fall back to the original mechanism Return the children of this object. Return null if children not supported.

Specified by:

getChildren in interface ISystemViewElementAdapter

Parameters:

element - the context object that wrappers a model object, it's subsystem and filter reference

monitor - the progress monitor

Returns:

the children of the model object within the context object that matches the containing filter reference criteria.

getChildrenUsingExpandToFilter

public 
Object[] getChildrenUsingExpandToFilter(
Object element,
                                               
String expandToFilter)

Return the children of this object, using the given Expand-To filter. By default, this calls getChildren(element). Override only if you support Expand-To menu actions.

Overridable by subclasses, but rarely needs to be.

Specified by:

getChildrenUsingExpandToFilter in interface ISystemViewElementAdapter

getDefaultDescriptors

protected static 
IPropertyDescriptor[] getDefaultDescriptors()

Return the default descriptors for all system elements. Callable by subclasses.

createSimplePropertyDescriptor

protected static 
PropertyDescriptor createSimplePropertyDescriptor(
String propertyKey,
                                                                   
String label,
                                                                   
String description)

Create and return a simple string read-only property descriptor. Callable by subclasses.

Parameters:

propertyKey - Key for this property, sent back in getPropertyValue.

label - A user-readable translated label for the Property.

description - A description for the Property (to be displayed as a tooltip).

getEditableValue

public 
Object getEditableValue()

Returns a value for this object that can be edited in a property sheet. Needed by framework for property sheet. No need to call or override.

Specified by:

getEditableValue in interface IPropertySource

Returns:

a value that can be edited.

getPropertyDescriptors

public 
IPropertyDescriptor[] getPropertyDescriptors()

Returns the property descriptors defining what properties are seen in the property sheet. By default returns descriptors for name, type and number-of-children only plus whatever is returned from internalGetPropertyDescriptors().

Implemented. Do not override typically. See internalGetPropertyDescriptors().

Specified by:

getPropertyDescriptors in interface IPropertySource

Returns:

an array containing all descriptors.

See Also:

internalGetPropertyDescriptors()

internalGetPropertyDescriptors

protected abstract 
IPropertyDescriptor[] internalGetPropertyDescriptors()

Implement this to return the property descriptors for the properties in the property sheet. This is beyond the Name, Type and NbrOfChildren properties which already implemented and done for you.

Override if want to include more properties in the property sheet,

If you override this for read-only properties, you must also override:

• getPropertyValue(Object)

If you override this for editable properties, you must also override:

• isPropertySet(Object)
• resetPropertyValue(Object)
• setPropertyValue(Object,Object)

Returns:

an array containing all descriptors to be added to the default set of descriptors, or null if no additional properties desired.

See Also:

createSimplePropertyDescriptor(String, String, String)

getUniquePropertyDescriptors

public 
IPropertyDescriptor[] getUniquePropertyDescriptors()

Returns the list of property descriptors that are unique for this particular adapter - that is the difference between the default property descriptors and the total list of property descriptors.

If internalGetPropertyDescriptors() returns non-null, then returns that, else computes the difference. This is called by the table views like SystemTableView.

Callable by subclasses. Do not override.

Specified by:

getUniquePropertyDescriptors in interface ISystemViewElementAdapter

getPropertyValue

public 
Object getPropertyValue(
Object key,
                               boolean formatted)

Similar to getPropertyValue(Object key) but takes an argument for determining whether to return a raw value or formatted value. By default, simply calls getPropertyValue(key).

This is called by the table views in order to get values that can be sorted when the user clicks on the column heading. To support this for a numeric property say, return a Long/Integer object if false, versus returning string.

Overridable by subclasses, but usually is not.

Specified by:

getPropertyValue in interface ISystemViewElementAdapter

Parameters:

key - the name or key of the property as named by its property descriptor

formatted - indication of whether to return the value in formatted or raw form

Returns:

the current value of the given property

public 
Object getPropertyValue(
Object key)

protected abstract 
Object internalGetPropertyValue(
Object key)

public boolean isPropertySet(
Object key)

public void resetPropertyValue(
Object key)

public void setPropertyValue(
Object key,
                             
Object value)

public void setPropertySourceInput(
Object propertySourceInput)

public boolean handleDoubleClick(
Object element)

public boolean showDelete(
Object element)

public boolean canDelete(
Object element)

public boolean doDelete(
Shell shell,
                        
Object element,
                        
IProgressMonitor monitor)
                 throws 
Exception

public boolean doDeleteBatch(
Shell shell,
                             
List resourceSet,
                             
IProgressMonitor monitor)
                      throws 
Exception

public boolean showRename(
Object element)

public boolean canRename(
Object element)

public boolean doRename(
Shell shell,
                        
Object element,
                        
String name,
                        
IProgressMonitor monitor)
                 throws 
Exception

public 
ISystemValidator getNameValidator(
Object element)

public 
String getCanonicalNewName(
Object element,
                                  
String newName)

public boolean namesAreEqual(
Object element,
                             
String newName)

public boolean showRefresh(
Object element)

public boolean showProperties(
Object element)

public boolean showOpenViewActions(
Object element)

public boolean showGenericShowInTableAction(
Object element)

public boolean canDrag(
Object element)

public boolean canDrag(
SystemRemoteResourceSet elements)

public 
Object doDrag(
Object element,
                     boolean sameSystemType,
                     
IProgressMonitor monitor)

public boolean canDrop(
Object element)

public 
ISystemResourceSet doDrag(
SystemRemoteResourceSet set,
                                 
IProgressMonitor monitor)

public 
ISystemResourceSet doDrop(
ISystemResourceSet fromSet,
                                 
Object to,
                                 boolean sameSystemType,
                                 boolean sameSystem,
                                 int srcType,
                                 
IProgressMonitor monitor)

public void setFilterString(
String filterString)

public 
String getFilterString()

public 
Object doDrop(
Object from,
                     
Object to,
                     boolean sameSystemType,
                     boolean sameSystem,
                     int srcType,
                     
IProgressMonitor monitor)

public 
Object doDrop(
Object from,
                     
Object to,
                     boolean sameSystemType,
                     boolean sameSystem,
                     
IProgressMonitor monitor)

public boolean validateDrop(
Object src,
                            
Object target,
                            boolean sameSystem)

public boolean validateDrop(
ISystemResourceSet set,
                            
Object target,
                            boolean sameSystem)

public 
String getMementoHandle(
Object element)

public 
String getInputMementoHandle(
Object element)

public 
String getMementoHandleKey(
Object element)

public boolean saveExpansionState(
Object element)

public boolean isPromptable(
Object element)

public boolean isRemote(
Object element)

public void selectionChanged(
Object element)

public boolean testAttribute(
Object target,
                             
String name,
                             
String value)

public 
String getRemoteSubSubType(
Object element)

public 
String getRemoteSourceType(
Object element)

public 
ISystemEditableRemoteObject getEditableRemoteObject(
Object object)

public boolean canEdit(
Object object)

protected 
ISystemViewElementAdapter getSystemViewElementAdapter(
Object o)

protected 
ISystemRemoteElementAdapter getRemoteAdapter(
Object o)

public static 
String sub(
String msg,
                         
String subOld,
                         
String subNew)

protected 
ISystemTree getSystemTree()

public 
String getTranslatedYes()

protected 
String getTranslatedNo()

protected 
String getTranslatedTrue()

protected 
String getTranslatedFalse()

protected 
String getTranslatedNotApplicable()

protected 
String getTranslatedNotAvailable()

protected final void initMsgObjects()

protected 
Object[] checkForEmptyList(
Object[] children,
                                     
Object parent,
                                     boolean returnNullMsg)

protected 
Object[] checkForNull(
Object[] children,
                                boolean returnNullMsg)

protected final 
Object[] getCancelledMessageObject()

protected final 
Object[] getFailedMessageObject()

protected final 
Object[] getEmptyMessageObject()

protected 
Object getFirstSelection(
IStructuredSelection selection)

public 
String getFilterStringFor(
Object object)

public boolean supportsDeferredQueries(
ISubSystem subSys)

public void fetchDeferredChildren(
Object o,
                                  
IElementCollector collector,
                                  
IProgressMonitor monitor)

protected 
SystemFetchOperation getSystemFetchOperation(
Object o,
                                                       
IElementCollector collector)

public boolean isContainer()

public 
ISchedulingRule getRule(
Object element)