OnLineUserSnapin.html
Warning: This file has been marked up for HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Feb 08 14:56:14 MST 2000 -->
<TITLE>
Chat Snapin Documentation: Class OnLineUserSnapin
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/novell/Chat/OnlineUsersDlg.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="OnLineUserSnapin.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.novell.Chat</FONT>
<BR>
Class OnLineUserSnapin</H2>
<PRE>
<B>com.novell.Chat.OnLineUserSnapin</B>
</PRE>
<HR>
<DL>
<DT>public class <B>OnLineUserSnapin</B></DL>
<P>
This class provides both a toolbar and menu snapin for Chat.
This button and menu item display the On-Line Chat Users dialog.
Since the purpose of the toolbar button and the menu item is
the same, they have both been included in this class as an
AbstractToolBarMenuSnapin.
<P>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#OnLineUserSnapin()">OnLineUserSnapin</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#execute()">execute</A></B>()</CODE>
<BR>
AbstractToolBarMenuSnapin implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> javax.swing.Icon</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#getIcon()">getIcon</A></B>()</CODE>
<BR>
Implementation of the AbstractToolBarMenuSnapin Class
Returns the icon to be displayed in the toolbar button.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#getMenuLocation()">getMenuLocation</A></B>()</CODE>
<BR>
AbstractToolBarMenuSnapin implementation</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#getMenuName()">getMenuName</A></B>()</CODE>
<BR>
Implementation of the AbstractToolBarMenuSnapin Class
Returns the language dependent translated menu
display name as a String to be placed in the menu item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#getSnapinDescription()">getSnapinDescription</A></B>()</CODE>
<BR>
Implementation of the Snapin Interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#getSnapinName()">getSnapinName</A></B>()</CODE>
<BR>
Implementation of the Snapin Interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#getToolTip()">getToolTip</A></B>()</CODE>
<BR>
Implementation of the AbstractToolBarMenuSnapin Class
Returns the localized string to be placed in the tool tip
that will be displayed with the toolbar item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#initAbstractSnapin(com.novell.Chat.InitSnapinInfo)">initAbstractSnapin</A></B>(com.novell.Chat.InitSnapinInfo info)</CODE>
<BR>
Implementation of the AbstractToolBarMenuSnapin Class
This method is called by the shell to allow each snap-in to perform
any necessary initialization; for example adding itself as an event
listener.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#shutdownAbstractSnapin()">shutdownAbstractSnapin</A></B>()</CODE>
<BR>
Implementation of the AbstractToolBarMenuSnapin Class
Called by the shell when the snap-in is being shut down.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/OnLineUserSnapin.html#snapinListener(com.novell.Chat.SnapinEvent)">snapinListener</A></B>(com.novell.Chat.SnapinEvent event)</CODE>
<BR>
Implementation of the SnapinListener Interface.</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="OnLineUserSnapin()"><!-- --></A><H3>
OnLineUserSnapin</H3>
<PRE>
public <B>OnLineUserSnapin</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getSnapinName()"><!-- --></A><H3>
getSnapinName</H3>
<PRE>
public java.lang.String <B>getSnapinName</B>()</PRE>
<DL>
<DD>Implementation of the Snapin Interface.<DD><DL>
<DT><B>Returns:</B><DD>The snapin's name.</DL>
</DD>
</DL>
<HR>
<A NAME="getSnapinDescription()"><!-- --></A><H3>
getSnapinDescription</H3>
<PRE>
public java.lang.String <B>getSnapinDescription</B>()</PRE>
<DL>
<DD>Implementation of the Snapin Interface.<DD><DL>
<DT><B>Returns:</B><DD>The snapin's description.</DL>
</DD>
</DL>
<HR>
<A NAME="initAbstractSnapin(com.novell.Chat.InitSnapinInfo)"><!-- --></A><H3>
initAbstractSnapin</H3>
<PRE>
public boolean <B>initAbstractSnapin</B>(com.novell.Chat.InitSnapinInfo info)</PRE>
<DL>
<DD>Implementation of the AbstractToolBarMenuSnapin Class
This method is called by the shell to allow each snap-in to perform
any necessary initialization; for example adding itself as an event
listener. The snap-in is initialized by passing a reference to the
InitSnapinInfo class. The getSnapinName() and getSnapinDescription()
methods will be called before initSnapin().<DD><DL>
<DT><B>Parameters:</B><DD><CODE>info</CODE> - Contains data the snap-in may use for initialization,
such as references to the shell and the snap-in type, and
may contain a reference to snap-in context data.<DT><B>Returns:</B><DD>If the snap-in is able to successfully complete initialization,
true is returned, or if initialization fails, false is returned
and the snap-in will be disabled.</DL>
</DD>
</DL>
<HR>
<A NAME="shutdownAbstractSnapin()"><!-- --></A><H3>
shutdownAbstractSnapin</H3>
<PRE>
public void <B>shutdownAbstractSnapin</B>()</PRE>
<DL>
<DD>Implementation of the AbstractToolBarMenuSnapin Class
Called by the shell when the snap-in is being shut down.
Called by the shell for each snap-in when it is no longer required.
This allows the snap-in to perform any necessary cleanup; for example
removing itself as an event listener.</DL>
<HR>
<A NAME="getIcon()"><!-- --></A><H3>
getIcon</H3>
<PRE>
public javax.swing.Icon <B>getIcon</B>()</PRE>
<DL>
<DD>Implementation of the AbstractToolBarMenuSnapin Class
Returns the icon to be displayed in the toolbar button.<DD><DL>
<DT><B>Returns:</B><DD>The toolbar Icon.</DL>
</DD>
</DL>
<HR>
<A NAME="getMenuName()"><!-- --></A><H3>
getMenuName</H3>
<PRE>
public java.lang.String <B>getMenuName</B>()</PRE>
<DL>
<DD>Implementation of the AbstractToolBarMenuSnapin Class
Returns the language dependent translated menu
display name as a String to be placed in the menu item.<DD><DL>
<DT><B>Returns:</B><DD>The Menu name.</DL>
</DD>
</DL>
<HR>
<A NAME="getToolTip()"><!-- --></A><H3>
getToolTip</H3>
<PRE>
public java.lang.String <B>getToolTip</B>()</PRE>
<DL>
<DD>Implementation of the AbstractToolBarMenuSnapin Class
Returns the localized string to be placed in the tool tip
that will be displayed with the toolbar item.<DD><DL>
<DT><B>Returns:</B><DD>The tool tip.</DL>
</DD>
</DL>
<HR>
<A NAME="getMenuLocation()"><!-- --></A><H3>
getMenuLocation</H3>
<PRE>
public java.lang.String <B>getMenuLocation</B>()</PRE>
<DL>
<DD>AbstractToolBarMenuSnapin implementation<DD><DL>
<DT><B>Returns:</B><DD>The menu under which this item will be listed.</DL>
</DD>
</DL>
<HR>
<A NAME="execute()"><!-- --></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>()</PRE>
<DL>
<DD>AbstractToolBarMenuSnapin implementation.
This is what is called when our menu item or toolbar button
is selected. The same thing will happen regardless of
whether a menu item is selected or a toolbar button is pressed.</DL>
<HR>
<A NAME="snapinListener(com.novell.Chat.SnapinEvent)"><!-- --></A><H3>
snapinListener</H3>
<PRE>
public void <B>snapinListener</B>(com.novell.Chat.SnapinEvent event)</PRE>
<DL>
<DD>Implementation of the SnapinListener Interface.
Called when chat's initialization has completed.</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT ID="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/novell/Chat/OnlineUsersDlg.html"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="OnLineUserSnapin.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>