From 51b7fbe822bd9a3804c061f0b844884769d7ddba Mon Sep 17 00:00:00 2001 From: Ida Massow Date: Wed, 6 Jul 2011 16:36:06 +0200 Subject: Javadoc git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172 --- doc/jrummikub/view/impl/PlayerPanel.html | 961 ++++++++++++++++++++++++++++++- 1 file changed, 934 insertions(+), 27 deletions(-) (limited to 'doc/jrummikub/view/impl/PlayerPanel.html') diff --git a/doc/jrummikub/view/impl/PlayerPanel.html b/doc/jrummikub/view/impl/PlayerPanel.html index 8e04896..a611ef8 100644 --- a/doc/jrummikub/view/impl/PlayerPanel.html +++ b/doc/jrummikub/view/impl/PlayerPanel.html @@ -2,12 +2,12 @@ - + PlayerPanel - + @@ -55,8 +55,8 @@ function windowTitle() - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS FRAMES    NO FRAMES   @@ -76,9 +76,9 @@ function windowTitle() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD @@ -123,6 +123,22 @@ Implementation of the player panel Nested Class Summary + + +private  class +PlayerPanel.LeftPanelResizeListener + +
+            + + + +private  class +PlayerPanel.RightPanelResizeListener + +
+            +   @@ -172,6 +188,246 @@ Implementation of the player panel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field Summary
+private  javax.swing.JLabelcurrentPlayerNameLabel + +
+           
+private  javax.swing.JButtonendTurnButton + +
+           
+private  EventendTurnEvent + +
+           
+private  HandPanelhand + +
+           
+private static floatHAND_ROW_BUTTON_RATIO + +
+           
+private  javax.swing.JButtonhandRowDownButton + +
+           
+private  javax.swing.JButtonhandRowUpButton + +
+           
+private  javax.swing.JLabelhasLaidOutLabel + +
+           
+private  javax.swing.JButtonkeepStonesButton + +
+           
+private  javax.swing.JPanelleftPanel + +
+           
+private  java.awt.event.ComponentListenerleftPanelResizeListener + +
+           
+private  intleftPanelWidth + +
+           
+private static floatMAX_BUTTON_FONT_SIZE + +
+           
+private  booleanmayPause + +
+           
+private  javax.swing.JButtonpauseButton + +
+           
+private  EventpauseEvent + +
+           
+private  javax.swing.JButtonredealButton + +
+           
+private  EventredealEvent + +
+           
+private  javax.swing.JPanelrightPanel + +
+           
+private  java.awt.event.ComponentListenerrightPanelResizeListener + +
+           
+private static java.text.DecimalFormatsecondFormat + +
+           
+private static floatSIDE_PANEL_FIRST_LINE_HEIGHT + +
+           
+private static intSIDE_PANEL_INSET + +
+           
+private static intSIDE_PANEL_MAX_WIDTH + +
+           
+private static intSIDE_PANEL_SEPARATOR + +
+           
+private  javax.swing.JButtonsortByGroupsButton + +
+           
+private  EventsortByGroupsEvent + +
+           
+private  javax.swing.JButtonsortByRunsButton + +
+           
+private  EventsortByRunsEvent + +
+           
+private  javax.swing.JProgressBartimeBar + +
+           
  @@ -227,6 +483,48 @@ Implementation of the player panel + + + + + + + + + + + + + + + + + + + + +(package private)  HandPanel + + + + + + + + + + + + +          The sort by runs event is emitted when the player wants to sort his + stones by runs + + + + + + + + - +          Sets the buttons available to end the turn + + + + + + + + + + + + + + + + + + + +
+private  javax.swing.JButtoncreateButton(javax.swing.JPanel panel, + java.lang.String caption, + java.awt.event.ActionListener listener) + +
+           
+private  voidcreateLeftPanel() + +
+           
+private  voidcreateRightPanel() + +
+           
+private  voidcreateRightPanelButtons() + +
+           
+(package private)  voidenableButtons(boolean enable) + +
+           
 IEvent getEndTurnEvent() @@ -235,7 +533,7 @@ Implementation of the player panel
