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/IView.html | 991 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 954 insertions(+), 37 deletions(-) (limited to 'doc/jrummikub/view/IView.html') diff --git a/doc/jrummikub/view/IView.html b/doc/jrummikub/view/IView.html index 08645c5..868a641 100644 --- a/doc/jrummikub/view/IView.html +++ b/doc/jrummikub/view/IView.html @@ -2,12 +2,12 @@ - + IView - + @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -76,7 +76,7 @@ function windowTitle() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD @@ -107,7 +107,24 @@ The top-level view interface

+ + + + + + + + + + +
+Nested Class Summary
+static classIView.BottomPanelType + +
+          Different types of bottom panels
+  @@ -119,18 +136,129 @@ The top-level view interface  void -enableStartTurnPanel(boolean enable) +clearView() + +
+          Hides all view elements and panels except for the cleared table and an + empty hand panel + + + + void +enablePauseMode(boolean enable)
-          Enables or disables the player's StartTurnPanel +          Enable/disable pause mode  void -enableWinPanel(boolean enable) +enableSave(boolean enable) + +
+          Enables/disables saving in menu bar + + + + IEvent +getAcknowledgeConnectionLostEvent() + +
+          The acknoledge connection lost event is emitted when the user has + acknowledged that the network connection was lost + + + + IEvent +getAcknowledgeInvalidEvent() + +
+          The start turn event is emitted when the player knows what invalid stones + he played + + + + IConnectPanel +getConnectPanel() + +
+          Getter for connect panel + + + + IEvent +getEndPauseEvent() + +
+          The end pause event is emitted when the user wants to sresume the game + after a pause + + + + IEvent +getEndProgramEvent() + +
+          The quit event is emitted when the player wants to quit the game + + + + IGameListPanel +getGameListPanel() + +
+          Getter for game list panel + + + + IHandPanel +getHandPanel() + +
+            + + + + IEvent +getLoadEvent() + +
+          The load event is emitted when the user wants to load a previously saved + game state + + + + IEvent1<java.io.File> +getLoadFileEvent() + +
+          The load file event is emitted when the user chose to discard the current + game to save another + + + + ILoginPanel +getLoginPanel() + +
+          Getter for login panel + + + + IEvent +getMenuNewGameEvent() + +
+          The menu new game event is emitted when the user selects the new game menu + entry + + + + IEvent +getNetworkGameEvent()
-          Enables or disables the panel shown when a player has won +          The network game event is emitted when the user chooses a network game @@ -138,7 +266,23 @@ The top-level view interface getNewGameEvent()
-          The new game event is emitted when the player wants to start a new game +          Is emitted if the player wants to end the game and start a new one + + + + IEvent +getNewRoundEvent() + +
+          The new round event is emitted when the player wants to start a new round + + + + IEvent +getPauseEvent() + +
+          The pause event is emitted when the user wants to pause the current turn @@ -154,7 +298,48 @@ The top-level view interface getQuitEvent()
-          The quit event is emitted when the player wants to quit the game +          The quit event is emitted when the user wants to leave the application + + + + IQuitWarningPanel +getQuitWarningPanel() + +
+          Getter for quit warning panel + + + + IEvent1<java.io.File> +getSaveEvent() + +
+          The save event is emitted when the user wants to save the current game + state + + + + IScorePanel +getScorePanel() + +
+          Returns the score panel + + + + ISettingsPanel +getSettingsPanel() + +
+          Returns the settings panel + + + + ISidePanel +getSidePanel() + +
+          Returns the side panel @@ -175,6 +360,48 @@ The top-level view interface  void +load() + +
+          Loading a game + + + + void +resetLoginPanel() + +
+          Clears user input of the resetLoginPanel + + + + void +setBottomPanel(IView.BottomPanelType type) + +
+          Sets the bottom panels type + + + + void +setCurrentPlayerColor(java.awt.Color color) + +
+          Is used for the PlayerPanel and ScorePanel to display a player's color + along with the name + + + + void +setCurrentPlayerHasLaidOut(boolean hasLaidOut) + +
+          Is used for the PlayerPanel to display if a player has laid out along with + the name + + + + void setCurrentPlayerName(java.lang.String playerName)
@@ -183,11 +410,140 @@ The top-level view interface  void +setInitialMeldError(int points) + +
+          Is set if a player tried to lay out less than initial meld threshold + + + + void +setInitialMeldFirstError() + +
+          Is set if the player tried to modify the table without laying out first + + + + void +setInvalidStoneSets(java.util.Collection<StoneSet> sets) + +
+          Set invalid sets to enable showing + + + + void +setLastStonePlayerName(java.lang.String name) + +
+          Sets the name of the player that has drawn the last stone + + + + void +setMayPause(boolean mayPause) + +
+          Sets the pause button if pausing should be possible in the current + situation + + + + void +setRedealedPlayerName(java.lang.String name) + +
+          Sets the name of the player that has redealt last + + + + void setSelectedStones(java.util.Collection<Stone> stones)
          Sets the stones that are to be painted selected + + + void +setStoneCollectionHidden(boolean enable) + +
