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

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

public class ToolBarSnapinContext

extends SnapinContext

Contains an ObjectEntryCollection from one or more namespaces.

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

The ToolBarSnapinContext object is passed to the ToolBarSnapin on initialization through the InitSnapinInfo parameter to the initSnapin() method. The ToolBarSnapinContext can be retrieved from the InitSnapinInfo parameter with a call to the getSnapinContext() method.

See Also:

SnapinContext, ToolBarSnapin

Field Summary

static int	NO_SEPARATOR Definitions used to set the button separator state for the context.
static int	SEPARATOR_ON_LEFT SEPARATOR_ON_LEFT is used to tell the shell that a separator is wanted on the left side of this instance's toolbar button
static int	SEPARATOR_ON_RIGHT SEPARATOR_ON_RIGHT is used to tell the shell that a separator is wanted on the right side of this instance's toolbar button.

Method Summary

int	getButtonSeparator() Retrieves the separatorToButton state from the context.
ObjectEntryCollection	getObjectCollection() Retrieves the ObjectEntryCollection from the context.
void	setButtonSeparator(int state) Sets the separatorToButton state in the context.

Methods inherited from class java.lang.Object

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

Field Detail

NO_SEPARATOR

public static final int NO_SEPARATOR

Definitions used to set the button separator state for the context. Each button instance can specify whether a separator is desired for the left, right, or both sides of a toolbar button. SEPARATOR_ON_LEFT and SEPARATOR_ON_RIGHT can be ORed together causing a separator to be place on both sides of the toolbar button. The shell still attempts to place a separator after each set of toolbar buttons and gaurantees that there cannot be two separators placed between buttons.

SEPARATOR_ON_LEFT

public static final int SEPARATOR_ON_LEFT

SEPARATOR_ON_LEFT is used to tell the shell that a separator is wanted on the left side of this instance's toolbar button

SEPARATOR_ON_RIGHT

public static final int SEPARATOR_ON_RIGHT

SEPARATOR_ON_RIGHT is used to tell the shell that a separator is wanted on the right side of this instance's toolbar button.

Method Detail

getObjectCollection

public ObjectEntryCollection getObjectCollection()

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

Returns:

The ObjectEntryCollection associated with the ToolBarSnapinContext.

setButtonSeparator

public void setButtonSeparator(int state)

Sets the separatorToButton state in the context. The static values above are used to set the state of the button addition to the toolbar.

getButtonSeparator

public int getButtonSeparator()

Retrieves the separatorToButton state from the context.

Returns:

The tollbar separator state associated with the ToolBarSnapinContext