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

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

All Implemented Interfaces:

Scope, java.io.Serializable

public class NamespaceViewScope

extends java.lang.Object

implements Scope

Defines a scope that is restricted to a view in the namespace specified at registration.

Menu, Toolbar, Status Bar and Popup Menu snap-ins may be registered with the NamespaceViewScope scope. When registered, the functionality provided by these snap-ins becomes active when a view in the namespace specified at registration is selected by the user.

The following code snippet is an example of registering a toolbar item snap-in to the specified view and namespace with the NamespaceViewScope scope.

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

See Also:

Scope

Constructor Summary

NamespaceViewScope(java.lang.Object snapinType, java.lang.String namespace, java.lang.String viewUniqueID)
Builds a NamespaceViewScope for the specified snapinType, but restricted to the specified view uniqueID 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.
java.lang.String	getViewUniqueID() Returns the view unique ID for this scope instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamespaceViewScope

public NamespaceViewScope(java.lang.Object snapinType,
                          java.lang.String namespace,
                          java.lang.String viewUniqueID)

Builds a NamespaceViewScope for the specified snapinType, but restricted to the specified view uniqueID in the namespace specified at registration.

• Shell.SNAPIN_DYNAMIC
• Shell.SNAPIN_MENU
• Shell.SNAPIN_POPUP_MENU
• Shell.SNAPIN_RESULTMODIFIER
• Shell.SNAPIN_STATUSBARITEM
• Shell.SNAPIN_TOOLBARITEM

Parameters:

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

namespace - The uniqueID string for which the namespace applies.

viewUniqueID - The uniqueID string for which the view 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

Returns:

The snap-in type object.

See Also:

Scope

getNamespaceUniqueID

public java.lang.String getNamespaceUniqueID()

Returns the namespace unique ID for this scope instance.

Returns:

The namespace unique ID.

getViewUniqueID

public java.lang.String getViewUniqueID()

Returns the view unique ID for this scope instance.

Returns:

The view unique ID.