ChatRoomSnapins.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:12 MST 2000 -->
<TITLE>
Chat Snapin Documentation: Class ChatRoomSnapins
</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/ChatRoomPageSnapin.html"><B>PREV CLASS</B></A>
<A HREF="../../../com/novell/Chat/ChatRoomUserTable.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ChatRoomSnapins.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 ChatRoomSnapins</H2>
<PRE>
<B>com.novell.Chat.ChatRoomSnapins</B>
</PRE>
<HR>
<DL>
<DT>public class <B>ChatRoomSnapins</B><DT>implements java.awt.event.ActionListener</DL>
<P>
Provides the snapins that are used to create Chat Room Objects.
A Chat Room object can be created from the toolbar, the main menu, or
the popup menu. Since these three snapins will perform the same function,
they have all been included in the same class.
<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/ChatRoomSnapins.html#ChatRoomSnapins()">ChatRoomSnapins</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/ChatRoomSnapins.html#actionPerformed(java.awt.event.ActionEvent)">actionPerformed</A></B>(java.awt.event.ActionEvent e)</CODE>
<BR>
ActionListener interface implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> javax.swing.JMenuItem[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/ChatRoomSnapins.html#getMenuItems()">getMenuItems</A></B>()</CODE>
<BR>
MenuSnapin interface 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/ChatRoomSnapins.html#getMenuLocation()">getMenuLocation</A></B>()</CODE>
<BR>
MenuSnapin interface 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/ChatRoomSnapins.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/ChatRoomSnapins.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.awt.Component</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/ChatRoomSnapins.html#getToolBarItem()">getToolBarItem</A></B>()</CODE>
<BR>
Implementation of the ToolBarSnapin Interface.</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/ChatRoomSnapins.html#initSnapin(com.novell.Chat.InitSnapinInfo)">initSnapin</A></B>(com.novell.Chat.InitSnapinInfo info)</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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/ChatRoomSnapins.html#shutdownSnapin()">shutdownSnapin</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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/ChatRoomSnapins.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="ChatRoomSnapins()"><!-- --></A><H3>
ChatRoomSnapins</H3>
<PRE>
public <B>ChatRoomSnapins</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>
</DL>
</DD>
<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>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The snapin's description.</DL>
</DD>
</DL>
<HR>
<A NAME="initSnapin(com.novell.Chat.InitSnapinInfo)"><!-- --></A><H3>
initSnapin</H3>
<PRE>
public boolean <B>initSnapin</B>(com.novell.Chat.InitSnapinInfo info)</PRE>
<DL>
<DD>Implementation of the Snapin Interface.
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>
</DL>
</DD>
<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="shutdownSnapin()"><!-- --></A><H3>
shutdownSnapin</H3>
<PRE>
public void <B>shutdownSnapin</B>()</PRE>
<DL>
<DD>Implementation of the Snapin Interface.
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.<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMenuItems()"><!-- --></A><H3>
getMenuItems</H3>
<PRE>
public javax.swing.JMenuItem[] <B>getMenuItems</B>()</PRE>
<DL>
<DD>MenuSnapin interface implementation<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The array of menu items to show.</DL>
</DD>
</DL>
<HR>
<A NAME="getMenuLocation()"><!-- --></A><H3>
getMenuLocation</H3>
<PRE>
public java.lang.String <B>getMenuLocation</B>()</PRE>
<DL>
<DD>MenuSnapin interface implementation<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The menu under which this item will be listed.</DL>
</DD>
</DL>
<HR>
<A NAME="getToolBarItem()"><!-- --></A><H3>
getToolBarItem</H3>
<PRE>
public java.awt.Component <B>getToolBarItem</B>()</PRE>
<DL>
<DD>Implementation of the ToolBarSnapin Interface.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The button panel containing the buttons.</DL>
</DD>
</DL>
<HR>
<A NAME="actionPerformed(java.awt.event.ActionEvent)"><!-- --></A><H3>
actionPerformed</H3>
<PRE>
public void <B>actionPerformed</B>(java.awt.event.ActionEvent e)</PRE>
<DL>
<DD>ActionListener interface implementation.
This is what is called when our menu item is selected.
A corresponding snapin event is then raised which will
be detected by the ConsoleChatToolbarSnapin. This is so
The same thing will happen regardless of whether a menu item
is selected or a toolbar button is pressed.<DD><DL>
<DT><B>Specified by: </B><DD>actionPerformed in interface java.awt.event.ActionListener</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>e</CODE> - The ActionEvent that has occurred.</DL>
</DD>
</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.<DD><DL>
</DL>
</DD>
</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/ChatRoomPageSnapin.html"><B>PREV CLASS</B></A>
<A HREF="../../../com/novell/Chat/ChatRoomUserTable.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ChatRoomSnapins.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>