diff options
Diffstat (limited to 'doc/jrummikub/view/impl/StonePainter.html')
| -rw-r--r-- | doc/jrummikub/view/impl/StonePainter.html | 410 |
1 files changed, 410 insertions, 0 deletions
diff --git a/doc/jrummikub/view/impl/StonePainter.html b/doc/jrummikub/view/impl/StonePainter.html new file mode 100644 index 0000000..36669ce --- /dev/null +++ b/doc/jrummikub/view/impl/StonePainter.html @@ -0,0 +1,410 @@ +<!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.6.0_20) on Tue May 10 16:57:40 CEST 2011 --> +<TITLE> +StonePainter +</TITLE> + +<META NAME="date" CONTENT="2011-05-10"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="StonePainter"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= 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=2 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="class-use/StonePainter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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="../../../jrummikub/view/impl/StoneCollectionPanel.html" title="class in jrummikub.view.impl"><B>PREV CLASS</B></A> + <A HREF="../../../jrummikub/view/impl/TablePanel.html" title="class in jrummikub.view.impl"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?jrummikub/view/impl/StonePainter.html" target="_top"><B>FRAMES</B></A> + <A HREF="StonePainter.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <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"> +jrummikub.view.impl</FONT> +<BR> +Class StonePainter</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>jrummikub.view.impl.StonePainter</B> +</PRE> +<HR> +<DL> +<DT><PRE> class <B>StonePainter</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +The StonePainter paints stones and converts between pixel and grid + coordinates +<P> + +<P> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static float</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../jrummikub/view/impl/StonePainter.html#HEIGHT_SCALE">HEIGHT_SCALE</A></B></CODE> + +<BR> + The height of one pixel in the scale of 1.0</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static float</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../jrummikub/view/impl/StonePainter.html#WIDTH_SCALE">WIDTH_SCALE</A></B></CODE> + +<BR> + The width of one pixel in the scale of 1.0</TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../jrummikub/view/impl/StonePainter.html#StonePainter(float)">StonePainter</A></B>(float scale)</CODE> + +<BR> + </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"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../jrummikub/view/impl/StonePainter.html#calculatePosition(int, int)">calculatePosition</A></B>(int x, + int y)</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../jrummikub/view/impl/StonePainter.html#getStoneHeight()">getStoneHeight</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../jrummikub/view/impl/StonePainter.html#getStoneWidth()">getStoneWidth</A></B>()</CODE> + +<BR> + </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="../../../jrummikub/view/impl/StonePainter.html#paintStone(java.awt.Graphics2D, jrummikub.model.Stone, jrummikub.model.Position, boolean, boolean)">paintStone</A></B>(java.awt.Graphics2D g, + <A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone, + <A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> p, + boolean selected, + boolean hovered)</CODE> + +<BR> + Paints a stone</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="../../../jrummikub/view/impl/StonePainter.html#setScale(float)">setScale</A></B>(float scale)</CODE> + +<BR> + Sets the new grid scale</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"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</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 =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="WIDTH_SCALE"><!-- --></A><H3> +WIDTH_SCALE</H3> +<PRE> +public static final float <B>WIDTH_SCALE</B></PRE> +<DL> +<DD>The width of one pixel in the scale of 1.0 +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#jrummikub.view.impl.StonePainter.WIDTH_SCALE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="HEIGHT_SCALE"><!-- --></A><H3> +HEIGHT_SCALE</H3> +<PRE> +public static final float <B>HEIGHT_SCALE</B></PRE> +<DL> +<DD>The height of one pixel in the scale of 1.0 +<P> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#jrummikub.view.impl.StonePainter.HEIGHT_SCALE">Constant Field Values</A></DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="StonePainter(float)"><!-- --></A><H3> +StonePainter</H3> +<PRE> +<B>StonePainter</B>(float scale)</PRE> +<DL> +<DL> +<DT><B>Parameters:</B><DD><CODE>scale</CODE> - the scaling factor for the grid coordinates</DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="setScale(float)"><!-- --></A><H3> +setScale</H3> +<PRE> +public void <B>setScale</B>(float scale)</PRE> +<DL> +<DD>Sets the new grid scale +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>scale</CODE> - the new scale</DL> +</DD> +</DL> +<HR> + +<A NAME="calculatePosition(int, int)"><!-- --></A><H3> +calculatePosition</H3> +<PRE> +public <A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> <B>calculatePosition</B>(int x, + int y)</PRE> +<DL> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>x</CODE> - x position in screen coordinates<DD><CODE>y</CODE> - y position in screen coordinates +<DT><B>Returns:</B><DD>position in grid coordinates</DL> +</DD> +</DL> +<HR> + +<A NAME="getStoneWidth()"><!-- --></A><H3> +getStoneWidth</H3> +<PRE> +public int <B>getStoneWidth</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>the width of a stone in the current scale in pixels</DL> +</DD> +</DL> +<HR> + +<A NAME="getStoneHeight()"><!-- --></A><H3> +getStoneHeight</H3> +<PRE> +public int <B>getStoneHeight</B>()</PRE> +<DL> +<DD><DL> + +<DT><B>Returns:</B><DD>the height of a stone in the current scale in pixels</DL> +</DD> +</DL> +<HR> + +<A NAME="paintStone(java.awt.Graphics2D, jrummikub.model.Stone, jrummikub.model.Position, boolean, boolean)"><!-- --></A><H3> +paintStone</H3> +<PRE> +public void <B>paintStone</B>(java.awt.Graphics2D g, + <A HREF="../../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone, + <A HREF="../../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> p, + boolean selected, + boolean hovered)</PRE> +<DL> +<DD>Paints a stone +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>g</CODE> - the graphics context to paint the stone on<DD><CODE>stone</CODE> - the stone to paint<DD><CODE>p</CODE> - the position of the stone<DD><CODE>selected</CODE> - if selected is true the stone will be painted darker<DD><CODE>hovered</CODE> - if hovered is true the stone will be painted brighter</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=2 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="class-use/StonePainter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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="../../../jrummikub/view/impl/StoneCollectionPanel.html" title="class in jrummikub.view.impl"><B>PREV CLASS</B></A> + <A HREF="../../../jrummikub/view/impl/TablePanel.html" title="class in jrummikub.view.impl"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?jrummikub/view/impl/StonePainter.html" target="_top"><B>FRAMES</B></A> + <A HREF="StonePainter.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <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> |