* To put your action into the given menu, use the menu's {@link org.eclipse.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, @@ -397,19 +418,19 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda *
* getType(): getName() *@@ -473,14 +494,14 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda { return getType(element) + ": " + getName(element); //$NON-NLS-1$ } - + /** * Returns whether the specified element is represented as existing. Note that * it's possible that the represented element will been seen to exist when on * a remote host it may not - that is because this call does not query the host. * By default, this method returns true - override this method to customize the * behavior - * + * * @param element the element to check * @return true if the element exists * @@ -489,8 +510,8 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda { return true; } - - + + /** * Abstract. Must be overridden by subclasses.
* If internalGetPropertyDescriptors() returns non-null, then returns that, - * else computes the difference. + * else computes the difference. *
- * This is called by the table views like {@link org.eclipse.rse.ui.view.SystemTableView}. + * This is called by the table views like + * {@link org.eclipse.rse.ui.view.SystemTableView}. + *
+ * + * @noextend This method is not intended to be extended by clients. */ public IPropertyDescriptor[] getUniquePropertyDescriptors() { @@ -683,21 +708,21 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda IPropertyDescriptor[] internalDescriptors = internalGetPropertyDescriptors(); if (internalDescriptors != null) return internalDescriptors; - + IPropertyDescriptor[] allDescriptors = getPropertyDescriptors(); IPropertyDescriptor[] commonDescriptors = getDefaultDescriptors(); - + int totalSize = allDescriptors.length; int commonSize = commonDescriptors.length; int uniqueSize = totalSize - commonSize; - + int uniqueIndex = 0; - + IPropertyDescriptor[] uniqueDescriptors = new IPropertyDescriptor[uniqueSize]; for (int i = 0; i < totalSize; i++) { IPropertyDescriptor descriptor = allDescriptors[i]; - + boolean isUnique = true; for (int j = 0; j < commonSize; j++) { @@ -705,19 +730,19 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda if (descriptor == commonDescriptor) { isUnique = false; - } - } - + } + } + if (isUnique && uniqueSize > uniqueIndex) { uniqueDescriptors[uniqueIndex] = descriptor; - uniqueIndex++; + uniqueIndex++; } } - + return uniqueDescriptors; } - + /** * Overridable by subclasses, but usually is not.propertySourceInput, which is the currently selected object. Just case it to what you expect the selected object's type to be.
- *
+ *
* @param key the name of the property as named by its property descriptor
* @return the current value of the property
*/
- public Object getPropertyValue(Object key)
+ public Object getPropertyValue(Object key)
{
String name = (String)key;
if (name.equals(IBasicPropertyConstants.P_TEXT))
@@ -760,7 +785,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
{
ISystemTree tree = getSystemTree();
if (tree != null)
- return Integer.toString(tree.getChildCount(propertySourceInput));
+ return Integer.toString(tree.getChildCount(propertySourceInput));
else
{
if ((viewer != null) && (viewer instanceof TreeViewer))
@@ -770,31 +795,31 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
}
}
else
- return internalGetPropertyValue(key);
+ return internalGetPropertyValue(key);
}
/**
* Abstract.true if the value of the specified property has changed
* from its original default value; false otherwise.
*/
- public boolean isPropertySet(Object key)
+ public boolean isPropertySet(Object key)
{
return false;
}
@@ -871,50 +896,52 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
* Resets the specified property's value to its default value.
* Called on editable property when user presses reset button in property sheet viewer.
* DOES NOTHING BY DEFAULT.
- *
+ *
* @param key the key identifying property to reset
*/
- public void resetPropertyValue(Object key)
+ public void resetPropertyValue(Object key)
{
}
/**
* Overridable by subclasses. Must be iff editable properties are supported.* Used in the common rename dialogs, and only if you return true to {@link #canRename(Object)}. *
@@ -1033,7 +1065,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
public ISystemValidator getNameValidator(Object element)
{
return null;
- }
+ }
/**
* Overridable by subclasses, and usually is iff canRename is.
@@ -1042,12 +1074,12 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
* To do this right, sometimes more than the raw name itself is required to do uniqueness checking.
*
* For example, two connections or filter pools can have the same name if they are - * in different profiles. Two iSeries QSYS objects can have the same name if their object types - * are different. + * in different profiles. Two iSeries QSYS objects can have the same name if their object types + * are different. *
* Used in the common rename dialogs, and only if you return true to {@link #canRename(Object)}. *
- * This method returns a name that can be used for uniqueness checking because it is qualified + * This method returns a name that can be used for uniqueness checking because it is qualified * sufficiently to make it unique. *
* By default, this simply returns the given name. It is overridden by child classes when appropriate.
@@ -1086,7 +1118,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
public boolean showRefresh(Object element)
{
return true;
- }
+ }
// ----------------------------------------------
// METHODS TO SUPPORT COMMON PROPERTIES ACTION...
@@ -1101,7 +1133,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
public boolean showProperties(Object element)
{
return true;
- }
+ }
// ------------------------------------------------------------
@@ -1109,7 +1141,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
// ------------------------------------------------------------
/**
* Overridable by subclasses, and usually is NOT.
- * Return true if we should show the Go Into; and Open In New Window
+ * 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.
*
* Only applicable for non-remote resources. Remote always show Go To only.
@@ -1119,21 +1151,21 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
if (element instanceof IAdaptable)
return hasChildren((IAdaptable)element);
return false;
- }
-
+ }
+
/**
* Overridable by subclasses, and usually is NOT.
* Return true if we should show the generic show in table action in the popup for the given element.
*/
public boolean showGenericShowInTableAction(Object element)
{
- return true;
+ return true;
}
-
+
// ------------------------------------------
// METHODS TO SUPPORT COMMON DRAG AND DROP FUNCTION...
- // ------------------------------------------
+ // ------------------------------------------
/**
* Overridable by subclasses, and is iff drag and drop supported.
* Return true if this object can be copied to another location. By default,
@@ -1148,7 +1180,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
{
return false;
}
-
+
/**
* Overridable by subclasses, and is iff drag and drop supported.
* Return true if this object can be copied to another location. By default,
@@ -1160,12 +1192,12 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
{
return false;
}
-
+
/**
* Overridable by subclasses, and is iff drag and drop supported.
* Perform the drag on the given object. By default this does nothing
* and returns nothing. Extenders supporting DnD are expected to implement
- * this method to perform a copy to a temporary object, the return value.
+ * this method to perform a copy to a temporary object, the return value.
* @see #canDrag(Object)
* @see #canDrop(Object)
* @see #doDrop(Object,Object,boolean,boolean,IProgressMonitor)
@@ -1173,13 +1205,13 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
*/
public Object doDrag(Object element, boolean sameSystemType, IProgressMonitor monitor)
{
- return null;
+ return null;
}
-
+
/**
* Overridable by subclasses, and is iff drag and drop supported.
* Return true if another object can be copied into this object. By default
- * we return false. Extenders may decide whether or not certain objects can
+ * we return false. Extenders may decide whether or not certain objects can
* accept other objects with this method.
* @see #canDrag(Object)
* @see #doDrag(Object,boolean,IProgressMonitor)
@@ -1188,19 +1220,19 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
*/
public boolean canDrop(Object element)
{
- return false;
-
+ return false;
+
}
-
+
/**
* Overridable by subclasses, and is iff drag and drop supported.
* Perform the drag on the given objects. This default implementation simply iterates through the
* set. For optimal performance, this should be overridden.
- *
+ *
* @param set the set of objects to copy
* @param monitor the progress monitor
* @return the set of objects as a result of the drag
- *
+ *
*/
public ISystemResourceSet doDrag(SystemRemoteResourceSet set, IProgressMonitor monitor)
{
@@ -1222,80 +1254,80 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
* @param sameSystem indication of whether the source and target are on the same system
* @param srcType the type of objects to be dropped
* @param monitor the progress monitor
- *
+ *
* @return the set of new objects created from the drop
- *
- */
+ *
+ */
public ISystemResourceSet doDrop(ISystemResourceSet fromSet, Object to, boolean sameSystemType, boolean sameSystem, int srcType, IProgressMonitor monitor)
{
SystemRemoteResourceSet results = new SystemRemoteResourceSet(getSubSystem(to), this);
-
+
List resources = fromSet.getResourceSet();
for (int i = 0; i < resources.size(); i++)
{
results.addResource(doDrop(resources.get(i), to, sameSystemType, sameSystem, srcType, monitor));
}
-
+
return results;
}
-
+
/**
- * Sets filter context for querying. Override to provide specialized
+ * Sets filter context for querying. Override to provide specialized
* behaviour.
*/
public void setFilterString(String filterString)
{
this.filterString = filterString;
}
-
+
/**
- * Gets filter context for querying. Override to provide specialized
+ * Gets filter context for querying. Override to provide specialized
* behaviour.
*/
public String getFilterString()
{
return filterString;
}
-
+
/**
* Overridable by subclasses, and is iff drag and drop supported.
- * Perform drop from the "from" object to the "to" object. By default this does
+ * Perform drop from the "from" object to the "to" object. By default this does
* nothing and we return false. Extenders supporting DnD are expected to implement
- * this method to perform a "paste" into an object.
- *
+ * this method to perform a "paste" into an object.
+ *
* @return the new object that was copied
- *
+ *
* @see #canDrag(Object)
* @see #doDrag(Object,boolean,IProgressMonitor)
* @see #canDrop(Object)
* @see #validateDrop(Object,Object,boolean)
- */
+ */
public Object doDrop(Object from, Object to, boolean sameSystemType, boolean sameSystem, int srcType, IProgressMonitor monitor)
{
// for backward compatability
return doDrop(from, to, sameSystemType, sameSystem, monitor);
}
-
+
/**
* Overridable by subclasses, and is iff drag and drop supported.
- * Perform drop from the "from" object to the "to" object. By default this does
+ * Perform drop from the "from" object to the "to" object. By default this does
* nothing and we return false. Extenders supporting DnD are expected to implement
- * this method to perform a "paste" into an object.
- *
+ * this method to perform a "paste" into an object.
+ *
* @return the new object that was copied
- *
+ *
* @see #canDrag(Object)
* @see #doDrag(Object,boolean,IProgressMonitor)
* @see #canDrop(Object)
* @see #validateDrop(Object,Object,boolean)
- *
+ *
* @deprecated use doDrop(Object from, Object to, boolean sameSystemType, boolean sameSystem, int srcType, IProgressMonitor monitor) instead
- */
+ */
public Object doDrop(Object from, Object to, boolean sameSystemType, boolean sameSystem, IProgressMonitor monitor)
{
- return null;
+ return null;
}
-
+
/**
* Overridable by subclasses, and usually is iff drag and drop supported..
* Return true if it is valid for the src object to be dropped in the target. We return false by default.
@@ -1303,17 +1335,17 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
* @param target the object which src is dropped in
* @param sameSystem whether this is the same system or not
* @return whether this is a valid operation
- *
+ *
* @see #canDrag(Object)
* @see #doDrag(Object,boolean,IProgressMonitor)
* @see #canDrop(Object)
* @see #doDrop(Object,Object,boolean,boolean,IProgressMonitor)
- */
+ */
public boolean validateDrop(Object src, Object target, boolean sameSystem)
{
- return false;
+ return false;
}
-
+
public boolean validateDrop(ISystemResourceSet set, Object target, boolean sameSystem)
{
boolean valid = true;
@@ -1365,14 +1397,14 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
/**
* Overridable by subclasses, but usually is not.
- * Somtimes we don't want to remember an element's expansion state, such as for temporarily inserted
+ * Somtimes we don't want to remember an element's expansion state, such as for temporarily inserted
* messages. In these cases return false from this method. The default is true
*/
public boolean saveExpansionState(Object element)
{
return true;
}
-
+
/**
* Overridable by subclasses, but usually is not.
* Return true if this object is a "prompting" object that prompts the user when expanded.
@@ -1384,8 +1416,8 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
public boolean isPromptable(Object element)
{
return (element instanceof ISystemPromptableObject);
- }
-
+ }
+
/**
* Overridable by subclasses, but usually is not.
* Return true if this object is remote. In this case, the default is true.
@@ -1394,7 +1426,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
{
return true;
}
-
+
/**
* Overridable by subclasses, but usually is not.
* Selection has changed in the Remote Systems view. Empty by default, but override if you need
@@ -1402,7 +1434,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
* selection.
* @param element - first selected object
*/
- public void selectionChanged(Object element) // d40615
+ public void selectionChanged(Object element) // d40615
{
}
@@ -1417,11 +1449,11 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
* returns true if the hasChildren returns false.
*
* If desired, override, and call super(), to support additional filter criteria for <filter>, <enablement> and <visibility>.
- *
+ *
* @see org.eclipse.ui.IActionFilter#testAttribute(Object, String, String)
*/
public boolean testAttribute(Object target, String name, String value)
@@ -1443,7 +1475,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
// we have a wild card test, and * is the last character in the value
if (getName(target).startsWith(value.substring(0, value.length() - 1)))
return true;
- }
+ }
else
return value.equals(getName(target));
}
@@ -1460,14 +1492,14 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
return ss.isConnected() ? value.equals("true") : value.equals("false"); //$NON-NLS-1$ //$NON-NLS-2$
else
return false;
- }
+ }
else if (name.equalsIgnoreCase("offline")) //$NON-NLS-1$
- {
+ {
ISubSystem ss = getSubSystem(target);
if (ss != null)
return ss.isOffline() ? value.equals("true") : value.equals("false"); //$NON-NLS-1$ //$NON-NLS-2$
else
- return false;
+ return false;
}
else if (name.equalsIgnoreCase("systemType")) //$NON-NLS-1$
{
@@ -1476,16 +1508,16 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
if (ss == null)
{
if (!(target instanceof IHost))
- return false;
- String connSysType = ((IHost)target).getSystemType().getName();
- for (int idx=0; idx
true if an "Empty List" message should be returned.
- * @return The list of children, a list with the "Empty List" message object or an empty list.
+ * @param returnNullMsg true if an "Empty List" message
+ * should be returned.
+ * @return The list of children, a list with the "Empty List" message object
+ * or an empty list.
+ * @noextend This method is not intended to be extended by clients.
*/
protected Object[] checkForEmptyList(Object[] children, Object parent, boolean returnNullMsg) {
if ((children == null) || (children.length == 0)) {
@@ -1874,7 +1924,7 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
return new Object[] {
new SystemMessageObject(
RSEUIPlugin.getPluginMessage(ISystemMessages.MSG_EXPAND_EMPTY),
- ISystemMessageObject.MSGTYPE_EMPTY,
+ ISystemMessageObject.MSGTYPE_EMPTY,
parent)};
}
}
@@ -1882,13 +1932,16 @@ public abstract class AbstractSystemViewAdapter implements ISystemViewElementAda
}
/**
- * Callable by subclasses. Do not overridetrue if an "Empty List" message should be returned.
- * @return The list of children, a list with the "Empty List" message object or an empty list.
- */
+ * Callable by subclasses. Do not override.true if an "Empty List" message
+ * should be returned.
+ * @return The list of children, a list with the "Empty List" message object
+ * or an empty list.
+ * @noextend This method is not intended to be extended by clients.
+ */
protected Object[] checkForEmptyList(Object[] children, Object parent, boolean returnNullMsg) {
if ((children == null) || (children.length == 0)) {
if (fPrefStore == null) {
@@ -123,18 +143,18 @@ public abstract class SystemAbstractAPIProvider
return new Object[] {
new SystemMessageObject(
RSEUIPlugin.getPluginMessage(ISystemMessages.MSG_EXPAND_EMPTY),
- ISystemMessageObject.MSGTYPE_EMPTY,
+ ISystemMessageObject.MSGTYPE_EMPTY,
parent)};
}
}
return children;
}
-
+
/**
* In getChildren, return checkForNull(children, true/false) vs your array directly.
* This method checks for a null array which not allow and replaces it with an empty array.
* If true is passed then it returns the "Empty list" message object if the array is null or empty
- *
+ *
* @deprecated Use {@link #checkForEmptyList(Object[], Object, boolean)} instead.
*/
protected Object[] checkForNull(Object[] children, boolean returnNullMsg)
@@ -159,26 +179,26 @@ public abstract class SystemAbstractAPIProvider
* Return the "Operation cancelled by user" msg as an object array so can be used to answer getChildren()
*/
protected Object[] getCancelledMessageObject()
- {
- if (canceledObject == null)
+ {
+ if (cancelledObject == null)
initMsgObjects();
- msgList[0] = canceledObject;
+ msgList[0] = cancelledObject;
return msgList;
- }
+ }
/**
* Return the "Operation failed" msg as an object array so can be used to answer getChildren()
*/
protected Object[] getFailedMessageObject()
- {
+ {
if (errorObject == null)
initMsgObjects();
msgList[0] = errorObject;
return msgList;
- }
+ }
/**
- * Return true if we are listing connections or not, so we know whether we are interested in
+ * Return true if we are listing connections or not, so we know whether we are interested in
* connection-add events
*/
public boolean showingConnections()
@@ -188,22 +208,22 @@ public abstract class SystemAbstractAPIProvider
// ------------------
// HELPER METHODS...
- // ------------------
+ // ------------------
/**
* Returns the implementation of ISystemViewElement for the given
* object. Returns null if the adapter is not defined or the
* object is not adaptable.
*/
- protected ISystemViewElementAdapter getViewAdapter(Object o)
+ protected ISystemViewElementAdapter getViewAdapter(Object o)
{
return SystemAdapterHelpers.getViewAdapter(o);
}
-
+
/**
* Returns the implementation of ISystemRemoteElement for the given
* object. Returns null if this object does not adaptable to this.
*/
- protected ISystemRemoteElementAdapter getRemoteAdapter(Object o)
+ protected ISystemRemoteElementAdapter getRemoteAdapter(Object o)
{
return SystemAdapterHelpers.getRemoteAdapter(o);
}