From 3634bc5135c2c98d40f92217fa301f8bf99bc936 Mon Sep 17 00:00:00 2001 From: Ida Massow Date: Wed, 22 Jun 2011 11:43:40 +0200 Subject: Javadocs fertig git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@596 72836036-5685-4462-b002-a69064685172 --- doc/allclasses-frame.html | 108 +- doc/allclasses-noframe.html | 108 +- doc/constant-values.html | 102 +- doc/deprecated-list.html | 10 +- doc/help-doc.html | 16 +- doc/index-files/index-1.html | 50 +- doc/index-files/index-2.html | 45 +- doc/index-files/index-3.html | 110 +- doc/index-files/index-4.html | 57 +- doc/index-files/index-5.html | 36 +- doc/index-files/index-6.html | 282 +---- doc/index-files/index-7.html | 128 +- doc/index-files/index-8.html | 52 +- doc/index.html | 9 +- doc/jrummikub/control/ApplicationControl.html | 328 +++++ .../control/class-use/ApplicationControl.html | 142 +++ doc/jrummikub/view/impl/View.html | 1251 ++++++++++++++++++-- doc/jrummikub/view/impl/class-use/View.html | 14 +- doc/jrummikub/view/impl/package-frame.html | 22 +- doc/jrummikub/view/impl/package-summary.html | 47 +- doc/jrummikub/view/impl/package-tree.html | 34 +- doc/jrummikub/view/impl/package-use.html | 51 +- doc/overview-tree.html | 74 +- doc/package-list | 5 - doc/serialized-form.html | 266 ++++- 25 files changed, 2151 insertions(+), 1196 deletions(-) create mode 100644 doc/jrummikub/control/ApplicationControl.html create mode 100644 doc/jrummikub/control/class-use/ApplicationControl.html (limited to 'doc') diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html index 1d42cf1..3b3a1f6 100644 --- a/doc/allclasses-frame.html +++ b/doc/allclasses-frame.html @@ -2,12 +2,12 @@ - + All Classes - + @@ -21,109 +21,7 @@ All Classes - diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html index 926c268..43a7ea5 100644 --- a/doc/allclasses-noframe.html +++ b/doc/allclasses-noframe.html @@ -2,12 +2,12 @@ - + All Classes - + @@ -21,109 +21,7 @@ All Classes
AbstractStonePanel -
-Connection -
-Event -
-Event1 -
-Event2 -
-GameControl -
-GameState -
-Hand -
-HandPanel -
-IClickable -
-IEvent -
-IEvent1 -
-IEvent2 -
-IGameState -
-IHand -
-IHandPanel -
-IListener -
-IListener1 -
-IListener2 -
-IPlayer -
-IPlayerPanel -
-IStoneCollectionPanel -
-IStonePanel -
-IStoneTray -
-ITable -
-ITablePanel -
-ITurnTimer -
-IView -
-JRummikub -
-Pair -
-Player -
-PlayerPanel -
-Position -
-RoundControl -
-Sizeable -
-StartTurnPanel -
-Stone -
-StoneCollectionPanel -
-StoneColor -
-StoneHeap -
-StonePainter -
-StoneSet -
-StoneSet.Type -
-StoneTray -
-StoneTray.Direction -
-Table -
-TablePanel -
-TurnControl -
-TurnControl.HandStonePositionComparator -
-TurnTimer -
-View -
-WinPanel +
View
- diff --git a/doc/constant-values.html b/doc/constant-values.html index 5dd929a..fdba2fc 100644 --- a/doc/constant-values.html +++ b/doc/constant-values.html @@ -2,12 +2,12 @@ - + Constant Field Values - + @@ -37,8 +37,7 @@ function windowTitle()
AbstractStonePanel -
-Connection -
-Event -
-Event1 -
-Event2 -
-GameControl -
-GameState -
-Hand -
-HandPanel -
-IClickable -
-IEvent -
-IEvent1 -
-IEvent2 -
-IGameState -
-IHand -
-IHandPanel -
-IListener -
-IListener1 -
-IListener2 -
-IPlayer -
-IPlayerPanel -
-IStoneCollectionPanel -
-IStonePanel -
-IStoneTray -
-ITable -
-ITablePanel -
-ITurnTimer -
-IView -
-JRummikub -
-Pair -
-Player -
-PlayerPanel -
-Position -
-RoundControl -
-Sizeable -
-StartTurnPanel -
-Stone -
-StoneCollectionPanel -
-StoneColor -
-StoneHeap -
-StonePainter -
-StoneSet -
-StoneSet.Type -
-StoneTray -
-StoneTray.Direction -
-Table -
-TablePanel -
-TurnControl -
-TurnControl.HandStonePositionComparator -
-TurnTimer -
-View -
-WinPanel +
View
- - + @@ -85,100 +84,8 @@ Constant Field Values
Contents - -
- - - -
-jrummikub.model.*
- -

- - - - - - - - - - - - - - - - - -
jrummikub.model.Hand
-public static final intHEIGHT2
-public static final intWIDTH14
- -

- -

- - - - - - - - - - - - - - - - - -
jrummikub.model.StoneSet
-static final floatHORIZONTAL_BORDER0.125f
-static final floatVERTICAL_BORDER0.5f
- -

- -

- - - - - -
-jrummikub.view.*
- -

- - - - - - - - - - - - - - - - - -
jrummikub.view.impl.jrummikub.view.impl.StonePainter
-public static final floatHEIGHT_SCALE0.01875000074505806f
-public static final floatWIDTH_SCALE0.02500000037252903f
- -

- -


@@ -191,8 +98,7 @@ jrummikub.view.* - - + diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html index 43075f8..f9f746a 100644 --- a/doc/deprecated-list.html +++ b/doc/deprecated-list.html @@ -2,12 +2,12 @@ - + Deprecated List - + @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -99,8 +98,7 @@ function windowTitle()
- - + diff --git a/doc/help-doc.html b/doc/help-doc.html index 3e2229c..9030d6c 100644 --- a/doc/help-doc.html +++ b/doc/help-doc.html @@ -2,12 +2,12 @@ - + API Help - + @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -84,12 +83,6 @@ function windowTitle() How This API Document Is Organized This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

-Overview

-
- -

-The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

-

Package

@@ -176,8 +169,7 @@ This help file applies to API documentation generated using the standard doclet.
- - + diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html index 8e28cc7..06cbd28 100644 --- a/doc/index-files/index-1.html +++ b/doc/index-files/index-1.html @@ -2,12 +2,12 @@ - + -A-Index +C-Index - + @@ -15,7 +15,7 @@ A-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="A-Index"; + parent.document.title="C-Index"; } } @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -78,37 +77,13 @@ function windowTitle() -ACDEFGHIJMNOPRSTVW
-

-A

+CEGJLRSV
+

+C