+          Show stone collection + + + + void +showConnectPanel(boolean show) + +
+          Set the connect panel visible + + + + void +showGameListPanel(boolean show) + +
+          Show/hide game list panel + + + + void +showLoadingError() + +
+          Show when loading is unsuccessful + + + + void +showLoginPanel(boolean show) + +
+          Show/hide login panel + + + + void +showQuitWarningPanel(boolean show) + +
+          Sets the quit warning panel visible + + + + void +showScorePanel(boolean show) + +
+          Shows or hides the score panel + + + + void +showServerStartupError(boolean alreadyRunning) + +
+          Show an error message when the server couldn't be started + + + + void +showSettingsPanel(boolean show) + +
+          Shows or hides the game settings panel + + + + void +showSidePanel(boolean show) + +
+          Show/hide side panel +  

@@ -202,22 +558,76 @@ The top-level view interface -

-getTablePanel

+

+getSettingsPanel

-ITablePanel getTablePanel()
+ISettingsPanel getSettingsPanel()
-
Returns the table +
Returns the settings panel

-
Returns:
the table
+
Returns:
the settings panel
-

-getPlayerPanel

+

+getScorePanel

+
+IScorePanel getScorePanel()
+
+
Returns the score panel +

+

+ +
Returns:
the score panel
+
+
+
+ +

+getTablePanel

+
+ITablePanel getTablePanel()
+
+
Returns the table +

+

+ +
Returns:
the table
+
+
+
+ +

+getSidePanel

+
+ISidePanel getSidePanel()
+
+
Returns the side panel +

+

+ +
Returns:
the side panel
+
+
+
+ +

+getHandPanel

+
+IHandPanel getHandPanel()
+
+
+ +
Returns:
the board where the players hand stones are displayed
+
+
+
+ +

+getPlayerPanel

 IPlayerPanel getPlayerPanel()
@@ -243,6 +653,32 @@ void setCurrentPlayerName(java.lang.String playerName)
+

+setRedealedPlayerName

+
+void setRedealedPlayerName(java.lang.String name)
+
+
Sets the name of the player that has redealt last +

+

+
Parameters:
name - the player name
+
+
+
+ +

+setLastStonePlayerName

+
+void setLastStonePlayerName(java.lang.String name)
+
+
Sets the name of the player that has drawn the last stone +

+

+
Parameters:
name - the player name
+
+
+
+

setSelectedStones

