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/control/ApplicationControl.html | 377 +++++++++++- doc/jrummikub/control/GameControl.html | 474 ++++++++++++++- doc/jrummikub/control/ITurnTimer.html | 8 +- doc/jrummikub/control/RoundControl.html | 670 +++++++++++++++++++-- doc/jrummikub/control/TurnTimer.html | 134 ++++- .../control/class-use/ApplicationControl.html | 63 +- doc/jrummikub/control/class-use/GameControl.html | 87 ++- doc/jrummikub/control/class-use/ITurnTimer.html | 40 +- doc/jrummikub/control/class-use/RoundControl.html | 103 +++- doc/jrummikub/control/class-use/TurnTimer.html | 4 +- doc/jrummikub/control/package-frame.html | 27 +- doc/jrummikub/control/package-summary.html | 54 +- doc/jrummikub/control/package-tree.html | 28 +- doc/jrummikub/control/package-use.html | 133 +++- 14 files changed, 2075 insertions(+), 127 deletions(-) (limited to 'doc/jrummikub/control') diff --git a/doc/jrummikub/control/ApplicationControl.html b/doc/jrummikub/control/ApplicationControl.html index 3022e0c..057410d 100644 --- a/doc/jrummikub/control/ApplicationControl.html +++ b/doc/jrummikub/control/ApplicationControl.html @@ -2,12 +2,12 @@ - + ApplicationControl - + @@ -37,7 +37,8 @@ function windowTitle() - + + @@ -54,8 +55,8 @@ function windowTitle() + PREV CLASS  + NEXT CLASS + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
Package  Overview  Package   Class  Use  Tree 
- PREV CLASS  - NEXT CLASS FRAMES    NO FRAMES   @@ -75,9 +76,9 @@ function windowTitle()
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
@@ -108,7 +109,80 @@ The application control controls the settings for a new games and create the

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+private  GameControlgameControl + +
+           
+private  LoginControlloginControl + +
+           
+private  NetworkControlnetworkControl + +
+           
+private  SaveControlsaveControl + +
+           
+private  DedicatedServerserver + +
+           
+private  SettingsControlsettingsControl + +
+           
+private  ConnectiontempConnection + +
+           
+private  IViewview + +
+           
+  @@ -118,7 +192,7 @@ The application control controls the settings for a new games and create the Constructor Summary -ApplicationControl(jrummikub.view.IView view) +ApplicationControl(IView view)
          Creates a new application control @@ -135,6 +209,62 @@ The application control controls the settings for a new games and create the +private  void +abortControls() + +
+          End all controls in case of e.g. quit event + + + +private  void +addGameControlListeners(GameControl gameControl) + +
+          Adds events listeners to game control events + + + +private  void +addNewNetworkGameHandler() + +
+            + + + +private  void +addQuitGameHandlers() + +
+            + + + +private  void +addSaveLoadHandlers() + +
+            + + + +private  void +createLoginControl(boolean reset) + +
+          Create a new network login control + + + +private  void +createNetworkControl(LoginData loginData) + +
+          Create a new network game control + + +  boolean isGameRunning() @@ -143,6 +273,22 @@ The application control controls the settings for a new games and create the +private  void +showQuitWarning() + +
+            + + + +private  void +showRestartWarning() + +
+            + + +  void startApplication() @@ -160,7 +306,7 @@ The application control controls the settings for a new games and create the  void -updateDedicatedServerPassword(jrummikub.util.LoginData loginData) +updateDedicatedServerPassword(LoginData loginData)
          If the login given is to our own dedicated server, update it's password @@ -173,12 +319,101 @@ The application control controls the settings for a new games and create the Methods inherited from class java.lang.Object -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait  

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

+settingsControl

+
+private SettingsControl settingsControl
+
+
+
+
+
+ +

+loginControl

+
+private LoginControl loginControl
+
+
+
+
+
+ +

+networkControl

+
+private NetworkControl networkControl
+
+
+
+
+
+ +

+saveControl

+
+private SaveControl saveControl
+
+
+
+
+
+ +

+gameControl

+
+private GameControl gameControl
+
+
+
+
+
+ +

+tempConnection

+
+private Connection tempConnection
+
+
+
+
+
+ +

+server

+
+private DedicatedServer server
+
+
+
+
+
+ +

+view

+
+private IView view
+
+
+
+
+ @@ -192,7 +427,7 @@ The application control controls the settings for a new games and create the

ApplicationControl

-public ApplicationControl(jrummikub.view.IView view)
+public ApplicationControl(IView view)
Creates a new application control