-
AbstractStonePanel - Class in jrummikub.view.impl
Base class for panels that draw stones
AbstractStonePanel() - -Constructor for class jrummikub.view.impl.AbstractStonePanel -
Create a new StonePanel with default scale factor -
AbstractStonePanel(float) - -Constructor for class jrummikub.view.impl.AbstractStonePanel -
Create a new StonePanel with a given scale factor -
actionPerformed(ActionEvent) - -Method in class jrummikub.control.TurnTimer +
clearView() - +Method in class jrummikub.view.impl.View
  -
add(IListener) - -Method in class jrummikub.util.Event -
  -
add(IListener1<T>) - -Method in class jrummikub.util.Event1 -
  -
add(IListener2<T1, T2>) - -Method in class jrummikub.util.Event2 -
  -
add(IListener) - -Method in interface jrummikub.util.IEvent -
Start to publish all events to a given listener -
add(IListener1<T>) - -Method in interface jrummikub.util.IEvent1 -
Start to publish all events to a given listener -
add(IListener2<T1, T2>) - -Method in interface jrummikub.util.IEvent2 -
Start to publish all events to a given listener

@@ -122,8 +97,7 @@ Method in interface jrummikub.util.
- - + @@ -163,7 +137,7 @@ Method in interface jrummikub.util. -ACDEFGHIJMNOPRSTVW
+CEGJLRSV
diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html index 4c578b0..91e6ecb 100644 --- a/doc/index-files/index-2.html +++ b/doc/index-files/index-2.html @@ -2,12 +2,12 @@ - + -C-Index +E-Index - + @@ -15,7 +15,7 @@ C-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="C-Index"; + parent.document.title="E-Index"; } } @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -78,30 +77,17 @@ function windowTitle() -ACDEFGHIJMNOPRSTVW
-

-C

+CEGJLRSV
+

+E

-
calculatePosition(int, int) - -Method in class jrummikub.view.impl.StonePainter +
enablePauseMode(boolean) - +Method in class jrummikub.view.impl.View
  -
classify() - -Method in class jrummikub.model.StoneSet -
Test for rule conflict within the StoneSet and determine whether the set - is a group or a run -
clickAt(Point, int, boolean, boolean, boolean) - -Method in class jrummikub.view.impl.AbstractStonePanel -
clickAt is called when a click has occurred -
clone() - -Method in interface jrummikub.model.IStoneTray -
Create a clone of the StoneTray -
clone() - -Method in class jrummikub.model.StoneTray +
enableSave(boolean) - +Method in class jrummikub.view.impl.View
  -
compare(Pair<Stone, Position>, Pair<Stone, Position>) - -Method in class jrummikub.control.TurnControl.HandStonePositionComparator -
  -
Connection - Interface in jrummikub.util
A Connection object can be used to remove a listener from a event
+
@@ -114,8 +100,7 @@ Method in class jrummikub.control.
- - + @@ -155,7 +140,7 @@ Method in class jrummikub.control. -ACDEFGHIJMNOPRSTVW
+CEGJLRSV
diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html index 4605a0c..7717b0c 100644 --- a/doc/index-files/index-3.html +++ b/doc/index-files/index-3.html @@ -2,12 +2,12 @@ - + -D-Index +G-Index - + @@ -15,7 +15,7 @@ D-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="D-Index"; + parent.document.title="G-Index"; } } @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -78,27 +77,81 @@ function windowTitle() -ACDEFGHIJMNOPRSTVW
-

-D

+CEGJLRSV
+

+G

-
deal() - -Method in class jrummikub.control.RoundControl -
  -
dealStone() - -Method in class jrummikub.control.RoundControl -
  -
drawStone() - -Method in class jrummikub.model.StoneHeap -
Removes random Stone from the heap and returns it -
drawStones(int) - -Method in class jrummikub.model.StoneHeap -
Removes several Stones from the heap and returns them -
drop(E, Position) - -Method in interface jrummikub.model.IStoneTray -
Adds object to the tray -
drop(E, Position) - -Method in class jrummikub.model.StoneTray +
getAcknowledgeConnectionLostEvent() - +Method in class jrummikub.view.impl.View +
  +
getAcknowledgeInvalidEvent() - +Method in class jrummikub.view.impl.View +
  +
getConnectPanel() - +Method in class jrummikub.view.impl.View +
  +
getEndPauseEvent() - +Method in class jrummikub.view.impl.View +
  +
getEndProgramEvent() - +Method in class jrummikub.view.impl.View +
  +
getGameListPanel() - +Method in class jrummikub.view.impl.View +
  +
getHandPanel() - +Method in class jrummikub.view.impl.View +
  +
getLoadEvent() - +Method in class jrummikub.view.impl.View +
  +
getLoadFileEvent() - +Method in class jrummikub.view.impl.View +
  +
getLoginPanel() - +Method in class jrummikub.view.impl.View +
  +
getMenuNewGameEvent() - +Method in class jrummikub.view.impl.View +
  +
getNetworkGameEvent() - +Method in class jrummikub.view.impl.View +
  +
getNewGameEvent() - +Method in class jrummikub.view.impl.View +
  +
getNewRoundEvent() - +Method in class jrummikub.view.impl.View +
  +
getPauseEvent() - +Method in class jrummikub.view.impl.View +
  +
getPlayerPanel() - +Method in class jrummikub.view.impl.View +
  +
getQuitEvent() - +Method in class jrummikub.view.impl.View +
  +
getQuitWarningPanel() - +Method in class jrummikub.view.impl.View +
  +
getSaveEvent() - +Method in class jrummikub.view.impl.View +
  +
getScorePanel() - +Method in class jrummikub.view.impl.View +
  +
getSettingsPanel() - +Method in class jrummikub.view.impl.View +
  +
getSidePanel() - +Method in class jrummikub.view.impl.View +
  +
getStartTurnEvent() - +Method in class jrummikub.view.impl.View +
  +
getTablePanel() - +Method in class jrummikub.view.impl.View
 

@@ -113,8 +166,7 @@ Method in class jrummikub.model.
- - + @@ -154,7 +206,7 @@ Method in class jrummikub.model. -ACDEFGHIJMNOPRSTVW
+CEGJLRSV
diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html index 9329614..9ffe614 100644 --- a/doc/index-files/index-4.html +++ b/doc/index-files/index-4.html @@ -2,12 +2,12 @@ - + -E-Index +J-Index - + @@ -15,7 +15,7 @@ E-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="E-Index"; + parent.document.title="J-Index"; } } @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -78,44 +77,11 @@ function windowTitle() -ACDEFGHIJMNOPRSTVW
-

-E

+CEGJLRSV
+

+J

-
emit() - -Method in class jrummikub.util.Event -
Generate a single event -
emit(T) - -Method in class jrummikub.util.Event1 -
Generate a single event -
emit(T1, T2) - -Method in class jrummikub.util.Event2 -
Generate a single event -
enableStartTurnPanel(boolean) - -Method in class jrummikub.view.impl.View -
  -
enableStartTurnPanel(boolean) - -Method in interface jrummikub.view.IView -
Enables or disables the player's StartTurnPanel -
enableWinPanel(boolean) - -Method in class jrummikub.view.impl.View -
  -