- HandPanel getHandPanel()
@@ -243,6 +541,30 @@ Implementation of the player panel
+(package private)  intgetLeftPanelWidth() + +
+           
+(package private)  IEventgetPauseEvent() + +
+           
+ IEventgetRedealEvent() + +
+          The redeal event is emitted when the player wants to get new stones
 IEvent getSortByGroupsEvent() @@ -256,8 +578,24 @@ Implementation of the player panel getSortByRunsEvent()
-          The sort by runs event is emitted when the player wants to sort his stones - by runs
+(package private)  voidrescale() + +
+           
+(package private)  voidsetCurrentPlayerColor(java.awt.Color color) + +
+           
@@ -270,10 +608,51 @@ Implementation of the player panel
 voidsetTimeLeft(int time) +setEndTurnMode(TurnMode turnMode)
-          Sets the time the player has left for his turn
+(package private)  voidsetHasLaidOut(boolean hasLaidOut) + +
+           
+(package private)  voidsetMayPause(boolean mayPause) + +
+           
+ voidsetTime(int time, + int totalTime) + +
+          Sets the time the player has left for his turn
+(package private)  voidshowButtons(boolean show) + +
+           
+(package private)  voidupdateButtons() + +
+           
  @@ -324,6 +703,315 @@ Implementation of the player panel  

+ + + + + + + +
+Field Detail
+ +

+SIDE_PANEL_INSET

+
+private static final int SIDE_PANEL_INSET
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SIDE_PANEL_SEPARATOR

+
+private static final int SIDE_PANEL_SEPARATOR
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SIDE_PANEL_FIRST_LINE_HEIGHT

+
+private static final float SIDE_PANEL_FIRST_LINE_HEIGHT
+
+
+
See Also:
Constant Field Values
+
+
+ +

+SIDE_PANEL_MAX_WIDTH

+
+private static final int SIDE_PANEL_MAX_WIDTH
+
+
+
See Also:
Constant Field Values
+
+
+ +

+HAND_ROW_BUTTON_RATIO

+
+private static final float HAND_ROW_BUTTON_RATIO
+
+
+
See Also:
Constant Field Values
+
+
+ +

+MAX_BUTTON_FONT_SIZE

+
+private static final float MAX_BUTTON_FONT_SIZE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+secondFormat

+
+private static final java.text.DecimalFormat secondFormat
+
+
+
+
+
+ +

+hand

+
+private HandPanel hand
+
+
+
+
+
+ +

+leftPanel

+
+private javax.swing.JPanel leftPanel
+
+
+
+
+
+ +

+rightPanel

+
+private javax.swing.JPanel rightPanel
+
+
+
+
+
+ +

+currentPlayerNameLabel

+
+private javax.swing.JLabel currentPlayerNameLabel
+
+
+
+
+
+ +

+hasLaidOutLabel

+
+private javax.swing.JLabel hasLaidOutLabel
+
+
+
+
+
+ +

+sortByGroupsButton

+
+private javax.swing.JButton sortByGroupsButton
+
+
+
+
+
+ +

+sortByRunsButton

+
+private javax.swing.JButton sortByRunsButton
+
+
+
+
+
+ +

+handRowUpButton

+
+private javax.swing.JButton handRowUpButton
+
+
+
+
+
+ +

+handRowDownButton

+
+private javax.swing.JButton handRowDownButton
+
+
+
+
+
+ +

+timeBar

+
+private javax.swing.JProgressBar timeBar
+
+
+
+
+
+ +

+endTurnButton

+
+private javax.swing.JButton endTurnButton
+
+
+
+
+
+ +

+keepStonesButton

+
+private javax.swing.JButton keepStonesButton
+
+
+
+
+
+ +

+redealButton

+
+private javax.swing.JButton redealButton
+
+
+
+
+
+ +

+pauseButton

+
+private javax.swing.JButton pauseButton
+
+
+
+
+
+ +

+sortByGroupsEvent

+
+private Event sortByGroupsEvent
+
+
+
+
+
+ +

+sortByRunsEvent

+
+private Event sortByRunsEvent
+
+
+
+
+
+ +

+endTurnEvent

+
+private Event endTurnEvent
+
+
+
+
+
+ +

+redealEvent

+
+private Event redealEvent
+
+
+
+
+
+ +

+pauseEvent

+
+private Event pauseEvent
+
+
+
+
+
+ +

