org.eclipse.rse.ui.view
Class SystemViewFilterAdapter

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

All Implemented Interfaces:

IActionFilter, IBasicPropertyConstants, IDeferredWorkbenchAdapter, IPropertySource, IRemoteObjectIdentifier, ISystemDragDropAdapter, ISystemPropertyConstants, ISystemViewActionFilter, ISystemViewElementAdapter, IWorkbenchAdapter

public class SystemViewFilterAdapter

extends AbstractSystemViewAdapter

implements ISystemViewElementAdapter

Default Adapter for displaying filter objects in tree views. For some subsystems, these are children of SubSystem objects. This class offers default behaviour but can be subclassed to refine the behaviour. If this is done, you must register your subclass with the platform's adapter manager in your plugin class's startup method.

Field Summary

Fields inherited from class org.eclipse.rse.ui.view.AbstractSystemViewAdapter

_lastResults, _lastSelected, canceledObject, EMPTY_STRING_LIST, emptyList, errorObject, filterString, MEMENTO_DELIM, MSG_SUB_PREFIX, MSG_SUB1, MSG_SUB2, msgList, nullObject, propertySourceInput, shell, viewer

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

noActions

Fields inherited from interface org.eclipse.rse.ui.view.ISystemPropertyConstants

P_ARCHIVE_COMMENT, P_ARCHIVE_EXPANDEDSIZE, P_CCSID, P_COMMAND, P_COMMENT, P_COMPILETYPE_TYPES, P_DEFAULTUSERID, P_DESCRIPTION, P_ENVLIST, P_ERROR, P_ERROR_FILENAME, P_ERROR_LINENO, P_FILE_CANONICAL_PATH, P_FILE_CLASSIFICATION, P_FILE_HIDDEN, P_FILE_LASTMODIFIED, P_FILE_PATH, P_FILE_READABLE, P_FILE_READONLY, P_FILE_SIZE, P_FILE_WRITABLE, P_FILTER, P_FILTERS, P_FILTERSTRING, P_FILTERSTRINGS, P_FILTERSTRINGS_COUNT, P_HAS_CHILDREN, P_HOSTNAME, P_IS_ACTIVE, P_IS_CONNECTED, P_IS_CONNECTION_PRIVATE, P_NBRCHILDREN, P_NEWNAME, P_OK, P_ORIGIN, P_PARENT_FILTER, P_PARENT_FILTERPOOL, P_PASSWORD, P_PORT, P_PREFIX, P_PROFILE, P_RELATED_CONNECTION, P_SEARCH_LINE, P_SHELL_CONTEXT, P_SHELL_STATUS, P_SYSTEMTYPE, P_TYPE, P_USERACTION_DOMAIN, P_USERID, P_VENDOR, P_VIRTUAL_COMMENT, P_VIRTUAL_COMPRESSEDSIZE, P_VIRTUAL_COMPRESSIONMETHOD, P_VIRTUAL_COMPRESSIONRATIO, P_VRM

Fields inherited from interface org.eclipse.jface.viewers.IBasicPropertyConstants

P_CHILDREN, P_IMAGE, P_PARENT, P_TEXT

Constructor Summary

SystemViewFilterAdapter()

Method Summary