enableWinPanel(boolean) - -Method in interface jrummikub.view.IView -
Enables or disables the panel shown when a player has won -
equals(Object) - -Method in class jrummikub.model.Position -
  -
Event - Class in jrummikub.util
Simple parameterless event generator
Event() - -Constructor for class jrummikub.util.Event -
  -
Event1<T> - Class in jrummikub.util
Simple single parameter event generator
Event1() - -Constructor for class jrummikub.util.Event1 -
  -
Event2<T1,T2> - Class in jrummikub.util
Simple single parameter event generator
Event2() - -Constructor for class jrummikub.util.Event2 -
  -
+
jrummikub.view.impl - package jrummikub.view.impl
 
@@ -128,8 +94,7 @@ Constructor for class jrummikub.util.
- - + @@ -169,7 +134,7 @@ Constructor for class jrummikub.util. -ACDEFGHIJMNOPRSTVW
+CEGJLRSV
diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html index 07294bb..1f93e5c 100644 --- a/doc/index-files/index-5.html +++ b/doc/index-files/index-5.html @@ -2,12 +2,12 @@ - + -F-Index +L-Index - + @@ -15,7 +15,7 @@ F-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="F-Index"; + parent.document.title="L-Index"; } } @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -78,23 +77,13 @@ function windowTitle() -ACDEFGHIJMNOPRSTVW
-

-F

+CEGJLRSV
+

+L

-
findStoneSet(Stone) - -Method in interface jrummikub.model.ITable -
Finds the StoneSet containing the given Stone -
findStoneSet(Stone) - -Method in class jrummikub.model.Table +
load() - +Method in class jrummikub.view.impl.View
  -
fixInvalidDrop(Stone, Position, StoneTray.Direction) - -Method in class jrummikub.model.Hand -
  -
fixInvalidDrop(E, Position, StoneTray.Direction) - -Method in class jrummikub.model.StoneTray -
Checks whether the object may be placed on the given position, computes - new position if not

@@ -108,8 +97,7 @@ Method in class jrummikub.model.
- - + @@ -149,7 +137,7 @@ Method in class jrummikub.model. -ACDEFGHIJMNOPRSTVW
+CEGJLRSV
diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html index 9aed676..94713e1 100644 --- a/doc/index-files/index-6.html +++ b/doc/index-files/index-6.html @@ -2,12 +2,12 @@ - + -G-Index +R-Index - + @@ -15,7 +15,7 @@ G-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="G-Index"; + parent.document.title="R-Index"; } } @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -78,271 +77,13 @@ function windowTitle() -ACDEFGHIJMNOPRSTVW
-

-G

+CEGJLRSV
+

+R

-
GameControl - Class in jrummikub.control
Controls a Game, at some point including all Rounds, starts new Rounds
GameControl(IView) - -Constructor for class jrummikub.control.GameControl -
Constructor -
GameState - Class in jrummikub.model
Class managing the overall and momentary GameState
GameState() - -Constructor for class jrummikub.model.GameState -
Create a new GameState with an empty table and (currently) 4 new players. -
get(int) - -Method in class jrummikub.model.StoneSet -
Returns the i-th stone of the set (starting with 0) -
getActivePlayer() - -Method in class jrummikub.model.GameState -
  -
getActivePlayer() - -Method in interface jrummikub.model.IGameState -
Returns the currently active player -
getClickEvent() - -Method in interface jrummikub.view.IClickable -
the click event is emitted when the player clicks on the table/hand/etc. -
getClickEvent() - -Method in class jrummikub.view.impl.AbstractStonePanel -
  -
getColor() - -Method in interface jrummikub.model.IPlayer -
Return the player's color -
getColor() - -Method in class jrummikub.model.Player -
  -
getColor() - -Method in class jrummikub.model.Stone -
Returns the color of the stone. -
getEndOfTurnEvent() - -Method in class jrummikub.control.TurnControl -
Get the event that is emitted when the turn is over -
getEndRoundEvent() - -Method in class jrummikub.control.RoundControl -
End the round -
getEndTurnEvent() - -Method in class jrummikub.view.impl.PlayerPanel -
  -
getEndTurnEvent() - -Method in interface jrummikub.view.IPlayerPanel -
The end turn event is emitted when the player wants to end his turn -
getFirst() - -Method in class jrummikub.util.Pair -
Extract the first component of a pair -
getGameHeap() - -Method in class jrummikub.model.GameState -
  -
getGameHeap() - -Method in interface jrummikub.model.IGameState -
Returns the heap of stones to draw from -
getHand() - -Method in interface jrummikub.model.IPlayer -
Get the current hand of the player -
getHand() - -Method in class jrummikub.model.Player -
  -
getHandPanel() - -Method in class jrummikub.view.impl.PlayerPanel -
  -
getHandPanel() - -Method in interface jrummikub.view.IPlayerPanel -
  -
getHeight() - -Method in interface jrummikub.model.Sizeable -
Get the height of the object -
getHeight() - -Method in class jrummikub.model.Stone -
  -
getHeight() - -Method in class jrummikub.model.StoneSet -
  -
getHoveredStone() - -Method in class jrummikub.view.impl.AbstractStonePanel -
Returns the stone the mouse pointer is hovering over -
getLeftConnectorClickEvent() - -Method in class jrummikub.view.impl.TablePanel -
  -
getLeftConnectorClickEvent() - -Method in interface jrummikub.view.ITablePanel -
the left connector click event is emitted when the player clicks on a left - connector of a stone set on the table . -
getName() - -Method in interface jrummikub.model.IPlayer -
Return the name of the player -
getName() - -Method in class jrummikub.model.Player -
  -
getNewGameEvent() - -Method in class jrummikub.view.impl.View -
  -
getNewGameEvent() - -Method in class jrummikub.view.impl.WinPanel -
The new game event is emitted when the player wants to start a new game -
getNewGameEvent() - -Method in interface jrummikub.view.IView -
The new game event is emitted when the player wants to start a new game -
getNthNextPlayer(int) - -Method in class jrummikub.model.GameState -
  -
getNthNextPlayer(int) - -Method in interface jrummikub.model.IGameState -
Returns the player that would be the active player after i turns -
getOtherClickEvent() - -Method in class jrummikub.view.impl.StoneCollectionPanel -
The other click event is emitted by the stone collection when the player - has clicked on it, but hasn't hit a stone. -
getPlayerCount() - -Method in class jrummikub.model.GameState -
  -
getPlayerCount() - -Method in interface jrummikub.model.IGameState -
Returns the number of players -
getPlayerPanel() - -Method in class jrummikub.view.impl.View -
  -
getPlayerPanel() - -Method in interface jrummikub.view.IView -
Returns the player panel -
getPosition(E) - -Method in interface jrummikub.model.IStoneTray -
Returns the position of an object that is already on the tray -
getPosition(E) - -Method in class jrummikub.model.StoneTray -
  -
getQuitEvent() - -Method in class jrummikub.view.impl.View -
  -
