com.novell.application.console.snapin.scope
Class NamespaceTreeObjectsScope

java.lang.Object
  |
  +--com.novell.application.console.snapin.scope.NamespaceTreeObjectsScope

All Implemented Interfaces:

Scope, java.io.Serializable

public class NamespaceTreeObjectsScope

extends java.lang.Object

implements Scope

Defines a scope that is restricted to tree objects the namespace specified at registration.

View and Dynamic snap-ins may be registered with the NamespaceTreeObjectsScope scope. When registered, the functionality provided by these snap-ins becomes active when a tree object in the namespace specified at registration is selected (highlighed) by the user.

The following code snippet is an example of registering a view snap-in to the specified namespace with the NamespaceTreeObjectsScope.

      public RegistrationItem[] getRegistration()
      {
          NamespaceTreeObjectsScope scope;
          scope = new NamespaceTreeObjectsScope(Shell.SNAPIN_VIEW,
                                         "Namespace UniqueID");
          return new RegistrationItem[]
          {
              new RegistrationItem(scope, getClass().getName())
          };
      }
 

See Also:

Scope

Constructor Summary

NamespaceTreeObjectsScope(java.lang.Object snapinType, java.lang.String namespace)
Builds a NamespaceTreeObjectsScope for the specified snapinType, but restricted to a tree objects in the namespace specified at registration.

Method Summary

java.lang.String	getNamespaceUniqueID() Returns the namespace unique ID for this scope instance.
java.lang.Object	getSnapinType() Returns the snap-in type object that was passed in the constructor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NamespaceTreeObjectsScope

public NamespaceTreeObjectsScope(java.lang.Object snapinType,
                                 java.lang.String namespace)

Builds a NamespaceTreeObjectsScope for the specified snapinType, but restricted to a tree objects in the namespace specified at registration.

The snap-in types that can be used for the NamespaceTreeObjectsScope are:

• Shell.SNAPIN_DYNAMIC
• Shell.SNAPIN_RESULTMODIFIER
• Shell.SNAPIN_VIEW

Parameters:

snapinType - The type of the snap-in as defined above.

namespace - The uniqueID string for which the namespace applies.

Method Detail

getSnapinType

public java.lang.Object getSnapinType()

Returns the snap-in type object that was passed in the constructor.

Specified by:

getSnapinType in interface Scope

See Also:

Scope

getNamespaceUniqueID

public java.lang.String getNamespaceUniqueID()

Returns the namespace unique ID for this scope instance.

Returns:

The namespace unique ID.