com.novell.application.console.snapin

Class InitSnapinInfo

java.lang.Object

com.novell.application.console.snapin.InitSnapinInfo

public class InitSnapinInfo
extends java.lang.Object

Provides references to the shell, snap-in types and snap-in context.

The InitSnapinInfo reference is passed to the initSnapin() method of the Snapin interface. The InitSnapinInfo object contains information that a snap-in may need when it initializes.

See Also:

Snapin.initSnapin(InitSnapinInfo)

Field Summary

Fields

Modifier and Type	Field and Description
protected com.novell.application.console.snapin.context.SnapinContext	context
boolean	exportMapping
protected Shell	shell
protected java.lang.Object	snapinType
protected boolean	track

Constructor Summary

Constructors

Constructor and Description
InitSnapinInfo(Shell shell, java.lang.Object snapinType) Creates a new InitSnapinInfo object with references to the shell and the snap-in type.
InitSnapinInfo(Shell shell, java.lang.Object snapinType, com.novell.application.console.snapin.context.SnapinContext context) Creates a new InitSnapinInfo object with references to the shell, the snap-in type, and the snap-in context.

Method Summary

Modifier and Type	Method and Description
Shell	getShell() Returns a reference to the ConsoleOne shell.
com.novell.application.console.snapin.context.SnapinContext	getSnapinContext() Returns a reference to the snap-in context of the participating snap-in.
java.lang.Object	getSnapinType() Returns a reference to the snap-in type of the participating snap-in.
boolean	getTracking()
void	setTracking(boolean track)

Methods inherited from class java.lang.Object

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

Field Detail

shell

protected Shell shell

snapinType

protected java.lang.Object snapinType

context

protected com.novell.application.console.snapin.context.SnapinContext context

track

protected boolean track

exportMapping

public boolean exportMapping

Constructor Detail

InitSnapinInfo

public InitSnapinInfo(Shell shell,
                      java.lang.Object snapinType)

Creates a new InitSnapinInfo object with references to the shell and the snap-in type.

The shell and snap-in type references are required.

Parameters:

shell - The reference to the shell that snap-ins can use to interact with the ConsoleOne shell.

snapinType - The reference to the type of the participating snap-in.

InitSnapinInfo

public InitSnapinInfo(Shell shell,
                      java.lang.Object snapinType,
                      com.novell.application.console.snapin.context.SnapinContext context)

Creates a new InitSnapinInfo object with references to the shell, the snap-in type, and the snap-in context.

Parameters:

shell - The reference to the shell that snap-ins can use to interact with the ConsoleOne shell.

snapinType - The reference to the type of the participating snap-in.

context - The reference to the snap-in context.

Method Detail

getShell

public Shell getShell()

Returns a reference to the ConsoleOne shell.

This reference can be used by snap-ins to interact with the shell.

Returns:

The reference to the shell.

getSnapinType

public java.lang.Object getSnapinType()

Returns a reference to the snap-in type of the participating snap-in.

This snapinType can be used when a snap-in implements more than one type; for example:

     Shell.SNAPIN.VIEW
 

Returns:

The reference to the snap-in type.

getSnapinContext

public com.novell.application.console.snapin.context.SnapinContext getSnapinContext()

Returns a reference to the snap-in context of the participating snap-in.

The snap-in context is dependent upon the snap-in type. For a particular snap-in type you need to cast the return to the correct SnapinContext. For some snap-in types there is no defined snap-in context, therefore a null can be returned.

Returns:

The reference to the snap-in context, or null if there is no snap-in context for the associated snap-in type.

See Also:

SnapinContext

setTracking

public void setTracking(boolean track)

Parameters:

track - A boolean flag indicating the status of the initSnapin() registry call.

getTracking

public boolean getTracking()

Returns:

A boolean set to true when the initSnapin() method will be called by the registry, otherwise false is returned.