com.novell.application.console.snapin.context
Class PageSnapinContext

java.lang.Object
  |
  +--com.novell.application.console.snapin.context.SnapinContext
        |
        +--com.novell.application.console.snapin.context.PageSnapinContext

public class PageSnapinContext

extends SnapinContext

Contains an ObjectEntryCollection from one or more namespaces, and a reference to a PropertyBook.

The ObjectEntryCollection may represent objects selected by the user from a Browser or View window when a PropertyBook was invoked, or it may have been generated programmatically by another snap-in.

A PageSnapinContext object is used by a PageSnapin to determine which ObjectEntries are to have their properties edited. This object is passed to the PageSnapin on initialization through the InitSnapinInfo parameter to the initSnapin() method. The PageSnapinContext can be retrieved from the InitSnapinInfo parameter with a call to the getSnapinContext() method.

The PropertyBook manages a set of registered PageSnapins, which control property values for the specified ObjectEntries.

See Also:

SnapinContext, PageSnapin, PropertyBook

Method Summary

ObjectEntryCollection	getObjectCollection() Retrieves the ObjectEntryCollection from the context.
java.awt.Window	getParentWindow() Retrieves the parent window on which the gui component will be placed from the context.
PropertyBook	getPropertyBook() Retrieves the reference to the PropertyBook from the context.

Methods inherited from class java.lang.Object

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

Method Detail

getPropertyBook

public PropertyBook getPropertyBook()

Retrieves the reference to the PropertyBook from the context.

Using this reference, the set of registered PageSnapin(s) can tell the PropertyBook when attribute values have changed so the appropriate PropertyBook buttons (OK, CANCEL, APPLY, CLOSE) can be enabled or disabled.

Returns:

The PropertyBook, associated with the PageSnapinContext, in which the property pages will be displayed.

getObjectCollection

public ObjectEntryCollection getObjectCollection()

Retrieves the ObjectEntryCollection from the context. This collection provides enumerations of ObjectEntrys associated with the page snapin.

Returns:

The ObjectEntryCollection associated with the PageSnapinContext.

getParentWindow

public java.awt.Window getParentWindow()

Retrieves the parent window on which the gui component will be placed from the context.

Returns:

The parent window associated with the PageSnapinContext.