void	addActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup) Returns any actions that should be contributed to the popup menu for the given filter object.
boolean	canDelete(Object element) Return true if this object is deletable by the user.
boolean	canRename(Object element) Return true if this object is renamable by the user.
boolean	doDelete(Shell shell, Object element, IProgressMonitor monitor) Perform the delete action.
boolean	doRename(Shell shell, Object element, String name) Perform the rename action.
String	getAbsoluteName(Object element) Return the absolute name, versus just display name, of this object
String	getCanonicalNewName(Object element, String newName) Parent override.
Object[]	getChildren(Object element) Return the children of this filter.
ImageDescriptor	getImageDescriptor(Object element) Returns an image descriptor for the image.
String	getName(Object element) Return the name of this object, which may be different than the display text ({#link #getText(Object)}.
ISystemValidator	getNameValidator(Object element) Return a validator for verifying the new name is correct.
Object	getParent(Object element) Return the parent of this object.
String	getText(Object element) Return the label for this object.
String	getType(Object element) Return the type label for this object
boolean	hasChildren(Object element) Return true if this object has children
protected IPropertyDescriptor[]	internalGetPropertyDescriptors() Return our unique property descriptors
protected Object	internalGetPropertyValue(Object key) Return our unique property values The parent handles P_TEXT and P_TYPE only, and we augment that here.
boolean	showDelete(Object element) Return true if we should show the delete action in the popup for the given element.
boolean	showOpenViewActions(Object element) Return true if we should show the refresh 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.
boolean	testAttribute(Object target, String name, String value) Overide of parent method.

Methods inherited from class org.eclipse.rse.ui.view.AbstractSystemViewAdapter

addCommonRemoteActions, addDynamicPopupMenuActions, canDrag, canDrag, canDrop, canEdit, checkForNull, createSimplePropertyDescriptor, doDelete, doDeleteBatch, doDrag, doDrag, doDrop, doDrop, doDrop, fetchDeferredChildren, getAdapter, getAlternateText, getCancelledMessageObject, getChildren, getChildrenUsingExpandToFilter, getCurrentTreeView, getDefaultDescriptors, getEditableRemoteObject, getEditableValue, getEmptyMessageObject, getFailedMessageObject, getFilterString, getFilterStringFor, getFirstSelection, getInput, getInputMementoHandle, getLabel, getMementoHandle, getMementoHandleKey, getPropertyDescriptors, getPropertyValue, getPropertyValue, getRemoteAdapter, getRemoteSourceType, getRemoteSubSubType, getRule, getShell, getStatusLineText, getSubSystem, getSystemFetchOperation, getSystemTree, getTranslatedFalse, getTranslatedNo, getTranslatedNotApplicable, getTranslatedNotAvailable, getTranslatedTrue, getTranslatedYes, getUniquePropertyDescriptors, getViewer, handleDoubleClick, initMsgObjects, isContainer, isPromptable, isPropertySet, namesAreEqual, resetPropertyValue, saveExpansionState, selectionChanged, setFilterString, setInput, setPropertySourceInput, setPropertyValue, setShell, setViewer, showGenericShowInTableAction, sub, supportsDeferredQueries, validateDrop, validateDrop

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

doDelete, doDeleteBatch, getAlternateText, getChildren, getChildrenUsingExpandToFilter, getFilterString, getInput, getInputMementoHandle, getMementoHandle, getMementoHandleKey, getPropertyValue, getShell, getStatusLineText, getSubSystem, getUniquePropertyDescriptors, getViewer, handleDoubleClick, isPromptable, namesAreEqual, saveExpansionState, selectionChanged, setFilterString, setInput, setPropertySourceInput, setShell, setViewer, showGenericShowInTableAction, supportsDeferredQueries

Methods inherited from interface org.eclipse.ui.views.properties.IPropertySource

getEditableValue, getPropertyDescriptors, getPropertyValue, isPropertySet, resetPropertyValue, setPropertyValue

Methods inherited from interface org.eclipse.rse.ui.view.ISystemDragDropAdapter

canDrag, canDrag, canDrop, doDrag, doDrag, doDrop, doDrop, validateDrop, validateDrop

Constructor Detail

SystemViewFilterAdapter

public SystemViewFilterAdapter()

Method Detail

addActions

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

Returns any actions that should be contributed to the popup menu for the given filter object.

Specified by:

addActions in interface ISystemViewElementAdapter

Specified by:

addActions in class AbstractSystemViewAdapter

Parameters:

menu - The menu to contribute actions to

selection - The window's current selection.

shell - Shell of viewer

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

See Also:

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

getImageDescriptor

public ImageDescriptor getImageDescriptor(Object element)

Returns an image descriptor for the image. More efficient than getting the image.

Specified by:

getImageDescriptor in interface ISystemViewElementAdapter

Specified by:

getImageDescriptor in class AbstractSystemViewAdapter

Parameters:

element - The element for which an image is desired

getText

public String getText(Object element)

Return the label for this object. Calls getName on the filter

Specified by:

getText in interface ISystemViewElementAdapter

Specified by:

getText in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.getName(Object), AbstractSystemViewAdapter.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)}.

Called by common rename and delete actions.

Specified by:

getName in interface ISystemViewElementAdapter

Overrides:

getName in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.getText(Object), AbstractSystemViewAdapter.getAbsoluteName(Object)

getAbsoluteName

public String getAbsoluteName(Object element)

Return the absolute name, versus just display name, of this object

Specified by:

getAbsoluteName in interface IRemoteObjectIdentifier

Specified by:

getAbsoluteName in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.getText(Object), AbstractSystemViewAdapter.getName(Object)

getType

public String getType(Object element)

Return the type label for this object

Specified by:

getType in interface ISystemViewElementAdapter

Specified by:

getType in class AbstractSystemViewAdapter

getParent

public Object getParent(Object element)

Return the parent of this object. This will be either a SubSystem object, or a filter object.

Specified by:

getParent in interface ISystemViewElementAdapter

Specified by:

getParent in class AbstractSystemViewAdapter

getChildren

public Object[] getChildren(Object element)

Return the children of this filter. This is a combination of nested filters and resolved filter objects.

Specified by:

getChildren in interface ISystemViewElementAdapter

Specified by:

getChildren in class AbstractSystemViewAdapter

hasChildren

public boolean hasChildren(Object element)

Return true if this object has children

Specified by:

hasChildren in interface ISystemViewElementAdapter

Specified by:

hasChildren in class AbstractSystemViewAdapter

internalGetPropertyDescriptors

protected IPropertyDescriptor[] internalGetPropertyDescriptors()

Return our unique property descriptors