getQuitEvent() - -Method in class jrummikub.view.impl.WinPanel -
The quit event is emitted when the player wants to quit the program -
getQuitEvent() - -Method in interface jrummikub.view.IView -
The quit event is emitted when the player wants to quit the game -
getRangeClickEvent() - -Method in class jrummikub.view.impl.AbstractStonePanel -
  -
getRangeClickEvent() - -Method in interface jrummikub.view.IStonePanel -
the range click event is emitted when the player clicks on the table/hand/ - etc. -
getRightConnectorClickEvent() - -Method in class jrummikub.view.impl.TablePanel -
  -
getRightConnectorClickEvent() - -Method in interface jrummikub.view.ITablePanel -
the right connector click event is emitted when the player clicks on a - right connector of a stone set on the table . -
getSecond() - -Method in class jrummikub.util.Pair -
Extract the second component of a pair -
getSetClickEvent() - -Method in class jrummikub.view.impl.AbstractStonePanel -
  -
getSetClickEvent() - -Method in interface jrummikub.view.IStonePanel -
the set click event is emitted when the player clicks on the table/hand/ - etc. -
getSize() - -Method in interface jrummikub.model.IStoneTray -
Return the number of objects on the tray -
getSize() - -Method in class jrummikub.model.StoneHeap -
Get the number of stones left -
getSize() - -Method in class jrummikub.model.StoneTray -
  -
getSortByGroupsEvent() - -Method in class jrummikub.view.impl.PlayerPanel -
  -
getSortByGroupsEvent() - -Method in interface jrummikub.view.IPlayerPanel -
The sort by groups event is emitted when the player wants to sort his - stones by groups -
getSortByRunsEvent() - -Method in class jrummikub.view.impl.PlayerPanel -
  -
getSortByRunsEvent() - -Method in interface jrummikub.view.IPlayerPanel -
The sort by runs event is emitted when the player wants to sort his stones - by runs -
getStartTurnEvent() - -Method in class jrummikub.view.impl.StartTurnPanel -
The start turn event is emitted when the current player has clicked the - start turn button -
getStartTurnEvent() - -Method in class jrummikub.view.impl.View -
  -
getStartTurnEvent() - -Method in interface jrummikub.view.IView -
The start turn event is emitted when the player wants to start his turn -
getStoneClickEvent() - -Method in class jrummikub.view.impl.AbstractStonePanel -
  -
getStoneClickEvent() - -Method in interface jrummikub.view.IStonePanel -
the click event is emitted when the player clicks on the table/hand/etc. -
getStoneCollectionPanel() - -Method in class jrummikub.view.impl.TablePanel -
  -
getStoneCollectionPanel() - -Method in interface jrummikub.view.ITablePanel -
Returns the stone collection (the panel showing the stones currently - selected) -
getStoneHeight() - -Method in class jrummikub.view.impl.StonePainter -
  -
getStonePainter() - -Method in class jrummikub.view.impl.AbstractStonePanel -
  -
getStones() - -Method in class jrummikub.view.impl.AbstractStonePanel -
Returns the list of stones and positions currently set -
getStoneWidth() - -Method in class jrummikub.view.impl.StonePainter -
  -
getTable() - -Method in class jrummikub.model.GameState -
  -
getTable() - -Method in interface jrummikub.model.IGameState -
Get the current Table -
getTablePanel() - +
resetLoginPanel() - Method in class jrummikub.view.impl.View
  -
getTablePanel() - -Method in interface jrummikub.view.IView -
Returns the table -
getTimeRunOutEvent() - -Method in interface jrummikub.control.ITurnTimer -
Returns the event that is emitted if the timer timed out. -
getTimeRunOutEvent() - -Method in class jrummikub.control.TurnTimer -
  -
getTranslation() - -Method in class jrummikub.view.impl.AbstractStonePanel -
Returns the translation in pixels the stones in this panel are painted with -
getTranslation() - -Method in class jrummikub.view.impl.StoneCollectionPanel -
  -
getTranslation() - -Method in class jrummikub.view.impl.TablePanel -
  -
getValue() - -Method in class jrummikub.model.Stone -
Returns the value of the stone. -
getWidth() - -Method in interface jrummikub.model.Sizeable -
Get the width of the object -
getWidth() - -Method in class jrummikub.model.Stone -
  -
getWidth() - -Method in class jrummikub.model.StoneSet -
  -
getX() - -Method in class jrummikub.model.Position -
Get the x coordinate of the position -
getY() - -Method in class jrummikub.model.Position -
Get the y coordinate of the position

@@ -356,8 +97,7 @@ Method in class jrummikub.model.
- - + @@ -397,7 +137,7 @@ Method in class jrummikub.model. -ACDEFGHIJMNOPRSTVW
+CEGJLRSV
diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html index bf2d6ff..af1bcbf 100644 --- a/doc/index-files/index-7.html +++ b/doc/index-files/index-7.html @@ -2,12 +2,12 @@ - + -H-Index +S-Index - + @@ -15,7 +15,7 @@ H-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="H-Index"; + parent.document.title="S-Index"; } } @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -78,54 +77,72 @@ function windowTitle() -ACDEFGHIJMNOPRSTVW
-

-H

+CEGJLRSV
+

+S

-
Hand - Class in jrummikub.model
Class managing a Player's Stones
Hand() - -Constructor for class jrummikub.model.Hand -
  -
handle() - -Method in interface jrummikub.util.IListener -
This method is called whenever a class we're listening to emits an event -
handle(T) - -Method in interface jrummikub.util.IListener1 -
This method is called whenever a class we're listening to emits an event -
handle(T1, T2) - -Method in interface jrummikub.util.IListener2 -
This method is called whenever a class we're listening to emits an event -
handleOtherClickEvent(Position) - -Method in class jrummikub.view.impl.AbstractStonePanel -
Overwrite this method to signal if special zone was clicked -
handleOtherClickEvent(Position) - -Method in class jrummikub.view.impl.StoneCollectionPanel -
  -
handleOtherClickEvent(Position) - -Method in class jrummikub.view.impl.TablePanel -
  -
handleOtherMoveEvent(Position) - -Method in class jrummikub.view.impl.AbstractStonePanel -
Overwrite this method to signal if special zone was hovered -
handleOtherMoveEvent(Position) - -Method in class jrummikub.view.impl.TablePanel -
  -
HandPanel - Class in jrummikub.view.impl
Implementation of the board
HandPanel() - -Constructor for class jrummikub.view.impl.HandPanel -
Creates a new Board instance -
hashCode() - -Method in class jrummikub.model.Position -
  -
heap - -Variable in class jrummikub.model.StoneHeap -
  -
HEIGHT - -Static variable in class jrummikub.model.Hand -
The height of the hand -
HEIGHT_SCALE - -Static variable in class jrummikub.view.impl.StonePainter -
The height of one pixel in the scale of 1.0 -
HORIZONTAL_BORDER - -Static variable in class jrummikub.model.StoneSet +
setBottomPanel(IView.BottomPanelType) - +Method in class jrummikub.view.impl.View +
  +
setCurrentPlayerColor(Color) - +Method in class jrummikub.view.impl.View +
  +