@@ -256,25 +692,27 @@ void setSelectedStones(java.util.Collection<

-enableStartTurnPanel

+

+getStartTurnEvent

 
-void enableStartTurnPanel(boolean enable)

+IEvent getStartTurnEvent()
-
Enables or disables the player's StartTurnPanel +
The start turn event is emitted when the player wants to start his turn

-
Parameters:
enable - enable/disable
+ +
Returns:
the event
-

-getStartTurnEvent

+

+getAcknowledgeInvalidEvent

-IEvent getStartTurnEvent()
+IEvent getAcknowledgeInvalidEvent()
-
The start turn event is emitted when the player wants to start his turn +
The start turn event is emitted when the player knows what invalid stones + he played

@@ -283,23 +721,25 @@ getStartTurnEvent
-

-enableWinPanel

+

+getAcknowledgeConnectionLostEvent

-void enableWinPanel(boolean enable)
+IEvent getAcknowledgeConnectionLostEvent()
-
Enables or disables the panel shown when a player has won +
The acknoledge connection lost event is emitted when the user has + acknowledged that the network connection was lost

-
Parameters:
enable - enable/disable
+ +
Returns:
the event
-

-getQuitEvent

+

+getEndProgramEvent

-IEvent getQuitEvent()
+IEvent getEndProgramEvent()
The quit event is emitted when the player wants to quit the game

@@ -310,18 +750,495 @@ getQuitEvent

+

+getNewRoundEvent

+
+IEvent getNewRoundEvent()
+
+
The new round event is emitted when the player wants to start a new round +

+

+ +
Returns:
the event
+
+
+
+ +

+showSettingsPanel

+
+void showSettingsPanel(boolean show)
+
+
Shows or hides the game settings panel +

+

+
Parameters:
show - specifies if the panel shall be shown or hidden
+
+
+
+ +

+showScorePanel

+
+void showScorePanel(boolean show)
+
+
Shows or hides the score panel +

+

+
Parameters:
show - specifies if the panel shall be shown or hidden
+
+
+
+ +

+setCurrentPlayerColor

+
+void setCurrentPlayerColor(java.awt.Color color)
+
+
Is used for the PlayerPanel and ScorePanel to display a player's color + along with the name +

+

+
Parameters:
color - the current player's color
+
+
+
+ +

+setCurrentPlayerHasLaidOut

+
+void setCurrentPlayerHasLaidOut(boolean hasLaidOut)
+
+
Is used for the PlayerPanel to display if a player has laid out along with + the name +

+

+
Parameters:
hasLaidOut - specifies if the current player has laid out or not
+
+
+
+

getNewGameEvent

 IEvent getNewGameEvent()
-
The new game event is emitted when the player wants to start a new game +
Is emitted if the player wants to end the game and start a new one +

+

+ +
Returns:
newGameEvent
+
+
+
+ +

+setBottomPanel

+
+void setBottomPanel(IView.BottomPanelType type)
+
+
Sets the bottom panels type +

+

+
Parameters:
type - the type of the bottom panel
+
+
+
+ +

+getMenuNewGameEvent

+
+IEvent getMenuNewGameEvent()
+
+
The menu new game event is emitted when the user selects the new game menu + entry +

+

+ +
Returns:
the event
+
+
+
+ +

+getLoadEvent

+
+IEvent getLoadEvent()
+
+
The load event is emitted when the user wants to load a previously saved + game state +

+

+ +
Returns:
the event
+
+
+
+ +

+getSaveEvent

+
+IEvent1<java.io.File> getSaveEvent()
+
+
The save event is emitted when the user wants to save the current game + state +

+

+ +
Returns:
the event
+
+
+
+ +

+getPauseEvent

+
+IEvent getPauseEvent()
+
+
The pause event is emitted when the user wants to pause the current turn +

+

+ +
Returns:
the event
+
+
+
+ +

+getEndPauseEvent

+
+IEvent getEndPauseEvent()
+
+
The end pause event is emitted when the user wants to sresume the game + after a pause +

+

+ +
Returns:
the event
+
+
+
+ +

+clearView

+
+void clearView()
+
+
Hides all view elements and panels except for the cleared table and an + empty hand panel +

+

+
+
+
+
+ +

+getNetworkGameEvent

+
+IEvent getNetworkGameEvent()
+
+
The network game event is emitted when the user chooses a network game

Returns:
the event
+
+ +

+getLoginPanel

+
+ILoginPanel getLoginPanel()
+
+
Getter for login panel +

+

+ +
Returns:
login panel
+
+
+
+ +

+getGameListPanel

+
+IGameListPanel getGameListPanel()
+
+
Getter for game list panel +

+

+ +
Returns:
game list panel
+
+
+
+ +

+showLoginPanel

+
+void showLoginPanel(boolean show)
+
+
Show/hide login panel +

+

+
Parameters:
show - true = login panel is shown
+
+
+
+ +

+resetLoginPanel

+
+void resetLoginPanel()
+
+
Clears user input of the resetLoginPanel +

+

+
+
+
+
+ +

+enablePauseMode

+
+void enablePauseMode(boolean enable)
+
+
Enable/disable pause mode +

+

+
Parameters:
enable - true = enable
+
+
+
+ +

+showGameListPanel

+
+void showGameListPanel(boolean show)
+
+
Show/hide game list panel +

+

+
Parameters:
show - true = show
+
+
+
+ +

+showSidePanel

+
+void showSidePanel(boolean show)
+
+
Show/hide side panel +

+

+
Parameters:
show - true to show
+
+
+
+ +

+setInitialMeldError

+
+void setInitialMeldError(int points)
+
+
Is set if a player tried to lay out less than initial meld threshold +

+

+
Parameters:
points - initial meld threshold
+
+
+
+ +

+setStoneCollectionHidden

+
+void setStoneCollectionHidden(boolean enable)
+
+
Show stone collection +

+

+
Parameters:
enable - showing collection
+
+
+
+ +

+setInitialMeldFirstError

+
+void setInitialMeldFirstError()
+
+
Is set if the player tried to modify the table without laying out first +

+

+
+
+
+
+ +

+setInvalidStoneSets

+
+void setInvalidStoneSets(java.util.Collection<StoneSet> sets)
+
+
Set invalid sets to enable showing +

+

+
Parameters:
sets - invalid sets on table
+
+
+
+ +

+showLoadingError

+
+void showLoadingError()
+
+
Show when loading is unsuccessful +

+

+
+
+
+
+ +

+showServerStartupError

+
+void showServerStartupError(boolean alreadyRunning)
+
+
Show an error message when the server couldn't be started +

+

+
Parameters:
alreadyRunning - true when the server is already running on this machine
+
+
+
+ +

+enableSave

+
+void enableSave(boolean enable)
+
+
Enables/disables saving in menu bar +

+

+
Parameters:
enable - saving possible
+
+
+
+ +

+showQuitWarningPanel

+
+void showQuitWarningPanel(boolean show)
+
+
Sets the quit warning panel visible +

+

+
Parameters:
show - is visible
+
+
+
+ +

+getQuitEvent

+
+IEvent getQuitEvent()
+
+
The quit event is emitted when the user wants to leave the application +

+

+ +
Returns:
the event
+
+
+
+ +

+getQuitWarningPanel

+
+IQuitWarningPanel getQuitWarningPanel()
+
+
Getter for quit warning panel +

+

+ +
Returns:
the panel
+
+
+
+ +

+getLoadFileEvent

+
+IEvent1<java.io.File> getLoadFileEvent()
+
+
The load file event is emitted when the user chose to discard the current + game to save another +

+

+ +
Returns:
the event
+
+
+
+ +

+load

+
+void load()
+
+
Loading a game +

+

+
+
+
+
+ +

+showConnectPanel

+
+void showConnectPanel(boolean show)
+
+
Set the connect panel visible +

+

+
Parameters:
show - is visible
+
+
+
+ +

+getConnectPanel

+
+IConnectPanel getConnectPanel()
+
+
Getter for connect panel +

+

+ +
Returns:
the panel
+
+
+
+ +

+setMayPause

+
+void setMayPause(boolean mayPause)
+
+
Sets the pause button if pausing should be possible in the current + situation +

+

+
Parameters:
mayPause - pausing possible
+
+
@@ -354,7 +1271,7 @@ getNewGameEvent  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -374,7 +1291,7 @@ getNewGameEvent - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD -- cgit v1.2.3