Specified by:

internalGetPropertyDescriptors in class AbstractSystemViewAdapter

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,ResourceBundle,String)

internalGetPropertyValue

protected Object internalGetPropertyValue(Object key)

Return our unique property values The parent handles P_TEXT and P_TYPE only, and we augment that here.

Specified by:

internalGetPropertyValue in class AbstractSystemViewAdapter

Parameters:

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

Returns:

the current value of the property

showDelete

public boolean showDelete(Object element)

Description copied from interface: ISystemViewElementAdapter

Return true if we should show the delete action in the popup for the given element. If true, then canDelete will be called to decide whether to enable delete or not.

Specified by:

showDelete in interface ISystemViewElementAdapter

Overrides:

showDelete in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canDelete(Object), AbstractSystemViewAdapter.doDelete(Shell,Object)

canDelete

public boolean canDelete(Object element)

Return true if this object is deletable by the user. If so, when selected, the Edit->Delete menu item will be enabled.

Specified by:

canDelete in interface ISystemViewElementAdapter

Overrides:

canDelete in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.showDelete(Object), AbstractSystemViewAdapter.doDelete(Shell,Object)

doDelete

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

Perform the delete action.

Specified by:

doDelete in interface ISystemViewElementAdapter

Overrides:

doDelete in class AbstractSystemViewAdapter

Throws:

Exception

See Also:

AbstractSystemViewAdapter.showDelete(Object), AbstractSystemViewAdapter.canDelete(Object)

showRename

public boolean showRename(Object element)

Description copied from interface: ISystemViewElementAdapter

Return true if we should show the rename action in the popup for the given element. If true, then canRename will be called to decide whether to enable rename or not.

Specified by:

showRename in interface ISystemViewElementAdapter

Overrides:

showRename in class AbstractSystemViewAdapter

Returns:

true if we should show the rename action in the popup for the given element.

See Also:

AbstractSystemViewAdapter.canRename(Object), AbstractSystemViewAdapter.doRename(Shell,Object,String)

canRename

public boolean canRename(Object element)

Return true if this object is renamable by the user. If so, when selected, the Rename popup menu item will be enabled.

Specified by:

canRename in interface ISystemViewElementAdapter

Overrides:

canRename in class AbstractSystemViewAdapter

Returns:

true if this object is renamable by the user

See Also:

AbstractSystemViewAdapter.showRename(Object), AbstractSystemViewAdapter.doRename(Shell,Object,String), AbstractSystemViewAdapter.getNameValidator(Object), AbstractSystemViewAdapter.getCanonicalNewName(Object,String), AbstractSystemViewAdapter.namesAreEqual(Object,String)

doRename

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

Perform the rename action.

Specified by:

doRename in interface ISystemViewElementAdapter

Overrides:

doRename in class AbstractSystemViewAdapter

Returns:

true if the rename was successful

Throws:

Exception

See Also:

AbstractSystemViewAdapter.showRename(Object), AbstractSystemViewAdapter.canRename(Object)

getNameValidator

public ISystemValidator getNameValidator(Object element)

Return a validator for verifying the new name is correct.

Specified by:

getNameValidator in interface ISystemViewElementAdapter

Overrides:

getNameValidator in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canRename(Object)

getCanonicalNewName

public String getCanonicalNewName(Object element,
                                  String newName)

Parent override.

Form and return a new canonical (unique) name for this object, given a candidate for the new name. This is called by the generic multi-rename dialog to test that all new names are unique. To do this right, sometimes more than the raw name itself is required to do uniqueness checking.

Returns mgrName.poolName.filterName, upperCased

Specified by:

getCanonicalNewName in interface ISystemViewElementAdapter

Overrides:

getCanonicalNewName in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canRename(Object)

showRefresh

public boolean showRefresh(Object element)

Description copied from interface: ISystemViewElementAdapter

Return true if we should show the refresh action in the popup for the given element.

Specified by:

showRefresh in interface ISystemViewElementAdapter

Overrides:

showRefresh in class AbstractSystemViewAdapter

showOpenViewActions

public boolean showOpenViewActions(Object element)

Return true if we should show the refresh action in the popup for the given element.

Specified by:

showOpenViewActions in interface ISystemViewElementAdapter

Overrides:

showOpenViewActions in class AbstractSystemViewAdapter

testAttribute

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

Overide of parent method.
From IActionFilter so the popupMenus extension point can use <filter>, <enablement> or <visibility>. We add support is for the following:

1. name="filterType". The value is tested against the non-translated filter type. Note all subsystems support different types of filters.
2. name="showChangeFilterStringsPropertyPage". The value is tested against the call to the subsystem factory method showChangeFilterStringsPropertyPage(SystemFilter). Compares against "true" (default) or "false".

Specified by:

testAttribute in interface IActionFilter

Overrides:

testAttribute in class AbstractSystemViewAdapter

See Also:

IActionFilter.testAttribute(Object, String, String)