ChatRoomPageSnapin.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 ChatRoomPageSnapin
</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/ChatRoomPage.html"><B>PREV CLASS</B></A>
<A HREF="../../../com/novell/Chat/ChatRoomSnapins.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="ChatRoomPageSnapin.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 ChatRoomPageSnapin</H2>
<PRE>
<B>com.novell.Chat.ChatRoomPageSnapin</B>
</PRE>
<HR>
<DL>
<DT>public class <B>ChatRoomPageSnapin</B></DL>
<P>
This is the Page that is displayed in the property book for all Chat Room Objects.
<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/ChatRoomPageSnapin.html#ChatRoomPageSnapin()">ChatRoomPageSnapin</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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/novell/Chat/ChatRoomPageSnapin.html#canSave()">canSave</A></B>()</CODE>
<BR>
PageSnapin 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/ChatRoomPageSnapin.html#getHandledAttributeNames()">getHandledAttributeNames</A></B>()</CODE>
<BR>
AttributeHandler 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/ChatRoomPageSnapin.html#getMenuName()">getMenuName</A></B>()</CODE>
<BR>
PageSnapin Interface implementation.</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/ChatRoomPageSnapin.html#getPage()">getPage</A></B>()</CODE>
<BR>
PageSnapin 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/ChatRoomPageSnapin.html#getSnapinDescription()">getSnapinDescription</A></B>()</CODE>
<BR>
Snapin 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/ChatRoomPageSnapin.html#getSnapinName()">getSnapinName</A></B>()</CODE>
<BR>
Snapin 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/ChatRoomPageSnapin.html#getTabID()">getTabID</A></B>()</CODE>
<BR>
PageSnapin 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/ChatRoomPageSnapin.html#getTabName()">getTabName</A></B>()</CODE>
<BR>
PageSnapin Interface implementation.</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/ChatRoomPageSnapin.html#hasHelp()">hasHelp</A></B>()</CODE>
<BR>
PageSnapin Interface implementation.</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/ChatRoomPageSnapin.html#initSnapin(com.novell.Chat.InitSnapinInfo)">initSnapin</A></B>(com.novell.Chat.InitSnapinInfo snapinInfo)</CODE>
<BR>
Snapin interface implementation</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/ChatRoomPageSnapin.html#killActive()">killActive</A></B>()</CODE>
<BR>
Called just before the page loses the focus.</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/ChatRoomPageSnapin.html#saveData()">saveData</A></B>()</CODE>
<BR>
PageSnapin Interface implementation.</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/ChatRoomPageSnapin.html#setActive(boolean)">setActive</A></B>(boolean isFirstTimeShown)</CODE>
<BR>
Called just before the page is set as the current page.</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/ChatRoomPageSnapin.html#showHelp()">showHelp</A></B>()</CODE>
<BR>
Launches context sensitive help.</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/ChatRoomPageSnapin.html#shutdownSnapin()">shutdownSnapin</A></B>()</CODE>
<BR>
Snapin Interface implementation, called when snapin shutsdown.</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="ChatRoomPageSnapin()"><!-- --></A><H3>
ChatRoomPageSnapin</H3>
<PRE>
public <B>ChatRoomPageSnapin</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="initSnapin(com.novell.Chat.InitSnapinInfo)"><!-- --></A><H3>
initSnapin</H3>
<PRE>
public boolean <B>initSnapin</B>(com.novell.Chat.InitSnapinInfo snapinInfo)</PRE>
<DL>
<DD>Snapin interface implementation<DD><DL>
<DT><B>Parameters:</B><DD><CODE>info</CODE> - The InitSnapinInfo object passed by ConsoleOne.<DT><B>Returns:</B><DD>true if initialized correctly, false otherwise. If false is
returned, the snapin will be discarded by ConsoleOne.</DL>
</DD>
</DL>
<HR>
<A NAME="getSnapinName()"><!-- --></A><H3>
getSnapinName</H3>
<PRE>
public java.lang.String <B>getSnapinName</B>()</PRE>
<DL>
<DD>Snapin Interface implementation.<DD><DL>
<DT><B>Returns:</B><DD>The Snapin Name</DL>
</DD>
</DL>
<HR>
<A NAME="getSnapinDescription()"><!-- --></A><H3>
getSnapinDescription</H3>
<PRE>
public java.lang.String <B>getSnapinDescription</B>()</PRE>
<DL>
<DD>Snapin Interface implementation.<DD><DL>
<DT><B>Returns:</B><DD>The description of the snapin</DL>
</DD>
</DL>
<HR>
<A NAME="shutdownSnapin()"><!-- --></A><H3>
shutdownSnapin</H3>
<PRE>
public void <B>shutdownSnapin</B>()</PRE>
<DL>
<DD>Snapin Interface implementation, called when snapin shutsdown.</DL>
<HR>
<A NAME="getPage()"><!-- --></A><H3>
getPage</H3>
<PRE>
public java.awt.Component <B>getPage</B>()</PRE>
<DL>
<DD>PageSnapin interface implementation.<DD><DL>
<DT><B>Returns:</B><DD>The ChatRoomPage object</DL>
</DD>
</DL>
<HR>
<A NAME="getTabName()"><!-- --></A><H3>
getTabName</H3>
<PRE>
public java.lang.String <B>getTabName</B>()</PRE>
<DL>
<DD>PageSnapin Interface implementation.<DD><DL>
<DT><B>Returns:</B><DD>The tab to place on the PropertyBook for this snapin.</DL>
</DD>
</DL>
<HR>
<A NAME="getTabID()"><!-- --></A><H3>
getTabID</H3>
<PRE>
public java.lang.String <B>getTabID</B>()</PRE>
<DL>
<DD>PageSnapin Interface implementation.<DD><DL>
<DT><B>Returns:</B><DD>The tab ID.</DL>
</DD>
</DL>
<HR>
<A NAME="getMenuName()"><!-- --></A><H3>
getMenuName</H3>
<PRE>
public java.lang.String <B>getMenuName</B>()</PRE>
<DL>
<DD>PageSnapin Interface implementation.<DD><DL>
<DT><B>Returns:</B><DD>The unique menu name in case more than one page has the save Tab name.</DL>
</DD>
</DL>
<HR>
<A NAME="setActive(boolean)"><!-- --></A><H3>
setActive</H3>
<PRE>
public void <B>setActive</B>(boolean isFirstTimeShown)</PRE>
<DL>
<DD>Called just before the page is set as the current page. Here we just call into
our GUI page.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>I-isFirstTimeShown</CODE> - true, if first time page is shown, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="killActive()"><!-- --></A><H3>
killActive</H3>
<PRE>
public boolean <B>killActive</B>()</PRE>
<DL>
<DD>Called just before the page loses the focus. Calls into our GUI page.<DD><DL>
<DT><B>Returns:</B><DD>true, if ok to leave this page, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="showHelp()"><!-- --></A><H3>
showHelp</H3>
<PRE>
public void <B>showHelp</B>()</PRE>
<DL>
<DD>Launches context sensitive help.</DL>
<HR>
<A NAME="hasHelp()"><!-- --></A><H3>
hasHelp</H3>
<PRE>
public boolean <B>hasHelp</B>()</PRE>
<DL>
<DD>PageSnapin Interface implementation.<DD><DL>
<DT><B>Returns:</B><DD>True, our snapin does have help.</DL>
</DD>
</DL>
<HR>
<A NAME="canSave()"><!-- --></A><H3>
canSave</H3>
<PRE>
public boolean <B>canSave</B>()</PRE>
<DL>
<DD>PageSnapin Interface implementation.<DD><DL>
<DT><B>Returns:</B><DD>true. We validate data in killActive. If you want to validate
data only when the ok or apply buttons are pressed then this is
where you would do it.</DL>
</DD>
</DL>
<HR>
<A NAME="saveData()"><!-- --></A><H3>
saveData</H3>
<PRE>
public boolean <B>saveData</B>()</PRE>
<DL>
<DD>PageSnapin Interface implementation. Note that this does NOT call page's saveData(). This is
because saveData() for the panel was called in killActive() routine of the panel.
This does the actual write to NDS.<DD><DL>
<DT><B>Returns:</B><DD>true always since we don't save on the page.</DL>
</DD>
</DL>
<HR>
<A NAME="getHandledAttributeNames()"><!-- --></A><H3>
getHandledAttributeNames</H3>
<PRE>
public java.lang.String[] <B>getHandledAttributeNames</B>()</PRE>
<DL>
<DD>AttributeHandler interface implementation. This is an optional
interface to tell the PropertyBook what attributes you are handling.
If you do not implement this interface, then the "Other" page is
allowed to edit these attributes.<DD><DL>
<DT><B>Returns:</B><DD>String[] with attribute names that this page is editing.</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/ChatRoomPage.html"><B>PREV CLASS</B></A>
<A HREF="../../../com/novell/Chat/ChatRoomSnapins.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="ChatRoomPageSnapin.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>