+leftPanelWidth

+
+private int leftPanelWidth
+
+
+
+
+
+ +

+mayPause

+
+private boolean mayPause
+
+
+
+
+
+ +

+leftPanelResizeListener

+
+private java.awt.event.ComponentListener leftPanelResizeListener
+
+
+
+
+
+ +

+rightPanelResizeListener

+
+private java.awt.event.ComponentListener rightPanelResizeListener
+
+
+
+
+ @@ -356,14 +1044,13 @@ PlayerPanel

getHandPanel

-public HandPanel getHandPanel()
+HandPanel getHandPanel()
-
Specified by:
getHandPanel in interface IPlayerPanel
+
- -
Returns:
the board where the players hand stones are displayed
+
@@ -384,19 +1071,48 @@ void setCurrentPlayerName(java.lang.String playerName)
-

-setTimeLeft

+

+setCurrentPlayerColor

+
+void setCurrentPlayerColor(java.awt.Color color)
+
+
+
+
+
+
+
+
+
+ +

+setHasLaidOut

-public void setTimeLeft(int time)
+void setHasLaidOut(boolean hasLaidOut)
-
Description copied from interface: IPlayerPanel
+
+
+
+
+
+
+
+
+ +

+setTime

+
+public void setTime(int time,
+                    int totalTime)
+
+
Description copied from interface: IPlayerPanel
Sets the time the player has left for his turn

-
Specified by:
setTimeLeft in interface IPlayerPanel
+
Specified by:
setTime in interface IPlayerPanel
-
Parameters:
time - the time left
+
Parameters:
time - the time left
totalTime - total time for a turn
@@ -426,8 +1142,8 @@ getSortByRunsEvent public IEvent getSortByRunsEvent()
Description copied from interface: IPlayerPanel
-
The sort by runs event is emitted when the player wants to sort his stones - by runs +
The sort by runs event is emitted when the player wants to sort his + stones by runs

Specified by:
getSortByRunsEvent in interface IPlayerPanel
@@ -455,6 +1171,197 @@ public

+getRedealEvent

+
+public IEvent getRedealEvent()
+
+
Description copied from interface: IPlayerPanel
+
The redeal event is emitted when the player wants to get new stones +

+

+
Specified by:
getRedealEvent in interface IPlayerPanel
+
+
+ +
Returns:
the event
+
+
+
+ +

+getPauseEvent

+
+IEvent getPauseEvent()
+
+
+
+
+
+
+
+
+
+ +

+createLeftPanel

+
+private void createLeftPanel()
+
+
+
+
+
+
+
+
+
+ +

+createRightPanel

+
+private void createRightPanel()
+
+
+
+
+
+
+
+
+
+ +

+createRightPanelButtons

+
+private void createRightPanelButtons()
+
+
+
+
+
+
+
+
+
+ +

+createButton

+
+private javax.swing.JButton createButton(javax.swing.JPanel panel,
+                                         java.lang.String caption,
+                                         java.awt.event.ActionListener listener)
+
+
+
+
+
+
+
+
+
+ +

+rescale

+
+void rescale()
+
+
+
+
+
+
+
+
+
+ +

+getLeftPanelWidth

+
+int getLeftPanelWidth()
+
+
+
+
+
+
+
+
+
+ +

+updateButtons

+
+void updateButtons()
+
+
+
+
+
+
+
+
+
+ +

+setEndTurnMode

+
+public void setEndTurnMode(TurnMode turnMode)
+
+
Description copied from interface: IPlayerPanel
+
Sets the buttons available to end the turn +

+

+
Specified by:
setEndTurnMode in interface IPlayerPanel
+
+
+
Parameters:
turnMode - the TurnMode
+
+
+
+ +

+showButtons

+
+void showButtons(boolean show)
+
+
+
+
+
+
+
+
+
+ +

+enableButtons

+
+void enableButtons(boolean enable)
+
+
+
+
+
+
+
+
+
+ +

+setMayPause

+
+void setMayPause(boolean mayPause)
+
+
+
+
+
+
+
+
@@ -486,8 +1393,8 @@ public - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS FRAMES    NO FRAMES   @@ -507,9 +1414,9 @@ public - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD -- cgit v1.2.3