setCurrentPlayerHasLaidOut(boolean) - +Method in class jrummikub.view.impl.View +
  +
setCurrentPlayerName(String) - +Method in class jrummikub.view.impl.View +
  +
setInitialMeldError(int) - +Method in class jrummikub.view.impl.View +
  +
setInitialMeldFirstError() - +Method in class jrummikub.view.impl.View +
  +
setInvalidStoneSets(Collection<StoneSet>) - +Method in class jrummikub.view.impl.View +
  +
setLastStonePlayerName(String) - +Method in class jrummikub.view.impl.View +
  +
setMayPause(boolean) - +Method in class jrummikub.view.impl.View +
  +
setRedealedPlayerName(String) - +Method in class jrummikub.view.impl.View +
  +
setSelectedStones(Collection<Stone>) - +Method in class jrummikub.view.impl.View +
  +
setStoneCollectionHidden(boolean) - +Method in class jrummikub.view.impl.View +
  +
showConnectPanel(boolean) - +Method in class jrummikub.view.impl.View +
  +
showGameListPanel(boolean) - +Method in class jrummikub.view.impl.View +
  +
showLoadingError() - +Method in class jrummikub.view.impl.View +
  +
showLoginPanel(boolean) - +Method in class jrummikub.view.impl.View +
  +
showQuitWarningPanel(boolean) - +Method in class jrummikub.view.impl.View +
  +
showScorePanel(boolean) - +Method in class jrummikub.view.impl.View +
  +
showServerStartupError(boolean) - +Method in class jrummikub.view.impl.View +
  +
showSettingsPanel(boolean) - +Method in class jrummikub.view.impl.View +
  +
showSidePanel(boolean) - +Method in class jrummikub.view.impl.View
 

@@ -140,8 +157,7 @@ Static variable in class jrummikub.model.
- - + @@ -181,7 +197,7 @@ Static variable in class jrummikub.model. -ACDEFGHIJMNOPRSTVW
+CEGJLRSV
diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html index a07a4ba..a8eee42 100644 --- a/doc/index-files/index-8.html +++ b/doc/index-files/index-8.html @@ -2,12 +2,12 @@ - + -I-Index +V-Index - + @@ -15,7 +15,7 @@ I-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="I-Index"; + parent.document.title="V-Index"; } } @@ -37,8 +37,7 @@ function windowTitle()
- - + @@ -56,7 +55,7 @@ function windowTitle() + NEXT LETTER - + + + + +          Enable/disable pause mode - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +          Getter for login panel + jrummikub.util.IEvent + + + + + + + + +          Is emitted if the player wants to end the game and start a new one + + + + + + + + + jrummikub.view.IPlayerPanel + jrummikub.util.IEvent +          The quit event is emitted when the user wants to leave the application + + + + + + + + + + + + + + + + + + + + + jrummikub.util.IEvent + jrummikub.view.ITablePanel + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 voidenableStartTurnPanel(boolean enable) +clearView() + +
+          Hides all view elements and panels except for the cleared table and an + empty hand panel
+ voidenablePauseMode(boolean enable)
-          Enables or disables the player's StartTurnPanel
 voidenableWinPanel(boolean enable) +enableSave(boolean enable) + +
+          Enables/disables saving in menu bar
+ jrummikub.util.IEventgetAcknowledgeConnectionLostEvent() + +
+          The acknoledge connection lost event is emitted when the user has + acknowledged that the network connection was lost
+ jrummikub.util.IEventgetAcknowledgeInvalidEvent() + +
+          The start turn event is emitted when the player knows what invalid stones + he played
+ jrummikub.view.IConnectPanelgetConnectPanel() + +
+          Getter for connect panel
+ jrummikub.util.IEventgetEndPauseEvent() + +
+          The end pause event is emitted when the user wants to sresume the game + after a pause
+ jrummikub.util.IEventgetEndProgramEvent() + +
+          The quit event is emitted when the player wants to quit the game
+ jrummikub.view.IGameListPanelgetGameListPanel() + +
+          Getter for game list panel
+ jrummikub.view.IHandPanelgetHandPanel() + +
+           
+ jrummikub.util.IEventgetLoadEvent() + +
+          The load event is emitted when the user wants to load a previously saved + game state
+ jrummikub.util.IEvent1<java.io.File>getLoadFileEvent() + +
+          The load file event is emitted when the user chose to discard the current + game to save another
+ jrummikub.view.ILoginPanelgetLoginPanel()
-          Enables or disables the panel shown when a player has won
- IEventgetMenuNewGameEvent() + +
+          The menu new game event is emitted when the user selects the new game menu + entry
+ jrummikub.util.IEventgetNetworkGameEvent() + +
+          The network game event is emitted when the user chooses a network game
+ jrummikub.util.IEvent getNewGameEvent()
-          The new game event is emitted when the player wants to start a new game
+ jrummikub.util.IEventgetNewRoundEvent() + +
+          The new round event is emitted when the player wants to start a new round
+ jrummikub.util.IEventgetPauseEvent() + +
+          The pause event is emitted when the user wants to pause the current turn
- IPlayerPanel getPlayerPanel()
@@ -290,15 +386,56 @@ Implementation of the top-level view interface
- IEvent getQuitEvent()
-          The quit event is emitted when the player wants to quit the game
+ jrummikub.view.IQuitWarningPanelgetQuitWarningPanel() + +
+          Getter for quit warning panel
+ jrummikub.util.IEvent1<java.io.File>getSaveEvent() + +
+          The save event is emitted when the user wants to save the current game + state
+ jrummikub.view.IScorePanelgetScorePanel() + +
+          Returns the score panel
+ jrummikub.view.ISettingsPanelgetSettingsPanel() + +
+          Returns the settings panel
+ jrummikub.view.ISidePanelgetSidePanel() + +
+          Returns the side panel
- IEvent getStartTurnEvent()
@@ -306,7 +443,7 @@ Implementation of the top-level view interface
- ITablePanel getTablePanel()
@@ -315,6 +452,48 @@ Implementation of the top-level view interface
 voidload() + +
+          Loading a game
+ voidresetLoginPanel() + +
+          Clears user input of the resetLoginPanel
+ voidsetBottomPanel(jrummikub.view.IView.BottomPanelType type) + +
+          Sets the bottom panels type
+ voidsetCurrentPlayerColor(java.awt.Color color) + +
+          Is used for the PlayerPanel and ScorePanel to display a player's color + along with the name
+ voidsetCurrentPlayerHasLaidOut(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)
@@ -323,11 +502,140 @@ Implementation of the top-level view interface
 voidsetSelectedStones(java.util.Collection<Stone> stones) +setInitialMeldError(int points) + +