@@ -210,6 +445,61 @@ public ApplicationControl(jrummikub.view.IView view) +

+addSaveLoadHandlers

+
+private void addSaveLoadHandlers()
+
+
+
+
+
+
+ +

+addNewNetworkGameHandler

+
+private void addNewNetworkGameHandler()
+
+
+
+
+
+
+ +

+addQuitGameHandlers

+
+private void addQuitGameHandlers()
+
+
+
+
+
+
+ +

+showRestartWarning

+
+private void showRestartWarning()
+
+
+
+
+
+
+ +

+showQuitWarning

+
+private void showQuitWarning()
+
+
+
+
+
+
+

isGameRunning

@@ -224,6 +514,32 @@ public boolean isGameRunning()
+

+createLoginControl

+
+private void createLoginControl(boolean reset)
+
+
Create a new network login control +

+

+
+
+
+
+ +

+abortControls

+
+private void abortControls()
+
+
End all controls in case of e.g. quit event +

+

+
+
+
+
+

startApplication

@@ -237,6 +553,32 @@ public void startApplication()
+

+addGameControlListeners

+
+private void addGameControlListeners(GameControl gameControl)
+
+
Adds events listeners to game control events +

+

+
Parameters:
gameControl - of current game
+
+
+
+ +

+createNetworkControl

+
+private void createNetworkControl(LoginData loginData)
+
+
Create a new network game control +

+

+
Parameters:
loginData - users login data for channel
+
+
+
+

startDedicatedServer

@@ -254,7 +596,7 @@ public boolean startDedicatedServer(java.lang.String password)

updateDedicatedServerPassword

