org.eclipse.rse.ui.view.team
Class SystemTeamViewProfileAdapter

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

All Implemented Interfaces:

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

public class SystemTeamViewProfileAdapter

extends AbstractSystemViewAdapter

implements ISystemViewElementAdapter, ISystemUserIdConstants

Adapter for displaying and processing SystemProfile objects in tree views, such as the Team view.

Field Summary

protected SystemTeamViewActiveProfileAction	activeProfileAction
protected SystemProfileNameCopyAction	copyProfileAction
protected SystemCommonDeleteAction	deleteAction
protected SystemTeamViewMakeActiveProfileAction	makeProfileActiveAction
protected SystemTeamViewMakeInActiveProfileAction	makeProfileInactiveAction
protected SystemCommonRenameAction	renameAction

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.core.ISystemUserIdConstants

USERID_LOCATION_CONNECTION, USERID_LOCATION_DEFAULT_OVERALL, USERID_LOCATION_DEFAULT_SYSTEMTYPE, USERID_LOCATION_NOTSET, USERID_LOCATION_SUBSYSTEM

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

SystemTeamViewProfileAdapter()

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 element.
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 newName) 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.
SystemTeamViewCategoryNode[]	getCategoryChildren(ISystemProfile profile) Given a profile, return all the category children for it.
Object[]	getChildren(Object element) Return the children of this profile.
ImageDescriptor	getImageDescriptor(Object element) Returns an image descriptor for the image.
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)}.
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	getStatusLineText(Object element) Return the string to display in the status line when the given object is selected.
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 profile has children.
protected IPropertyDescriptor[]	internalGetPropertyDescriptors() Return our unique property descriptors, which getPropertyDescriptors adds to the common properties.
Object	internalGetPropertyValue(Object key) Returns the current value for the named property.
SystemTeamViewCategoryNode	restoreCategory(ISystemProfile profile, String mementoHandle) Given a profile and memento handle, return the appropriate category node.

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, getPropertyDescriptors, getPropertyValue, getPropertyValue, getRemoteAdapter, getRemoteSourceType, getRemoteSubSubType, getRule, getShell, 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, showDelete, showGenericShowInTableAction, showOpenViewActions, showRefresh, showRename, sub, supportsDeferredQueries, testAttribute, 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, getPropertyValue, getShell, getSubSystem, getUniquePropertyDescriptors, getViewer, handleDoubleClick, isPromptable, namesAreEqual, saveExpansionState, selectionChanged, setFilterString, setInput, setPropertySourceInput, setShell, setViewer, showDelete, showGenericShowInTableAction, showOpenViewActions, showRefresh, showRename, 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

Methods inherited from interface org.eclipse.ui.IActionFilter

testAttribute

Field Detail

activeProfileAction

protected SystemTeamViewActiveProfileAction activeProfileAction

makeProfileActiveAction

protected SystemTeamViewMakeActiveProfileAction makeProfileActiveAction

makeProfileInactiveAction

protected SystemTeamViewMakeInActiveProfileAction makeProfileInactiveAction

renameAction

protected SystemCommonRenameAction renameAction

deleteAction

protected SystemCommonDeleteAction deleteAction

copyProfileAction

protected SystemProfileNameCopyAction copyProfileAction

Constructor Detail

SystemTeamViewProfileAdapter

public SystemTeamViewProfileAdapter()

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 element.

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

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

getStatusLineText

public String getStatusLineText(Object element)

Return the string to display in the status line when the given object is selected. We return: Connection: name - Host name: hostName - Description: description

Specified by:

getStatusLineText in interface ISystemViewElementAdapter

Overrides:

getStatusLineText in class AbstractSystemViewAdapter

getParent

public Object getParent(Object element)

Return the parent of this object. We return the RemoteSystemsConnections project

Specified by:

getParent in interface ISystemViewElementAdapter

Specified by:

getParent in class AbstractSystemViewAdapter

getChildren

public Object[] getChildren(Object element)

Return the children of this profile.

Specified by:

getChildren in interface ISystemViewElementAdapter

Specified by:

getChildren in class AbstractSystemViewAdapter

getCategoryChildren

public SystemTeamViewCategoryNode[] getCategoryChildren(ISystemProfile profile)

Given a profile, return all the category children for it. If this child objects have yet to be created, create them now.

restoreCategory

public SystemTeamViewCategoryNode restoreCategory(ISystemProfile profile,
                                                  String mementoHandle)

Given a profile and memento handle, return the appropriate category node. This is used when restoring the expansion and selection state of the team view.

hasChildren

public boolean hasChildren(Object element)

Return true if this profile has children. We return true.

Specified by:

hasChildren in interface ISystemViewElementAdapter

Specified by:

hasChildren in class AbstractSystemViewAdapter

internalGetPropertyDescriptors

protected IPropertyDescriptor[] internalGetPropertyDescriptors()

Return our unique property descriptors, which getPropertyDescriptors adds to the common properties.

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

public Object internalGetPropertyValue(Object key)

Returns the current value for the named property. 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

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)

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 newName)
                 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 profile.connectionName, upperCased

Specified by:

getCanonicalNewName in interface ISystemViewElementAdapter

Overrides:

getCanonicalNewName in class AbstractSystemViewAdapter

See Also:

AbstractSystemViewAdapter.canRename(Object)

getMementoHandle

public String getMementoHandle(Object element)

Return what to save to disk to identify this element in the persisted list of expanded elements.

Specified by:

getMementoHandle in interface ISystemViewElementAdapter

Overrides:

getMementoHandle in class AbstractSystemViewAdapter

getMementoHandleKey

public String getMementoHandleKey(Object element)

Return a short string to uniquely identify the type of resource.

Specified by:

getMementoHandleKey in interface ISystemViewElementAdapter

Overrides:

getMementoHandleKey in class AbstractSystemViewAdapter