+          Is set if a player tried to lay out less than initial meld threshold
+ voidsetInitialMeldFirstError() + +
+          Is set if the player tried to modify the table without laying out first
+ voidsetInvalidStoneSets(java.util.Collection<jrummikub.model.StoneSet> sets) + +
+          Set invalid sets to enable showing
+ voidsetLastStonePlayerName(java.lang.String name) + +
+          Sets the name of the player that has drawn the last stone
+ voidsetMayPause(boolean mayPause) + +
+          Sets the pause button if pausing should be possible in the current + situation
+ voidsetRedealedPlayerName(java.lang.String name) + +
+          Sets the name of the player that has redealt last
+ voidsetSelectedStones(java.util.Collection<jrummikub.model.Stone> stones)
          Sets the stones that are to be painted selected
+ voidsetStoneCollectionHidden(boolean enable) + +
+          Show stone collection
+ voidshowConnectPanel(boolean show) + +
+          Set the connect panel visible
+ voidshowGameListPanel(boolean show) + +
+          Show/hide game list panel
+ voidshowLoadingError() + +
+          Show when loading is unsuccessful
+ voidshowLoginPanel(boolean show) + +
+          Show/hide login panel
+ voidshowQuitWarningPanel(boolean show) + +
+          Sets the quit warning panel visible
+ voidshowScorePanel(boolean show) + +
+          Shows or hides the score panel
+ voidshowServerStartupError(boolean alreadyRunning) + +
+          Show an error message when the server couldn't be started
+ voidshowSettingsPanel(boolean show) + +
+          Shows or hides the game settings panel
+ voidshowSidePanel(boolean show) + +
+          Show/hide side panel
  @@ -335,7 +643,7 @@ Implementation of the top-level view interface - +
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, updategetAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
  @@ -353,7 +661,7 @@ Implementation of the top-level view interface Methods inherited from class java.awt.Window -addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront +addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront   @@ -362,7 +670,7 @@ Implementation of the top-level view interface Methods inherited from class java.awt.Container -add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree +add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate   @@ -371,7 +679,7 @@ Implementation of the top-level view interface Methods inherited from class java.awt.Component -action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle +action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle   @@ -380,7 +688,7 @@ Implementation of the top-level view interface Methods inherited from class java.lang.Object -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait   @@ -424,20 +732,107 @@ public View() -

-getTablePanel

+

+getSettingsPanel

-public ITablePanel getTablePanel()
+public jrummikub.view.ISettingsPanel getSettingsPanel()
-
Description copied from interface: IView
-
Returns the table +
Description copied from interface: jrummikub.view.IView
+
Returns the settings panel

-
Specified by:
getTablePanel in interface IView
+
Specified by:
getSettingsPanel in interface jrummikub.view.IView
-
Returns:
the table
+
Returns:
the settings panel +
+ +
+ +

+getLoginPanel

+
+public jrummikub.view.ILoginPanel getLoginPanel()
+
+
Description copied from interface: jrummikub.view.IView
+
Getter for login panel +

+

+
Specified by:
getLoginPanel in interface jrummikub.view.IView
+
+
+ +
Returns:
login panel
+
+
+
+ +

+getScorePanel

+
+public jrummikub.view.IScorePanel getScorePanel()
+
+
Description copied from interface: jrummikub.view.IView
+
Returns the score panel +

+

+
Specified by:
getScorePanel in interface jrummikub.view.IView
+
+
+ +
Returns:
the score panel
+
+
+
+ +

+getTablePanel

+
+public jrummikub.view.ITablePanel getTablePanel()
+
+
Description copied from interface: jrummikub.view.IView
+
Returns the table +

+

+
Specified by:
getTablePanel in interface jrummikub.view.IView
+
+
+ +
Returns:
the table
+
+
+
+ +

+getSidePanel

+
+public jrummikub.view.ISidePanel getSidePanel()
+
+
Description copied from interface: jrummikub.view.IView
+
Returns the side panel +

+

+
Specified by:
getSidePanel in interface jrummikub.view.IView
+
+
+ +
Returns:
the side panel
+
+
+
+ +

+getHandPanel

+
+public jrummikub.view.IHandPanel getHandPanel()
+
+
+
Specified by:
getHandPanel in interface jrummikub.view.IView
+
+
+ +
Returns:
the board where the players hand stones are displayed

@@ -445,13 +840,13 @@ public

getPlayerPanel

-public IPlayerPanel getPlayerPanel()
+public jrummikub.view.IPlayerPanel getPlayerPanel()
-
Description copied from interface: IView
+
Description copied from interface: jrummikub.view.IView
Returns the player panel

-
Specified by:
getPlayerPanel in interface IView
+
Specified by:
getPlayerPanel in interface jrummikub.view.IView
@@ -460,16 +855,340 @@ public

+getQuitWarningPanel

+
+public jrummikub.view.IQuitWarningPanel getQuitWarningPanel()
+
+
Description copied from interface: jrummikub.view.IView
+
Getter for quit warning panel +

+

+
Specified by:
getQuitWarningPanel in interface jrummikub.view.IView
+
+
+ +
Returns:
the panel
+
+
+
+ +

+getConnectPanel

+
+public jrummikub.view.IConnectPanel getConnectPanel()
+
+
Description copied from interface: jrummikub.view.IView
+
Getter for connect panel +

+

+
Specified by:
getConnectPanel in interface jrummikub.view.IView
+
+
+ +
Returns:
the panel
+
+
+
+ +

+getGameListPanel

+
+public jrummikub.view.IGameListPanel getGameListPanel()
+
+
Description copied from interface: jrummikub.view.IView
+
Getter for game list panel +

+

+
Specified by:
getGameListPanel in interface jrummikub.view.IView
+
+
+ +
Returns:
game list panel
+
+
+
+ +

+getMenuNewGameEvent

+
+public jrummikub.util.IEvent getMenuNewGameEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The menu new game event is emitted when the user selects the new game menu + entry +

+

+
Specified by:
getMenuNewGameEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getLoadFileEvent

+
+public jrummikub.util.IEvent1<java.io.File> getLoadFileEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The load file event is emitted when the user chose to discard the current + game to save another +

+

+
Specified by:
getLoadFileEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getLoadEvent

+
+public jrummikub.util.IEvent getLoadEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The load event is emitted when the user wants to load a previously saved + game state +

+

+
Specified by:
getLoadEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getSaveEvent

+
+public jrummikub.util.IEvent1<java.io.File> getSaveEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The save event is emitted when the user wants to save the current game + state +

+

+
Specified by:
getSaveEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getPauseEvent

+
+public jrummikub.util.IEvent getPauseEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The pause event is emitted when the user wants to pause the current turn +

+

+
Specified by:
getPauseEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getEndPauseEvent

+
+public jrummikub.util.IEvent getEndPauseEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The end pause event is emitted when the user wants to sresume the game + after a pause +

+

+
Specified by:
getEndPauseEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getNetworkGameEvent

+
+public jrummikub.util.IEvent getNetworkGameEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The network game event is emitted when the user chooses a network game +

+

+
Specified by:
getNetworkGameEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getQuitEvent

+
+public jrummikub.util.IEvent getQuitEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The quit event is emitted when the user wants to leave the application +

+

+
Specified by:
getQuitEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+clearView