-public void updateDedicatedServerPassword(jrummikub.util.LoginData loginData)
+public void updateDedicatedServerPassword(LoginData loginData)
If the login given is to our own dedicated server, update it's password to match @@ -276,7 +618,8 @@ public void updateDedicatedServerPassword(jrummikub.util.LoginData l - + + @@ -293,8 +636,8 @@ public void updateDedicatedServerPassword(jrummikub.util.LoginData l + PREV CLASS  + NEXT CLASS + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
Package  Overview  Package   Class  Use  Tree 
- PREV CLASS  - NEXT CLASS FRAMES    NO FRAMES   @@ -314,9 +657,9 @@ public void updateDedicatedServerPassword(jrummikub.util.LoginData l
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
diff --git a/doc/jrummikub/control/GameControl.html b/doc/jrummikub/control/GameControl.html index 1359550..1f3bf4b 100644 --- a/doc/jrummikub/control/GameControl.html +++ b/doc/jrummikub/control/GameControl.html @@ -2,12 +2,12 @@ - + GameControl - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS 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 @@ -95,6 +95,9 @@ Class GameControl java.lang.Object extended by jrummikub.control.GameControl +
+
Direct Known Subclasses:
NetworkGameControl
+
public class GameControl
extends java.lang.Object
@@ -108,7 +111,72 @@ Controls a Game, at some point including all Rounds, starts new Rounds

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  java.util.List<Connection>connections + +
+           
+protected  EventendOfGameEvent + +
+           
+protected  GameSettingsgameSettings +
+           
+protected  GameStategameState + +
+           
+protected  RoundControlroundControl + +
+           
+protected  SaveControlsaveControl + +
+           
+protected  IViewview + +
+           
+  @@ -118,7 +186,9 @@ Controls a Game, at some point including all Rounds, starts new Rounds Constructor Summary -GameControl(IView view) +GameControl(GameSettings gameSettings, + SaveControl saveControl, + IView view)
          Constructor @@ -136,11 +206,125 @@ Controls a Game, at some point including all Rounds, starts new Rounds  void +abortGame() + +
+          Clean abortion of a running game when another one is loaded or when a new + one is started + + + + void +continueGame(GameState gameState, + IRoundState roundState) + +
+          Continues game after loading + + + +protected  RoundControl +createRoundControl(IRoundState roundState) + +
+          Creates a new round control with the specified round state + + + +protected  IRoundState +createRoundState() + +
+          Creates a new round State + + + +private  void +endGame() + +
+          Ends the running game + + + +private  void +endOfRound(Score roundScore) + +
+          Sets the score and default values for saving when round ends + + + +private  void +endProgram() + +
+          Exits System without warnings if no game control is active + + + + IEvent +getEndOfGameEvent() + +
+          Is emitted when the user ends the game and start a new one + + + +private  void +prepareRound(IRoundState roundState) + +
+          Prepare a new round by setting start player, adding listeners + + + +private  void +removeListeners() + +
+          Removes all listeners from the connection + + + +private  void +restartRound() + +
+          Restarts round after redealing + + + +private  void +showScorePanel() + +
+          Sets score panel visible + + + +protected  void +showWinPanel() + +
+            + + + + void startGame()
          Game gets started by initializing the first Round + + +protected  void +startRound() + +
+          Start a new round within the existing game +   @@ -154,6 +338,85 @@ Controls a Game, at some point including all Rounds, starts new Rounds  

+ + + +

+ + + +
+Field Detail
+ +

+saveControl

+
+protected SaveControl saveControl
+
+
+
+
+
+ +

+gameSettings

+
+protected GameSettings gameSettings
+
+
+
+
+
+ +

+view

+
+protected IView view
+
+
+
+
+
+ +

+roundControl

+
+protected RoundControl roundControl
+
+
+
+
+
+ +

+gameState

+
+protected GameState gameState
+
+
+
+
+
+ +

+connections

+
+protected java.util.List<Connection> connections
+
+
+
+
+
+ +

+endOfGameEvent

+
+protected Event endOfGameEvent
+
+
+
+
+ @@ -164,15 +427,17 @@ Controls a Game, at some point including all Rounds, starts new Rounds -

+

GameControl

-public GameControl(IView view)
+public GameControl(GameSettings gameSettings, + SaveControl saveControl, + IView view)
Constructor

-
Parameters:
view - the view
+
Parameters:
gameSettings - the game settings
saveControl - the save control
view - the view
@@ -185,6 +450,46 @@ public GameControl(

+getEndOfGameEvent

+
+public IEvent getEndOfGameEvent()
+
+
Is emitted when the user ends the game and start a new one +

+

+ +
Returns:
the endOfGameEvent
+
+
+
+ +

+endGame

+
+private void endGame()
+
+
Ends the running game +

+

+
+
+
+
+ +

+removeListeners

+
+private void removeListeners()
+
+
Removes all listeners from the connection +

+

+
+
+
+
+

startGame

@@ -196,6 +501,151 @@ public void startGame()
+
+ +

+continueGame

+
+public void continueGame(GameState gameState,
+                         IRoundState roundState)
+
+
Continues game after loading +

+

+
Parameters:
gameState - the saved GameState (Players, startplayer, points)
roundState - the saved RoundState (activePlayer, Table, heap etc)
+
+
+
+ +

+abortGame

+
+public void abortGame()
+
+
Clean abortion of a running game when another one is loaded or when a new + one is started +

+

+
+
+
+
+ +

+startRound

+
+protected void startRound()
+
+
Start a new round within the existing game +

+

+
+
+
+
+ +

+prepareRound

+
+private void prepareRound(IRoundState roundState)
+
+
Prepare a new round by setting start player, adding listeners +

+

+
Parameters:
roundState - of current round
+
+
+
+ +

+createRoundState

+
+protected IRoundState createRoundState()
+
+
Creates a new round State +

+

+ +
Returns:
the round state
+
+
+
+ +

+createRoundControl

+
+protected RoundControl createRoundControl(IRoundState roundState)
+
+
Creates a new round control with the specified round state +

+

+
Parameters:
roundState - for new round control +
Returns:
the round control
+
+
+
+ +

+restartRound

+
+private void restartRound()
+
+
Restarts round after redealing +

+

+
+
+
+
+ +

+endOfRound

+
+private void endOfRound(Score roundScore)
+
+
Sets the score and default values for saving when round ends +

+

+
Parameters:
roundScore - score for ended round
+
+
+
+ +

+showScorePanel

+
+private void showScorePanel()
+
+
Sets score panel visible +

+

+
+
+
+
+ +

+showWinPanel

+
+protected void showWinPanel()
+
+
+
+
+
+
+ +

+endProgram

+
+private void endProgram()
+
+
Exits System without warnings if no game control is active +

+

+
+
+
@@ -227,7 +677,7 @@ public void startGame() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -248,9 +698,9 @@ public void startGame() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/jrummikub/control/ITurnTimer.html b/doc/jrummikub/control/ITurnTimer.html index 70e6910..25cc840 100644 --- a/doc/jrummikub/control/ITurnTimer.html +++ b/doc/jrummikub/control/ITurnTimer.html @@ -2,12 +2,12 @@ - + ITurnTimer - + @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -224,7 +224,7 @@ getTimeRunOutEvent  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/doc/jrummikub/control/RoundControl.html b/doc/jrummikub/control/RoundControl.html index b6a8501..4fce933 100644 --- a/doc/jrummikub/control/RoundControl.html +++ b/doc/jrummikub/control/RoundControl.html @@ -2,12 +2,12 @@ - + RoundControl - + @@ -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 @@ -95,6 +95,9 @@ Class RoundControl java.lang.Object extended by jrummikub.control.RoundControl +
+
Direct Known Subclasses:
NetworkRoundControl
+
public class RoundControl
extends java.lang.Object
@@ -108,7 +111,107 @@ Controller that manages a single round of rummikub

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classRoundControl.InvalidTurnInfo + +
+          Table, stone sets and type of an invalid turn to allow a user to track his + own errors
+static classRoundControl.InvalidTurnType + +
+          Enum summarizing the different types of invalid turns to set the correct + panel message
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+protected  java.util.List<Connection>connections + +
+           
+private  Event1<Score>endOfRoundEvent + +
+           
+private  booleanmayPause + +
+           
+private  Event1<PlayerSettings>restartRoundEvent + +
+           
+protected  IRoundStateroundState +
+           
+private  Event1<IRoundState>roundStateUpdateEvent + +
+           
+private  ITurnControlturnControl + +
+           
+private  IViewview + +
+           
+  @@ -118,11 +221,23 @@ Controller that manages a single round of rummikub Constructor Summary -RoundControl(IGameState gameState, + +  +RoundControl(IRoundState roundState, IView view)
-          Create a new RoundControl using the given gameState and view +          Create a new RoundControl using the given roundState and view + + + +protected +RoundControl(IRoundState roundState, + IView view, + boolean mayPause) + +
+          Create a new RoundControl using the given roundState and view   @@ -136,30 +251,153 @@ Controller that manages a single round of rummikub -(package private)  void + void +abortRound() + +
+          Abort round if a new one is started or a saved one is loaded + + + +protected  void +addTurnControlListeners(ITurnControl turnControl) + +
+          Override this + + + + void +continueRound() + +
+          Continue a saved round after loading + + + +protected  ITurnControl +createTurnControl() + +
+          Creates new turn control of the specified type + + + +protected  void deal()
-            +          Deal each player the number of stones specified in the game settings + (numberOfStonesDealt) + + + +protected  void +doPrepareTurn() + +
+          Prepare turn by setting the view components (package private)  void -dealStone() +endOfRound()
-            +          Ends the current round and emits an event setting the score - IEvent -getEndRoundEvent() +protected  void +endOfTurn(RoundControl.InvalidTurnInfo invalidTurnInfo) + +
+          End the players turn + + + + IEvent1<Score> +getEndOfRoundEvent()
          End the round + IEvent1<PlayerSettings> +getRestartRoundEvent() + +
+          Emitted when the round is aborted and needs to be restarted + + + + IEvent1<IRoundState> +getRoundStateUpdateEvent() + +
+          Is emitted in network when a new turn starts + + + +protected  void +nextPlayer() + +
+          Set the next player as active player if the round is not finished + + + +protected  void +prepareTurn() + +
+          Prepare a player's turn by checking the player types and setting the + correct turn control + + + +protected  void +redeal() + +
+          Redeal stones and restart round if a player was allowed to redeal and chose + to do so + + + +private  void +removeListeners() + +
+          Removes all listeners form the connections + + + +private  Score +score() + +
+          Calculate the score for the current round and the total game score + + + +protected  void +setRoundState(IRoundState state) + +
+          Sets the current round state + + + +protected  IView.BottomPanelType +showStartTurnPanel() + +
+            + + +  void startRound() @@ -168,12 +406,30 @@ Controller that manages a single round of rummikub -(package private) static java.util.Set<Stone> -tableDifference(ITable oldTable, - ITable newTable) +protected  void +startTurn()
-            +          Start a players turn with the correct turn control + + + +private static Pair<java.lang.Integer,java.lang.Integer> +updateBestScore(Pair<java.lang.Integer,java.lang.Integer> bestScore, + int stonePoints, + int size) + +
+          Update the best score to find the winner in case of special game end + (everybody still has stones on hand) + + + +private  void +updateSidePanel() + +
+          Update the side panel to show correct player order and heap size   @@ -188,6 +444,95 @@ Controller that manages a single round of rummikub  

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

+turnControl

+
+private ITurnControl turnControl
+
+
+
+
+
+ +

+roundState

+
+protected IRoundState roundState
+
+
+
+
+
+ +

+view

+
+private IView view
+
+
+
+
+
+ +

+restartRoundEvent

+
+private Event1<PlayerSettings> restartRoundEvent
+
+
+
+
+
+ +

+roundStateUpdateEvent

+
+private Event1<IRoundState> roundStateUpdateEvent
+
+
+
+
+
+ +

+endOfRoundEvent

+
+private Event1<Score> endOfRoundEvent
+
+
+
+
+
+ +

+connections

+
+protected java.util.List<Connection> connections
+
+
+
+
+
+ +

+mayPause

+
+private boolean mayPause
+
+
+
+
+ @@ -198,16 +543,30 @@ Controller that manages a single round of rummikub -

+

RoundControl

-public RoundControl(IGameState gameState,
+public RoundControl(IRoundState roundState,
                     IView view)
-
Create a new RoundControl using the given gameState and view +
Create a new RoundControl using the given roundState and view +

+

+
Parameters:
roundState - initial round state
view - view used for user interaction
+
+
+ +

+RoundControl

+
+protected RoundControl(IRoundState roundState,
+                       IView view,
+                       boolean mayPause)
+
+
Create a new RoundControl using the given roundState and view

-
Parameters:
gameState - initial game state
view - view used for user interaction
+
Parameters:
roundState - initial round state
view - view used for user interaction
mayPause - true when players are allowed to pause
@@ -220,16 +579,30 @@ public RoundControl( -

-getEndRoundEvent

+

+getRoundStateUpdateEvent

+
+public IEvent1<IRoundState> getRoundStateUpdateEvent()
+
+
Is emitted in network when a new turn starts +

+

+ +
Returns:
the event
+
+
+
+ +

+getEndOfRoundEvent

-public IEvent getEndRoundEvent()
+public IEvent1<Score> getEndOfRoundEvent()
End the round

-
Returns:
endRoundEvent
+
Returns:
endOfRoundEvent
@@ -247,34 +620,255 @@ public void startRound()
+

+continueRound

+
+public void continueRound()
+
+
Continue a saved round after loading +

+

+
+
+
+
+ +

+abortRound

+
+public void abortRound()
+
+
Abort round if a new one is started or a saved one is loaded +

+

+
+
+
+
+ +

+setRoundState

+
+protected void setRoundState(IRoundState state)
+
+
Sets the current round state +

+

+
Parameters:
state - to be set
+
+
+
+ +

+showStartTurnPanel

+
+protected IView.BottomPanelType showStartTurnPanel()
+
+
+
+
+
+
+ +

+prepareTurn

+
+protected void prepareTurn()
+
+
Prepare a player's turn by checking the player types and setting the + correct turn control +

+

+
+
+
+
+ +

+doPrepareTurn

+
+protected void doPrepareTurn()
+
+
Prepare turn by setting the view components +

+

+
+
+
+
+ +

+startTurn

+
+protected void startTurn()
+
+
Start a players turn with the correct turn control +

+

+
+
+
+
+ +

+updateSidePanel

+
+private void updateSidePanel()
+
+
Update the side panel to show correct player order and heap size +

+

+
+
+
+
+ +

+addTurnControlListeners

+
+protected void addTurnControlListeners(ITurnControl turnControl)
+
+
Override this +

+

+
Parameters:
turnControl - current turn control
+
+
+
+ +

+createTurnControl

+
+protected ITurnControl createTurnControl()
+
+
Creates new turn control of the specified type +

+

+ +
Returns:
the new turn control
+
+
+
+

deal

-void deal()
+protected void deal()
+
Deal each player the number of stones specified in the game settings + (numberOfStonesDealt) +

-

-tableDifference

+

+endOfTurn

-static java.util.Set<Stone> tableDifference(ITable oldTable,
-                                            ITable newTable)
+protected void endOfTurn(RoundControl.InvalidTurnInfo invalidTurnInfo)
+
End the players turn +

+
Parameters:
invalidTurnInfo - info about the player's last turn
+
+
+ +

+nextPlayer

+
+protected void nextPlayer()
+
+
Set the next player as active player if the round is not finished +

+

+
+
+
+
+ +

+endOfRound

+
+void endOfRound()
+
+
Ends the current round and emits an event setting the score +

+

+
+
+
+
+ +

+removeListeners

+
+private void removeListeners()
+
+
Removes all listeners form the connections +

+

+
+
+
+
+ +

+score

+
+private Score score()
+
+
Calculate the score for the current round and the total game score +

+

+ +
Returns:
the new score
+
+
+
+ +

+updateBestScore

+
+private static Pair<java.lang.Integer,java.lang.Integer> updateBestScore(Pair<java.lang.Integer,java.lang.Integer> bestScore,
+                                                                         int stonePoints,
+                                                                         int size)
+
+
Update the best score to find the winner in case of special game end + (everybody still has stones on hand) +

+

+
Parameters:
bestScore - of previous rounds
stonePoints - sum of points still left on hands
size - number of players in game (= size of score list in columns) +
Returns:
Pair of maximum points and hand size
+
+
+
+ +

+getRestartRoundEvent

+
+public IEvent1<PlayerSettings> getRestartRoundEvent()
+
+
Emitted when the round is aborted and needs to be restarted +

+

+ +
Returns:
the event
-

-dealStone

+

+redeal

-void dealStone()
+protected void redeal()
+
Redeal stones and restart round if a player was allowed to redeal and chose + to do so +

@@ -310,8 +904,8 @@ void dealStone() - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS FRAMES    NO FRAMES   @@ -331,9 +925,9 @@ void dealStone() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/jrummikub/control/TurnTimer.html b/doc/jrummikub/control/TurnTimer.html index 42bd298..f65eb7d 100644 --- a/doc/jrummikub/control/TurnTimer.html +++ b/doc/jrummikub/control/TurnTimer.html @@ -2,12 +2,12 @@ - + TurnTimer - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS 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 @@ -111,7 +111,56 @@ Count-down timer used to limit the turn time

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+private  inttimeLeft + +
+           
+private  javax.swing.Timertimer + +
+           
+private  EventtimeRunOutEvent + +
+           
+private  inttotalTime + +
+           
+private  IViewview + +
+           
+  @@ -121,7 +170,8 @@ Count-down timer used to limit the turn time Constructor Summary -TurnTimer(IView view) +TurnTimer(IView view, + int totalTime)
          Create a new timer using a given view to display the current time left @@ -181,6 +231,65 @@ Count-down timer used to limit the turn time  

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

+view

+
+private IView view
+
+
+
+
+
+ +

+timeLeft

+
+private int timeLeft
+
+
+
+
+
+ +

+totalTime

+
+private int totalTime
+
+
+
+
+
+ +

+timer

+
+private javax.swing.Timer timer
+
+
+
+
+
+ +

+timeRunOutEvent

+
+private Event timeRunOutEvent
+
+
+
+
+ @@ -191,15 +300,16 @@ Count-down timer used to limit the turn time -

+

TurnTimer

-public TurnTimer(IView view)
+public TurnTimer(IView view, + int totalTime)
Create a new timer using a given view to display the current time left

-
Parameters:
view - view to display
+
Parameters:
view - view to display
totalTime - total time for turn
@@ -307,7 +417,7 @@ public - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -328,9 +438,9 @@ public - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/jrummikub/control/class-use/ApplicationControl.html b/doc/jrummikub/control/class-use/ApplicationControl.html index 66a799a..1ff6a66 100644 --- a/doc/jrummikub/control/class-use/ApplicationControl.html +++ b/doc/jrummikub/control/class-use/ApplicationControl.html @@ -2,12 +2,12 @@ - + Uses of Class jrummikub.control.ApplicationControl - + @@ -37,7 +37,8 @@ function windowTitle() - + + @@ -82,7 +83,58 @@ function windowTitle()

Uses of Class
jrummikub.control.ApplicationControl

-No usage of jrummikub.control.ApplicationControl + +
Package  Overview  Package  Class   Use  Tree 
+ + + + + + + +
+Packages that use ApplicationControl
jrummikub.control  
+  +

+ + + + + +
+Uses of ApplicationControl in jrummikub.control
+  +

+ + + + + + + + + +
Fields in jrummikub.control declared as ApplicationControl
+private  ApplicationControlLoginControl.appControl + +
+           
+  +

+ + + + + + + + +
Constructors in jrummikub.control with parameters of type ApplicationControl
LoginControl(IView view, + ApplicationControl applicationControl) + +
+          Constructor for login Control
+ 

@@ -96,7 +148,8 @@ No usage of jrummikub.control.ApplicationControl - + + diff --git a/doc/jrummikub/control/class-use/GameControl.html b/doc/jrummikub/control/class-use/GameControl.html index ddc8911..15980ba 100644 --- a/doc/jrummikub/control/class-use/GameControl.html +++ b/doc/jrummikub/control/class-use/GameControl.html @@ -2,12 +2,12 @@ - + Uses of Class jrummikub.control.GameControl - + @@ -83,7 +83,88 @@ function windowTitle()

Uses of Class
jrummikub.control.GameControl

-No usage of jrummikub.control.GameControl + +
Package  Overview  Package  Class   Use  Tree 
+ + + + + + + + + + + +
+Packages that use GameControl
jrummikub.control  
jrummikub.control.network  
+  +

+ + + + + +
+Uses of GameControl in jrummikub.control
+  +

+ + + + + + + + + +
Fields in jrummikub.control declared as GameControl
+private  GameControlApplicationControl.gameControl + +
+           
+  +

+ + + + + + + + + +
Methods in jrummikub.control with parameters of type GameControl
+private  voidApplicationControl.addGameControlListeners(GameControl gameControl) + +
+          Adds events listeners to game control events
+  +

+ + + + + +
+Uses of GameControl in jrummikub.control.network
+  +

+ + + + + + + + + +
Subclasses of GameControl in jrummikub.control.network
+ classNetworkGameControl + +
+          Class controlling network games
+ 

diff --git a/doc/jrummikub/control/class-use/ITurnTimer.html b/doc/jrummikub/control/class-use/ITurnTimer.html index bf6b79f..296fb37 100644 --- a/doc/jrummikub/control/class-use/ITurnTimer.html +++ b/doc/jrummikub/control/class-use/ITurnTimer.html @@ -2,12 +2,12 @@ - + Uses of Interface jrummikub.control.ITurnTimer - + @@ -93,6 +93,10 @@ Packages that use jrummikub.control    + +jrummikub.control.turn +   +  

@@ -121,16 +125,38 @@ Uses of + + + + +
+Uses of ITurnTimer in jrummikub.control.turn
+  +

+ + + + + + + + + +
Fields in jrummikub.control.turn declared as ITurnTimer
+protected  ITurnTimerAbstractTurnControl.timer + +
+           
+  +

- + - diff --git a/doc/jrummikub/control/class-use/RoundControl.html b/doc/jrummikub/control/class-use/RoundControl.html index eb8d850..ff58ab9 100644 --- a/doc/jrummikub/control/class-use/RoundControl.html +++ b/doc/jrummikub/control/class-use/RoundControl.html @@ -2,12 +2,12 @@ - + Uses of Class jrummikub.control.RoundControl - + @@ -83,7 +83,104 @@ function windowTitle()

Uses of Class
jrummikub.control.RoundControl

-No usage of jrummikub.control.RoundControl + +
Constructors in jrummikub.control with parameters of type ITurnTimerConstructors in jrummikub.control.turn with parameters of type ITurnTimer
TurnControl(IHand hand, - ITable table, - IView view, - ITurnTimer testTimer) +HumanTurnControl(ITurnTimer testTimer)
          Test only constructor
+ + + + + + + + + + + +
+Packages that use RoundControl
jrummikub.control  
jrummikub.control.network  
+  +

+ + + + + +
+Uses of RoundControl in jrummikub.control
+  +

+ + + + + + + + + +
Fields in jrummikub.control declared as RoundControl
+protected  RoundControlGameControl.roundControl + +
+           
+  +

+ + + + + + + + + +
Methods in jrummikub.control that return RoundControl
+protected  RoundControlGameControl.createRoundControl(IRoundState roundState) + +
+          Creates a new round control with the specified round state
+  +

+ + + + + +
+Uses of RoundControl in jrummikub.control.network
+  +

+ + + + + + + + + +
Subclasses of RoundControl in jrummikub.control.network
+ classNetworkRoundControl + +
+          Round control for network games
+  +

+ + + + + + + + + +
Methods in jrummikub.control.network that return RoundControl
+protected  RoundControlNetworkGameControl.createRoundControl(IRoundState roundState) + +
+           
+ 

diff --git a/doc/jrummikub/control/class-use/TurnTimer.html b/doc/jrummikub/control/class-use/TurnTimer.html index 16b27db..fec7a3a 100644 --- a/doc/jrummikub/control/class-use/TurnTimer.html +++ b/doc/jrummikub/control/class-use/TurnTimer.html @@ -2,12 +2,12 @@ - + Uses of Class jrummikub.control.TurnTimer - + diff --git a/doc/jrummikub/control/package-frame.html b/doc/jrummikub/control/package-frame.html index 002929f..f230cef 100644 --- a/doc/jrummikub/control/package-frame.html +++ b/doc/jrummikub/control/package-frame.html @@ -2,12 +2,12 @@ - + jrummikub.control - + @@ -34,18 +34,37 @@ Interfaces  Classes 
+AbstractSettingsControl +
+ApplicationControl +
GameControl
+LoginControl +
RoundControl
-TurnControl +RoundControl.InvalidTurnInfo +
+SaveControl
-TurnControl.HandStonePositionComparator +SettingsControl
TurnTimer + + + + +
+Enums  + +
+RoundControl.InvalidTurnType
+ + diff --git a/doc/jrummikub/control/package-summary.html b/doc/jrummikub/control/package-summary.html index 1091c76..ca6f66d 100644 --- a/doc/jrummikub/control/package-summary.html +++ b/doc/jrummikub/control/package-summary.html @@ -2,12 +2,12 @@ - + jrummikub.control - + @@ -55,8 +55,8 @@ function windowTitle() - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   @@ -103,20 +103,39 @@ Package jrummikub.control Class Summary +AbstractSettingsControl +Abstract control class managing joined methods and attributes of all + different (network, default...) settings controls + + +ApplicationControl +The application control controls the settings for a new games and create the + game control + + GameControl Controls a Game, at some point including all Rounds, starts new Rounds +LoginControl +Control checking and processing login data for network game + + RoundControl Controller that manages a single round of rummikub -TurnControl -Controller for a single turn made by a human player +RoundControl.InvalidTurnInfo +Table, stone sets and type of an invalid turn to allow a user to track his + own errors + + +SaveControl +The save control is responsible for loading and saving game and round states -TurnControl.HandStonePositionComparator -  +SettingsControl +The settings control controls the settings panel TurnTimer @@ -125,6 +144,21 @@ Package jrummikub.control   +

+ + + + + + + + + +
+Enum Summary
RoundControl.InvalidTurnTypeEnum summarizing the different types of invalid turns to set the correct + panel message
+  +

@@ -158,8 +192,8 @@ Package jrummikub.control - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   diff --git a/doc/jrummikub/control/package-tree.html b/doc/jrummikub/control/package-tree.html index 59c2f2a..b89ea75 100644 --- a/doc/jrummikub/control/package-tree.html +++ b/doc/jrummikub/control/package-tree.html @@ -2,12 +2,12 @@ - + jrummikub.control Class Hierarchy - + @@ -55,8 +55,8 @@ function windowTitle() - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   @@ -92,8 +92,10 @@ Class Hierarchy

@@ -101,6 +103,16 @@ Interface Hierarchy

+

+Enum Hierarchy +

+
    +
  • java.lang.Object +
@@ -131,8 +143,8 @@ Interface Hierarchy - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   diff --git a/doc/jrummikub/control/package-use.html b/doc/jrummikub/control/package-use.html index 39dddbe..924169b 100644 --- a/doc/jrummikub/control/package-use.html +++ b/doc/jrummikub/control/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package jrummikub.control - + @@ -93,6 +93,14 @@ Packages that use jrummik jrummikub.control    + +jrummikub.control.network +   + + +jrummikub.control.turn +   +  

@@ -103,11 +111,132 @@ Packages that use jrummik Classes in jrummikub.control used by jrummikub.control +AbstractSettingsControl + +
+          Abstract control class managing joined methods and attributes of all + different (network, default...) settings controls + + +ApplicationControl + +
+          The application control controls the settings for a new games and create the + game control + + +GameControl + +
+          Controls a Game, at some point including all Rounds, starts new Rounds + + ITurnTimer
          Interface for the TurnTimer + +LoginControl + +
+          Control checking and processing login data for network game + + +RoundControl + +
+          Controller that manages a single round of rummikub + + +RoundControl.InvalidTurnInfo + +
+          Table, stone sets and type of an invalid turn to allow a user to track his + own errors + + +RoundControl.InvalidTurnType + +
+          Enum summarizing the different types of invalid turns to set the correct + panel message + + +SaveControl + +
+          The save control is responsible for loading and saving game and round states + + +SettingsControl + +
+          The settings control controls the settings panel + + +  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.control used by jrummikub.control.network
AbstractSettingsControl + +
+          Abstract control class managing joined methods and attributes of all + different (network, default...) settings controls
GameControl + +
+          Controls a Game, at some point including all Rounds, starts new Rounds
RoundControl + +
+          Controller that manages a single round of rummikub
RoundControl.InvalidTurnInfo + +
+          Table, stone sets and type of an invalid turn to allow a user to track his + own errors
SaveControl + +
+          The save control is responsible for loading and saving game and round states
+  +

+ + + + + + + + + + +
+Classes in jrummikub.control used by jrummikub.control.turn
ITurnTimer + +
+          Interface for the TurnTimer
RoundControl.InvalidTurnInfo + +
+          Table, stone sets and type of an invalid turn to allow a user to track his + own errors
 

-- cgit v1.2.3