720 lines
26 KiB
HTML
720 lines
26 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
|
<TITLE>
|
|
LComponent
|
|
</TITLE>
|
|
|
|
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.gui.LComponent class">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
parent.document.title="LComponent";
|
|
}
|
|
</SCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="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 CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="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="../../../../../edu/gatech/cs2335/lemmings/gui/LColoredComponent.html" title="class in edu.gatech.cs2335.lemmings.gui"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LContainer.html" title="class in edu.gatech.cs2335.lemmings.gui"><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="LComponent.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | 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>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
edu.gatech.cs2335.lemmings.gui</FONT>
|
|
<BR>
|
|
Class LComponent</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.gui.LComponent</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LContainer.html" title="class in edu.gatech.cs2335.lemmings.gui">LContainer</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LLeafComponent.html" title="class in edu.gatech.cs2335.lemmings.gui">LLeafComponent</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT>public abstract class <B>LComponent</B><DT>extends java.lang.Object</DL>
|
|
|
|
<P>
|
|
The base component class, from which all of the more specific
|
|
components, such as buttons, will be derived.
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Version:</B></DT>
|
|
<DD>1.0</DD>
|
|
<DT><B>Author:</B></DT>
|
|
<DD><a href="mailto:gtg308i@mail.gatech.edu">Vladimir Urazov</a></DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#LComponent()">LComponent</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Creates a new <code>LComponent</code> instance.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#bringToTop()">bringToTop</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Brings the current component to the top of the z-order.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#cleanUp()">cleanUp</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Performs all the necessary operations to clean up after the
|
|
component.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected abstract void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#copy(edu.gatech.cs2335.lemmings.gui.LComponent)">copy</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html" title="class in edu.gatech.cs2335.lemmings.gui">LComponent</A> component)</CODE>
|
|
|
|
<BR>
|
|
Deep-copies self <b>into the component</b> passed in.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.awt.Rectangle</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#getBounds()">getBounds</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the rectangle denoting the bounds of the component.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LContainer.html" title="class in edu.gatech.cs2335.lemmings.gui">LContainer</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#getParent()">getParent</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns a pointer to the parent component of this one if there is
|
|
one, or NULL if this component has no parent or is the root
|
|
window.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#initialize()">initialize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Performs all of the initialization necessary for the
|
|
component.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#isActive()">isActive</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns true if the component has input focus, and false if it does not.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#isComponentDirty()">isComponentDirty</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns true if the component is to be rerendered during the next frame.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#isShown()">isShown</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns true if the component is visible, and false if it is not.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#makeDirty()">makeDirty</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Marks the component dirty.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#move(java.awt.Point)">move</A></B>(java.awt.Point offset)</CODE>
|
|
|
|
<BR>
|
|
Moves the component by the offsets specified by the components of
|
|
the point.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected abstract boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#paint(java.awt.Graphics)">paint</A></B>(java.awt.Graphics g)</CODE>
|
|
|
|
<BR>
|
|
Performs all of the necessary drawing for this control only.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#renderAll(java.awt.Graphics)">renderAll</A></B>(java.awt.Graphics g)</CODE>
|
|
|
|
<BR>
|
|
Calls paint on self and then all the children in z order.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#setBounds(java.awt.Rectangle)">setBounds</A></B>(java.awt.Rectangle newBounds)</CODE>
|
|
|
|
<BR>
|
|
Sets the new bounds of the component.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#setDirty(boolean)">setDirty</A></B>(boolean value)</CODE>
|
|
|
|
<BR>
|
|
Sets the component's dirty value to the one passed in.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#setParent(edu.gatech.cs2335.lemmings.gui.LContainer)">setParent</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LContainer.html" title="class in edu.gatech.cs2335.lemmings.gui">LContainer</A> c)</CODE>
|
|
|
|
<BR>
|
|
Sets a new parent for this component.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#setPosition(java.awt.Point)">setPosition</A></B>(java.awt.Point p)</CODE>
|
|
|
|
<BR>
|
|
Sets the location of the top-left corner of the component to the
|
|
desired coordinates.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#setShown(boolean)">setShown</A></B>(boolean value)</CODE>
|
|
|
|
<BR>
|
|
Sets the visibility of the component to the value passed in.</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="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#setSize(java.awt.Dimension)">setSize</A></B>(java.awt.Dimension d)</CODE>
|
|
|
|
<BR>
|
|
Sets the size of the component.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#setSize(int, int)">setSize</A></B>(int width,
|
|
int height)</CODE>
|
|
|
|
<BR>
|
|
Describe <code>setSize</code> method here.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html#updateDimensions()">updateDimensions</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Updates the dimensions of the component.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="LComponent()"><!-- --></A><H3>
|
|
LComponent</H3>
|
|
<PRE>
|
|
public <B>LComponent</B>()</PRE>
|
|
<DL>
|
|
<DD>Creates a new <code>LComponent</code> instance.
|
|
<P>
|
|
</DL>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="initialize()"><!-- --></A><H3>
|
|
initialize</H3>
|
|
<PRE>
|
|
public boolean <B>initialize</B>()</PRE>
|
|
<DL>
|
|
<DD>Performs all of the initialization necessary for the
|
|
component. Returns true if the initialization went through
|
|
successfully and false if something went wrong.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="cleanUp()"><!-- --></A><H3>
|
|
cleanUp</H3>
|
|
<PRE>
|
|
public boolean <B>cleanUp</B>()</PRE>
|
|
<DL>
|
|
<DD>Performs all the necessary operations to clean up after the
|
|
component. Does *not* destroy the children of the component,
|
|
however.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getParent()"><!-- --></A><H3>
|
|
getParent</H3>
|
|
<PRE>
|
|
public final <A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LContainer.html" title="class in edu.gatech.cs2335.lemmings.gui">LContainer</A> <B>getParent</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns a pointer to the parent component of this one if there is
|
|
one, or NULL if this component has no parent or is the root
|
|
window.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <code>LComponent</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setParent(edu.gatech.cs2335.lemmings.gui.LContainer)"><!-- --></A><H3>
|
|
setParent</H3>
|
|
<PRE>
|
|
public final void <B>setParent</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LContainer.html" title="class in edu.gatech.cs2335.lemmings.gui">LContainer</A> c)</PRE>
|
|
<DL>
|
|
<DD>Sets a new parent for this component.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>c</CODE> - a <code>LContainer</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isShown()"><!-- --></A><H3>
|
|
isShown</H3>
|
|
<PRE>
|
|
public final boolean <B>isShown</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns true if the component is visible, and false if it is not.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setShown(boolean)"><!-- --></A><H3>
|
|
setShown</H3>
|
|
<PRE>
|
|
public final void <B>setShown</B>(boolean value)</PRE>
|
|
<DL>
|
|
<DD>Sets the visibility of the component to the value passed in.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - a <code>boolean</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isComponentDirty()"><!-- --></A><H3>
|
|
isComponentDirty</H3>
|
|
<PRE>
|
|
public final boolean <B>isComponentDirty</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns true if the component is to be rerendered during the next frame.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>boolean</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDirty(boolean)"><!-- --></A><H3>
|
|
setDirty</H3>
|
|
<PRE>
|
|
protected final void <B>setDirty</B>(boolean value)</PRE>
|
|
<DL>
|
|
<DD>Sets the component's dirty value to the one passed in.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - v</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isActive()"><!-- --></A><H3>
|
|
isActive</H3>
|
|
<PRE>
|
|
public final boolean <B>isActive</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns true if the component has input focus, and false if it does not.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="bringToTop()"><!-- --></A><H3>
|
|
bringToTop</H3>
|
|
<PRE>
|
|
public final void <B>bringToTop</B>()</PRE>
|
|
<DL>
|
|
<DD>Brings the current component to the top of the z-order. (It's
|
|
children will still remain on top of it, however.)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getBounds()"><!-- --></A><H3>
|
|
getBounds</H3>
|
|
<PRE>
|
|
public final java.awt.Rectangle <B>getBounds</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the rectangle denoting the bounds of the component.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <code>Rectangle</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setBounds(java.awt.Rectangle)"><!-- --></A><H3>
|
|
setBounds</H3>
|
|
<PRE>
|
|
public final void <B>setBounds</B>(java.awt.Rectangle newBounds)</PRE>
|
|
<DL>
|
|
<DD>Sets the new bounds of the component. No error checking is
|
|
performed beyond that the size of the rectangle should be
|
|
meaningful.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>newBounds</CODE> - n</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPosition(java.awt.Point)"><!-- --></A><H3>
|
|
setPosition</H3>
|
|
<PRE>
|
|
public final void <B>setPosition</B>(java.awt.Point p)</PRE>
|
|
<DL>
|
|
<DD>Sets the location of the top-left corner of the component to the
|
|
desired coordinates.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>p</CODE> - a <code>Point</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSize(java.awt.Dimension)"><!-- --></A><H3>
|
|
setSize</H3>
|
|
<PRE>
|
|
public final void <B>setSize</B>(java.awt.Dimension d)</PRE>
|
|
<DL>
|
|
<DD>Sets the size of the component.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>d</CODE> - a <code>Dimension</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSize(int, int)"><!-- --></A><H3>
|
|
setSize</H3>
|
|
<PRE>
|
|
protected final void <B>setSize</B>(int width,
|
|
int height)</PRE>
|
|
<DL>
|
|
<DD>Describe <code>setSize</code> method here.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>width</CODE> - an <code>int</code> value<DD><CODE>height</CODE> - an <code>int</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="updateDimensions()"><!-- --></A><H3>
|
|
updateDimensions</H3>
|
|
<PRE>
|
|
protected void <B>updateDimensions</B>()</PRE>
|
|
<DL>
|
|
<DD>Updates the dimensions of the component. This must *NOT* under
|
|
any circumstances call the method setPosition() or setSize()!!!
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="makeDirty()"><!-- --></A><H3>
|
|
makeDirty</H3>
|
|
<PRE>
|
|
public abstract void <B>makeDirty</B>()</PRE>
|
|
<DL>
|
|
<DD>Marks the component dirty.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="move(java.awt.Point)"><!-- --></A><H3>
|
|
move</H3>
|
|
<PRE>
|
|
public abstract void <B>move</B>(java.awt.Point offset)</PRE>
|
|
<DL>
|
|
<DD>Moves the component by the offsets specified by the components of
|
|
the point.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>offset</CODE> - a <code>Point</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="renderAll(java.awt.Graphics)"><!-- --></A><H3>
|
|
renderAll</H3>
|
|
<PRE>
|
|
public abstract boolean <B>renderAll</B>(java.awt.Graphics g)</PRE>
|
|
<DL>
|
|
<DD>Calls paint on self and then all the children in z order.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>g</CODE> - a <code>Graphics</code> value
|
|
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="copy(edu.gatech.cs2335.lemmings.gui.LComponent)"><!-- --></A><H3>
|
|
copy</H3>
|
|
<PRE>
|
|
protected abstract void <B>copy</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LComponent.html" title="class in edu.gatech.cs2335.lemmings.gui">LComponent</A> component)</PRE>
|
|
<DL>
|
|
<DD>Deep-copies self <b>into the component</b> passed in.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>component</CODE> - a <code>LComponent</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="paint(java.awt.Graphics)"><!-- --></A><H3>
|
|
paint</H3>
|
|
<PRE>
|
|
protected abstract boolean <B>paint</B>(java.awt.Graphics g)</PRE>
|
|
<DL>
|
|
<DD>Performs all of the necessary drawing for this control only. The
|
|
children will be taken care of separately. This method need not
|
|
concern itself with them.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>g</CODE> - a <code>Graphics</code> value
|
|
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="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 CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="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="../../../../../edu/gatech/cs2335/lemmings/gui/LColoredComponent.html" title="class in edu.gatech.cs2335.lemmings.gui"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../../edu/gatech/cs2335/lemmings/gui/LContainer.html" title="class in edu.gatech.cs2335.lemmings.gui"><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="LComponent.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | 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>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|