+
+public void clearView()
+
+
Description copied from interface: jrummikub.view.IView
+
Hides all view elements and panels except for the cleared table and an + empty hand panel +

+

+
Specified by:
clearView in interface jrummikub.view.IView
+
+
+
+
+
+
+ +

+showLoadingError

+
+public void showLoadingError()
+
+
Description copied from interface: jrummikub.view.IView
+
Show when loading is unsuccessful +

+

+
Specified by:
showLoadingError in interface jrummikub.view.IView
+
+
+
+
+
+
+ +

+showServerStartupError

+
+public void showServerStartupError(boolean alreadyRunning)
+
+
Description copied from interface: jrummikub.view.IView
+
Show an error message when the server couldn't be started +

+

+
Specified by:
showServerStartupError in interface jrummikub.view.IView
+
+
+
Parameters:
alreadyRunning - true when the server is already running on this machine
+
+
+
+ +

+enableSave

+
+public void enableSave(boolean enable)
+
+
Description copied from interface: jrummikub.view.IView
+
Enables/disables saving in menu bar +

+

+
Specified by:
enableSave in interface jrummikub.view.IView
+
+
+
Parameters:
enable - saving possible
+
+
+
+ +

+load

+
+public void load()
+
+
Description copied from interface: jrummikub.view.IView
+
Loading a game +

+

+
Specified by:
load in interface jrummikub.view.IView
+
+
+
+
+
+
+ +

+setMayPause

+
+public void setMayPause(boolean mayPause)
+
+
Description copied from interface: jrummikub.view.IView
+
Sets the pause button if pausing should be possible in the current + situation +

+

+
Specified by:
setMayPause in interface jrummikub.view.IView
+
+
+
Parameters:
mayPause - pausing possible
+
+
+
+ +

+enablePauseMode

+
+public void enablePauseMode(boolean enable)
+
+
Description copied from interface: jrummikub.view.IView
+
Enable/disable pause mode +

+

+
Specified by:
enablePauseMode in interface jrummikub.view.IView
+
+
+
Parameters:
enable - true = enable
+
+
+
+

setSelectedStones

-public void setSelectedStones(java.util.Collection<Stone> stones)
+public void setSelectedStones(java.util.Collection<jrummikub.model.Stone> stones)
-
Description copied from interface: IView
+
Description copied from interface: jrummikub.view.IView
Sets the stones that are to be painted selected

