You are currently viewing a snapshot of www.mozilla.org taken on April 21, 2008. Most of this content is highly out of date (some pages haven't been updated since the project began in 1998) and exists for historical purposes only. If there are any pages on this archive site that you think should be added back to www.mozilla.org, please file a bug.



All Packages  This Package  Class Hierarchy  Class Search  Index

Class grendel.integrator.Shell

java.lang.Object
   |
   +----grendel.integrator.Shell

public class  Shell
     extends java.lang.Object
     implements netscape.shell.IShellViewCtx
{
          // Fields 6
     Vector fChildren;
     DataHandler fDataHandler;
     IShellIntegrator fIntegrator;
     EventListenerList fListeners;
     IShellViewCtx fParent;
     StoreChangeListener fStoreChangeListener;

          // Constructors 1
     public Shell();

          // Methods 19
     public void addShellViewCtxListener(ShellViewCtxListener);
     public Enumeration children(int);
     public int compareIDs(IShellViewCtx, IShellViewCtx);
     public IShellView createView(Object);
     public int getAttributes();
     public int getChildCount(int);
     public IShellViewCtx[] getChildren(int);
     public DataHandler getDataHandler();
     public String getDisplayName();
     public Object getGlobalPreferences();
     public Image getIcon(int);
     public IShellViewCtx getParent();
     void initChildren();
     public void initialize(IShellIntegrator, IShellViewCtx);
     void notifyChange();
     public void removeShellViewCtxListener(ShellViewCtxListener);
     public void setDataHandler(DataHandler);
     public void setDisplayName(String);
     public void setParent(IShellViewCtx);

          // Inner Classes 1
     class StoreChangeListener
}



Fields


• fIntegrator

   IShellIntegrator fIntegrator


• fChildren

   Vector fChildren


• fParent

   IShellViewCtx fParent


• fListeners

   EventListenerList fListeners


• fDataHandler

   DataHandler fDataHandler


• fStoreChangeListener

   StoreChangeListener fStoreChangeListener



Constructors


• Shell

   public Shell() 

Default constructor




Methods


• initialize

   public void initialize(IShellIntegrator shell, 
                          IShellViewCtx aParent) 

Initializes this view e.g., the Integrator calls this first so you can identify the view.



• children

   public Enumeration children(int iFlags) 

Provides an enumeration for the subviews in this view.

Parameter Description
iFlags Flags determining which items to iclude in the enumeration

Returns:
An Enumeration for the view context's children

See Also: FOLDERS, NONFOLDERS, INCLUDEHIDDEN



• getChildren

   public IShellViewCtx[] getChildren(int iFlags) 

Provides an array of the view context's children

Parameter Description
iFlags Flags determining which items to iclude in the array

Returns:
An array of the view context's children

See Also: FOLDERS, NONFOLDERS, INCLUDEHIDDEN



• getChildCount

   public int getChildCount(int iFlags) 

Returns the number of children for the view context.

Parameter Description
iFlags Flags determining which items to iclude in the array

Returns:
the number of children for the view context

See Also: FOLDERS, NONFOLDERS, INCLUDEHIDDEN



• getParent

   public IShellViewCtx getParent() 

Returns the view context's direct parent view context.

Returns:
the view context's parent.


• setParent

   public void setParent(IShellViewCtx viewCtx) 

Sets the view context's parent.

Parameter Description
viewCtx the parent of this view context.



• compareIDs

   public int compareIDs(IShellViewCtx subview1, 
                         IShellViewCtx subview2) 

Compares two subviews.

Parameter Description
subview1 identifies the first subview to compare
subview2 identifies the second subview to compare

Returns:
Less than zero - The first subview should precede the second Greater than zero - The first subview should follow the second Zero - The two subviews are the same


• createView

   public IShellView createView(Object aObject) 

Creates an IShellView object. Note the object created must be different than this view i.e., different references, because the Integrator may instruct this view to create more than one independent view.

Returns:
an IShellView object representing this view


• getGlobalPreferences

   public Object getGlobalPreferences() 

Returns the view's preferences that display in the shell's shared preference window.

Returns:
an object specifying property information for the view's preferences. Note the property information is found via introspection.

See Also: BeanInfo



• getAttributes

   public int getAttributes() 

Returns attributes of this view.

Returns:
one or more flags describing the specified subview's attributes

See Also: CANCOPY, CANDELETE, CANMOVE, CANRENAME, READONLY, HASSUBFOLDER, FOLDER



• getIcon

   public Image getIcon(int iTypeFlags) 

Supplies an icon for this view

Parameter Description
iTypeFlags one or more flags specifying the requested icon's type

Returns:
an icon for the subview

See Also: ICON_COLOR_16x16, ICON_MONO_16x16, ICON_COLOR_32x32, ICON_MONO_32x32, OPEN



• getDisplayName

   public String getDisplayName() 

Returns a human readable name for this view

Returns:
a string representation of this view


• setDisplayName

   public void setDisplayName(String name) 

Sets the display name for the specified subview

Parameter Description
name the new display name for this view



• addShellViewCtxListener

   public void addShellViewCtxListener(ShellViewCtxListener l) 

Adds a change listener for monitoring changes on the ctx. e.g., the view ctx child state may have changed.



• removeShellViewCtxListener

   public void removeShellViewCtxListener(ShellViewCtxListener l) 

Removes a change listener for monitoring changes on the ctx.



• setDataHandler

   public void setDataHandler(DataHandler aHandler) 


• getDataHandler

   public DataHandler getDataHandler() 


• initChildren

   void initChildren() 


• notifyChange

   void notifyChange() 


All Packages  This Package  Class Hierarchy  Class Search  Index
Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.4