-
Specified by:
setSelectedStones in interface IView
+
Specified by:
setSelectedStones in interface jrummikub.view.IView
Parameters:
stones - the stones to be painted selected
@@ -477,36 +1196,155 @@ public void setSelectedStones(java.util.Collection<

-enableStartTurnPanel

+

+setInvalidStoneSets

+
+public void setInvalidStoneSets(java.util.Collection<jrummikub.model.StoneSet> sets)
+
+
Description copied from interface: jrummikub.view.IView
+
Set invalid sets to enable showing +

+

+
Specified by:
setInvalidStoneSets in interface jrummikub.view.IView
+
+
+
Parameters:
sets - invalid sets on table
+
+
+
+ +

+showSettingsPanel

+
+public void showSettingsPanel(boolean show)
+
+
Description copied from interface: jrummikub.view.IView
+
Shows or hides the game settings panel +

+

+
Specified by:
showSettingsPanel in interface jrummikub.view.IView
+
+
+
Parameters:
show - specifies if the panel shall be shown or hidden
+
+
+
+ +

+showLoginPanel

-public void enableStartTurnPanel(boolean enable)
+public void showLoginPanel(boolean show)
-
Description copied from interface: IView
-
Enables or disables the player's StartTurnPanel +
Description copied from interface: jrummikub.view.IView
+
Show/hide login panel

-
Specified by:
enableStartTurnPanel in interface IView
+
Specified by:
showLoginPanel in interface jrummikub.view.IView
-
Parameters:
enable - enable/disable
+
Parameters:
show - true = login panel is shown

-

-enableWinPanel

+

+resetLoginPanel

-public void enableWinPanel(boolean enable)
+public void resetLoginPanel()
-
Description copied from interface: IView
-
Enables or disables the panel shown when a player has won +
Description copied from interface: jrummikub.view.IView
+
Clears user input of the resetLoginPanel

-
Specified by:
enableWinPanel in interface IView
+
Specified by:
resetLoginPanel in interface jrummikub.view.IView
-
Parameters:
enable - enable/disable
+ +
+ +
+ +

+showGameListPanel

+
+public void showGameListPanel(boolean show)
+
+
Description copied from interface: jrummikub.view.IView
+
Show/hide game list panel +

+

+
Specified by:
showGameListPanel in interface jrummikub.view.IView
+
+
+
Parameters:
show - true = show
+
+
+
+ +

+showScorePanel

+
+public void showScorePanel(boolean show)
+
+
Description copied from interface: jrummikub.view.IView
+
Shows or hides the score panel +

+

+
Specified by:
showScorePanel in interface jrummikub.view.IView
+
+
+
Parameters:
show - specifies if the panel shall be shown or hidden
+
+
+
+ +

+showSidePanel

+
+public void showSidePanel(boolean show)
+
+
Description copied from interface: jrummikub.view.IView
+
Show/hide side panel +

+

+
Specified by:
showSidePanel in interface jrummikub.view.IView
+
+
+
Parameters:
show - true to show
+
+
+
+ +

+showQuitWarningPanel

+
+public void showQuitWarningPanel(boolean show)
+
+
Description copied from interface: jrummikub.view.IView
+
Sets the quit warning panel visible +

+

+
Specified by:
showQuitWarningPanel in interface jrummikub.view.IView
+
+
+
Parameters:
show - is visible
+
+
+
+ +

+showConnectPanel

+
+public void showConnectPanel(boolean show)
+
+
Description copied from interface: jrummikub.view.IView
+
Set the connect panel visible +

+

+
Specified by:
showConnectPanel in interface jrummikub.view.IView
+
+
+
Parameters:
show - is visible

@@ -516,11 +1354,11 @@ setCurrentPlayerName
 public void setCurrentPlayerName(java.lang.String playerName)
-
Description copied from interface: IView
+
Description copied from interface: jrummikub.view.IView
Sets the current player's name

-
Specified by:
setCurrentPlayerName in interface IView
+
Specified by:
setCurrentPlayerName in interface jrummikub.view.IView
Parameters:
playerName - the player name
@@ -528,16 +1366,176 @@ public void setCurrentPlayerName(java.lang.String playerName)
+

+setInitialMeldError

+
+public void setInitialMeldError(int points)
+
+
Description copied from interface: jrummikub.view.IView
+
Is set if a player tried to lay out less than initial meld threshold +

+

+
Specified by:
setInitialMeldError in interface jrummikub.view.IView
+
+
+
Parameters:
points - initial meld threshold
+
+
+
+ +

+setInitialMeldFirstError

+
+public void setInitialMeldFirstError()
+
+
Description copied from interface: jrummikub.view.IView
+
Is set if the player tried to modify the table without laying out first +

+

+
Specified by:
setInitialMeldFirstError in interface jrummikub.view.IView
+
+
+
+
+
+
+ +

+setCurrentPlayerColor

+
+public void setCurrentPlayerColor(java.awt.Color color)
+
+
Description copied from interface: jrummikub.view.IView
+
Is used for the PlayerPanel and ScorePanel to display a player's color + along with the name +

+

+
Specified by:
setCurrentPlayerColor in interface jrummikub.view.IView
+
+
+
Parameters:
color - the current player's color
+
+
+
+ +

+setRedealedPlayerName

+
+public void setRedealedPlayerName(java.lang.String name)
+
+
Description copied from interface: jrummikub.view.IView
+
Sets the name of the player that has redealt last +

+

+
Specified by:
setRedealedPlayerName in interface jrummikub.view.IView
+
+
+
Parameters:
name - the player name
+
+
+
+ +

+setLastStonePlayerName

+
+public void setLastStonePlayerName(java.lang.String name)
+
+
Description copied from interface: jrummikub.view.IView
+
Sets the name of the player that has drawn the last stone +

+

+
Specified by:
setLastStonePlayerName in interface jrummikub.view.IView
+
+
+
Parameters:
name - the player name
+
+
+
+ +

+setCurrentPlayerHasLaidOut

+
+public void setCurrentPlayerHasLaidOut(boolean hasLaidOut)
+
+
Description copied from interface: jrummikub.view.IView
+
Is used for the PlayerPanel to display if a player has laid out along with + the name +

+

+
Specified by:
setCurrentPlayerHasLaidOut in interface jrummikub.view.IView
+
+
+
Parameters:
hasLaidOut - specifies if the current player has laid out or not
+
+
+
+

getStartTurnEvent

-public IEvent getStartTurnEvent()
+public jrummikub.util.IEvent getStartTurnEvent()
-
Description copied from interface: IView
+
Description copied from interface: jrummikub.view.IView
The start turn event is emitted when the player wants to start his turn

-
Specified by:
getStartTurnEvent in interface IView
+
Specified by:
getStartTurnEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+ +
+ +

+getAcknowledgeInvalidEvent

+
+public jrummikub.util.IEvent getAcknowledgeInvalidEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The start turn event is emitted when the player knows what invalid stones + he played +

+

+
Specified by:
getAcknowledgeInvalidEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getAcknowledgeConnectionLostEvent

+
+public jrummikub.util.IEvent getAcknowledgeConnectionLostEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The acknoledge connection lost event is emitted when the user has + acknowledged that the network connection was lost +

+

+
Specified by:
getAcknowledgeConnectionLostEvent in interface jrummikub.view.IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getNewRoundEvent

+
+public jrummikub.util.IEvent getNewRoundEvent()
+
+
Description copied from interface: jrummikub.view.IView
+
The new round event is emitted when the player wants to start a new round +

+

+
Specified by:
getNewRoundEvent in interface jrummikub.view.IView
@@ -549,37 +1547,71 @@ public

getNewGameEvent

-public IEvent getNewGameEvent()
+public jrummikub.util.IEvent getNewGameEvent()
-
Description copied from interface: IView
-
The new game event is emitted when the player wants to start a new game +
Description copied from interface: jrummikub.view.IView
+
Is emitted if the player wants to end the game and start a new one

-
Specified by:
getNewGameEvent in interface IView
+
Specified by:
getNewGameEvent in interface jrummikub.view.IView
-
Returns:
the event
+
Returns:
newGameEvent

-

-getQuitEvent

+

+getEndProgramEvent

-public IEvent getQuitEvent()
+public jrummikub.util.IEvent getEndProgramEvent()
-
Description copied from interface: IView
+
Description copied from interface: jrummikub.view.IView
The quit event is emitted when the player wants to quit the game

-
Specified by:
getQuitEvent in interface IView
+
Specified by:
getEndProgramEvent in interface jrummikub.view.IView
Returns:
the event
+
+ +

+setBottomPanel

+
+public void setBottomPanel(jrummikub.view.IView.BottomPanelType type)
+
+
Description copied from interface: jrummikub.view.IView
+
Sets the bottom panels type +

+

+
Specified by:
setBottomPanel in interface jrummikub.view.IView
+
+
+
Parameters:
type - the type of the bottom panel
+
+
+
+ +

+setStoneCollectionHidden

+
+public void setStoneCollectionHidden(boolean enable)
+
+
Description copied from interface: jrummikub.view.IView
+
Show stone collection +

+

+
Specified by:
setStoneCollectionHidden in interface jrummikub.view.IView
+
+
+
Parameters:
enable - showing collection
+
+

@@ -593,8 +1625,7 @@ public - - + @@ -611,8 +1642,8 @@ public PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS + SUMMARY: NESTED | FIELD | CONSTR | METHOD diff --git a/doc/jrummikub/view/impl/class-use/View.html b/doc/jrummikub/view/impl/class-use/View.html index 2aebdce..8c1876b 100644 --- a/doc/jrummikub/view/impl/class-use/View.html +++ b/doc/jrummikub/view/impl/class-use/View.html @@ -2,12 +2,12 @@ - + Uses of Class jrummikub.view.impl.View - + @@ -37,11 +37,10 @@ function windowTitle()
- - + - + @@ -97,11 +96,10 @@ No usage of jrummikub.view.impl.View
- - + - + diff --git a/doc/jrummikub/view/impl/package-frame.html b/doc/jrummikub/view/impl/package-frame.html index 81ad91b..e9639f3 100644 --- a/doc/jrummikub/view/impl/package-frame.html +++ b/doc/jrummikub/view/impl/package-frame.html @@ -2,12 +2,12 @@ - + jrummikub.view.impl - + @@ -23,23 +23,7 @@ jrummikub.view.impl Classes 
-AbstractStonePanel -
-HandPanel -
-PlayerPanel -
-StartTurnPanel -
-StoneCollectionPanel -
-StonePainter -
-TablePanel -
-View -
-WinPanel
+View
diff --git a/doc/jrummikub/view/impl/package-summary.html b/doc/jrummikub/view/impl/package-summary.html index dd7784e..955bd5e 100644 --- a/doc/jrummikub/view/impl/package-summary.html +++ b/doc/jrummikub/view/impl/package-summary.html @@ -2,12 +2,12 @@ - + jrummikub.view.impl - + @@ -37,8 +37,7 @@ function windowTitle() - - + @@ -55,7 +54,7 @@ function windowTitle() - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AbstractStonePanelBase class for panels that draw stones
HandPanelImplementation of the board
PlayerPanelImplementation of the player panel
StartTurnPanelA panel that is displayed before a player's turn
StoneCollectionPanelImplementation of the stone collection (selection)
StonePainterThe StonePainter paints stones and converts between pixel and grid - coordinates
TablePanelThe implementation of the table
View Implementation of the top-level view interface
WinPanelA panel that is displayed when a player has won
  @@ -143,8 +109,7 @@ Package jrummikub.view.impl - - + @@ -161,7 +126,7 @@ Package jrummikub.view.impl