From 670fcf2613f6db2a4bfdaa91ac9d90001a90359e Mon Sep 17 00:00:00 2001 From: Ida Massow Date: Tue, 10 May 2011 16:59:40 +0200 Subject: docs fertig und vorher repariert git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@232 72836036-5685-4462-b002-a69064685172 --- doc/allclasses-frame.html | 133 ++++ doc/allclasses-noframe.html | 133 ++++ doc/constant-values.html | 238 +++++++ doc/deprecated-list.html | 146 +++++ doc/help-doc.html | 223 +++++++ doc/index-files/index-1.html | 169 +++++ doc/index-files/index-10.html | 145 +++++ doc/index-files/index-11.html | 148 +++++ doc/index-files/index-12.html | 145 +++++ doc/index-files/index-13.html | 182 ++++++ doc/index-files/index-14.html | 166 +++++ doc/index-files/index-15.html | 290 +++++++++ doc/index-files/index-16.html | 173 +++++ doc/index-files/index-17.html | 169 +++++ doc/index-files/index-18.html | 151 +++++ doc/index-files/index-2.html | 161 +++++ doc/index-files/index-3.html | 160 +++++ doc/index-files/index-4.html | 175 +++++ doc/index-files/index-5.html | 155 +++++ doc/index-files/index-6.html | 403 ++++++++++++ doc/index-files/index-7.html | 187 ++++++ doc/index-files/index-8.html | 162 +++++ doc/index-files/index-9.html | 148 +++++ doc/index.html | 39 ++ doc/jrummikub/JRummikub.html | 258 ++++++++ doc/jrummikub/class-use/JRummikub.html | 144 +++++ doc/jrummikub/control/GameControl.html | 262 ++++++++ doc/jrummikub/control/ITurnTimer.html | 258 ++++++++ doc/jrummikub/control/RoundControl.html | 345 ++++++++++ .../TurnControl.HandStonePositionComparator.html | 272 ++++++++ doc/jrummikub/control/TurnControl.html | 329 ++++++++++ doc/jrummikub/control/TurnTimer.html | 342 ++++++++++ doc/jrummikub/control/class-use/GameControl.html | 144 +++++ doc/jrummikub/control/class-use/ITurnTimer.html | 197 ++++++ doc/jrummikub/control/class-use/RoundControl.html | 144 +++++ .../TurnControl.HandStonePositionComparator.html | 144 +++++ doc/jrummikub/control/class-use/TurnControl.html | 144 +++++ doc/jrummikub/control/class-use/TurnTimer.html | 144 +++++ doc/jrummikub/control/package-frame.html | 51 ++ doc/jrummikub/control/package-summary.html | 187 ++++++ doc/jrummikub/control/package-tree.html | 160 +++++ doc/jrummikub/control/package-use.html | 170 +++++ doc/jrummikub/model/GameState.html | 422 ++++++++++++ doc/jrummikub/model/Hand.html | 386 +++++++++++ doc/jrummikub/model/IGameState.html | 346 ++++++++++ doc/jrummikub/model/IHand.html | 206 ++++++ doc/jrummikub/model/IPlayer.html | 260 ++++++++ doc/jrummikub/model/IStoneTray.html | 337 ++++++++++ doc/jrummikub/model/ITable.html | 289 +++++++++ doc/jrummikub/model/Player.html | 324 ++++++++++ doc/jrummikub/model/Position.html | 354 +++++++++++ doc/jrummikub/model/Sizeable.html | 240 +++++++ doc/jrummikub/model/Stone.html | 414 ++++++++++++ doc/jrummikub/model/StoneColor.html | 358 +++++++++++ doc/jrummikub/model/StoneHeap.html | 363 +++++++++++ doc/jrummikub/model/StoneSet.Type.html | 351 ++++++++++ doc/jrummikub/model/StoneSet.html | 583 +++++++++++++++++ doc/jrummikub/model/StoneTray.Direction.html | 361 +++++++++++ doc/jrummikub/model/StoneTray.html | 483 ++++++++++++++ doc/jrummikub/model/Table.html | 380 +++++++++++ doc/jrummikub/model/class-use/GameState.html | 144 +++++ doc/jrummikub/model/class-use/Hand.html | 144 +++++ doc/jrummikub/model/class-use/IGameState.html | 208 ++++++ doc/jrummikub/model/class-use/IHand.html | 243 +++++++ doc/jrummikub/model/class-use/IPlayer.html | 220 +++++++ doc/jrummikub/model/class-use/IStoneTray.html | 245 +++++++ doc/jrummikub/model/class-use/ITable.html | 284 +++++++++ doc/jrummikub/model/class-use/Player.html | 144 +++++ doc/jrummikub/model/class-use/Position.html | 526 +++++++++++++++ doc/jrummikub/model/class-use/Sizeable.html | 213 +++++++ doc/jrummikub/model/class-use/Stone.html | 594 +++++++++++++++++ doc/jrummikub/model/class-use/StoneColor.html | 218 +++++++ doc/jrummikub/model/class-use/StoneHeap.html | 188 ++++++ doc/jrummikub/model/class-use/StoneSet.Type.html | 198 ++++++ doc/jrummikub/model/class-use/StoneSet.html | 346 ++++++++++ .../model/class-use/StoneTray.Direction.html | 247 +++++++ doc/jrummikub/model/class-use/StoneTray.html | 188 ++++++ doc/jrummikub/model/class-use/Table.html | 144 +++++ doc/jrummikub/model/package-frame.html | 84 +++ doc/jrummikub/model/package-summary.html | 248 ++++++++ doc/jrummikub/model/package-tree.html | 187 ++++++ doc/jrummikub/model/package-use.html | 359 +++++++++++ doc/jrummikub/package-frame.html | 32 + doc/jrummikub/package-summary.html | 157 +++++ doc/jrummikub/package-tree.html | 153 +++++ doc/jrummikub/package-use.html | 144 +++++ doc/jrummikub/util/Connection.html | 212 ++++++ doc/jrummikub/util/Event.html | 315 +++++++++ doc/jrummikub/util/Event1.html | 317 +++++++++ doc/jrummikub/util/Event2.html | 319 ++++++++++ doc/jrummikub/util/IEvent.html | 237 +++++++ doc/jrummikub/util/IEvent1.html | 239 +++++++ doc/jrummikub/util/IEvent2.html | 239 +++++++ doc/jrummikub/util/IListener.html | 212 ++++++ doc/jrummikub/util/IListener1.html | 215 +++++++ doc/jrummikub/util/IListener2.html | 217 +++++++ doc/jrummikub/util/Pair.html | 289 +++++++++ doc/jrummikub/util/class-use/Connection.html | 220 +++++++ doc/jrummikub/util/class-use/Event.html | 144 +++++ doc/jrummikub/util/class-use/Event1.html | 235 +++++++ doc/jrummikub/util/class-use/Event2.html | 196 ++++++ doc/jrummikub/util/class-use/IEvent.html | 398 ++++++++++++ doc/jrummikub/util/class-use/IEvent1.html | 239 +++++++ doc/jrummikub/util/class-use/IEvent2.html | 227 +++++++ doc/jrummikub/util/class-use/IListener.html | 204 ++++++ doc/jrummikub/util/class-use/IListener1.html | 204 ++++++ doc/jrummikub/util/class-use/IListener2.html | 204 ++++++ doc/jrummikub/util/class-use/Pair.html | 403 ++++++++++++ doc/jrummikub/util/package-frame.html | 61 ++ doc/jrummikub/util/package-summary.html | 209 ++++++ doc/jrummikub/util/package-tree.html | 161 +++++ doc/jrummikub/util/package-use.html | 338 ++++++++++ doc/jrummikub/view/IClickable.html | 221 +++++++ doc/jrummikub/view/IHandPanel.html | 287 +++++++++ doc/jrummikub/view/IPlayerPanel.html | 305 +++++++++ doc/jrummikub/view/IStoneCollectionPanel.html | 197 ++++++ doc/jrummikub/view/IStonePanel.html | 273 ++++++++ doc/jrummikub/view/ITablePanel.html | 392 ++++++++++++ doc/jrummikub/view/IView.html | 388 +++++++++++ doc/jrummikub/view/class-use/IClickable.html | 241 +++++++ doc/jrummikub/view/class-use/IHandPanel.html | 209 ++++++ doc/jrummikub/view/class-use/IPlayerPanel.html | 225 +++++++ .../view/class-use/IStoneCollectionPanel.html | 226 +++++++ doc/jrummikub/view/class-use/IStonePanel.html | 249 ++++++++ doc/jrummikub/view/class-use/ITablePanel.html | 225 +++++++ doc/jrummikub/view/class-use/IView.html | 238 +++++++ doc/jrummikub/view/impl/AbstractStonePanel.html | 707 +++++++++++++++++++++ doc/jrummikub/view/impl/HandPanel.html | 516 +++++++++++++++ doc/jrummikub/view/impl/PlayerPanel.html | 521 +++++++++++++++ doc/jrummikub/view/impl/StartTurnPanel.html | 412 ++++++++++++ doc/jrummikub/view/impl/StoneCollectionPanel.html | 513 +++++++++++++++ doc/jrummikub/view/impl/StonePainter.html | 410 ++++++++++++ doc/jrummikub/view/impl/TablePanel.html | 702 ++++++++++++++++++++ doc/jrummikub/view/impl/View.html | 646 +++++++++++++++++++ doc/jrummikub/view/impl/WinPanel.html | 432 +++++++++++++ .../view/impl/class-use/AbstractStonePanel.html | 196 ++++++ doc/jrummikub/view/impl/class-use/HandPanel.html | 180 ++++++ doc/jrummikub/view/impl/class-use/PlayerPanel.html | 144 +++++ .../view/impl/class-use/StartTurnPanel.html | 144 +++++ .../view/impl/class-use/StoneCollectionPanel.html | 144 +++++ .../view/impl/class-use/StonePainter.html | 180 ++++++ doc/jrummikub/view/impl/class-use/TablePanel.html | 144 +++++ doc/jrummikub/view/impl/class-use/View.html | 144 +++++ doc/jrummikub/view/impl/class-use/WinPanel.html | 144 +++++ doc/jrummikub/view/impl/package-frame.html | 48 ++ doc/jrummikub/view/impl/package-summary.html | 190 ++++++ doc/jrummikub/view/impl/package-tree.html | 181 ++++++ doc/jrummikub/view/impl/package-use.html | 183 ++++++ doc/jrummikub/view/package-frame.html | 44 ++ doc/jrummikub/view/package-summary.html | 181 ++++++ doc/jrummikub/view/package-tree.html | 159 +++++ doc/jrummikub/view/package-use.html | 274 ++++++++ doc/overview-frame.html | 52 ++ doc/overview-summary.html | 171 +++++ doc/overview-tree.html | 227 +++++++ doc/package-list | 6 + doc/resources/inherit.gif | Bin 0 -> 57 bytes doc/serialized-form.html | 206 ++++++ doc/stylesheet.css | 29 + 159 files changed, 38371 insertions(+) create mode 100644 doc/allclasses-frame.html create mode 100644 doc/allclasses-noframe.html create mode 100644 doc/constant-values.html create mode 100644 doc/deprecated-list.html create mode 100644 doc/help-doc.html create mode 100644 doc/index-files/index-1.html create mode 100644 doc/index-files/index-10.html create mode 100644 doc/index-files/index-11.html create mode 100644 doc/index-files/index-12.html create mode 100644 doc/index-files/index-13.html create mode 100644 doc/index-files/index-14.html create mode 100644 doc/index-files/index-15.html create mode 100644 doc/index-files/index-16.html create mode 100644 doc/index-files/index-17.html create mode 100644 doc/index-files/index-18.html create mode 100644 doc/index-files/index-2.html create mode 100644 doc/index-files/index-3.html create mode 100644 doc/index-files/index-4.html create mode 100644 doc/index-files/index-5.html create mode 100644 doc/index-files/index-6.html create mode 100644 doc/index-files/index-7.html create mode 100644 doc/index-files/index-8.html create mode 100644 doc/index-files/index-9.html create mode 100644 doc/index.html create mode 100644 doc/jrummikub/JRummikub.html create mode 100644 doc/jrummikub/class-use/JRummikub.html create mode 100644 doc/jrummikub/control/GameControl.html create mode 100644 doc/jrummikub/control/ITurnTimer.html create mode 100644 doc/jrummikub/control/RoundControl.html create mode 100644 doc/jrummikub/control/TurnControl.HandStonePositionComparator.html create mode 100644 doc/jrummikub/control/TurnControl.html create mode 100644 doc/jrummikub/control/TurnTimer.html create mode 100644 doc/jrummikub/control/class-use/GameControl.html create mode 100644 doc/jrummikub/control/class-use/ITurnTimer.html create mode 100644 doc/jrummikub/control/class-use/RoundControl.html create mode 100644 doc/jrummikub/control/class-use/TurnControl.HandStonePositionComparator.html create mode 100644 doc/jrummikub/control/class-use/TurnControl.html create mode 100644 doc/jrummikub/control/class-use/TurnTimer.html create mode 100644 doc/jrummikub/control/package-frame.html create mode 100644 doc/jrummikub/control/package-summary.html create mode 100644 doc/jrummikub/control/package-tree.html create mode 100644 doc/jrummikub/control/package-use.html create mode 100644 doc/jrummikub/model/GameState.html create mode 100644 doc/jrummikub/model/Hand.html create mode 100644 doc/jrummikub/model/IGameState.html create mode 100644 doc/jrummikub/model/IHand.html create mode 100644 doc/jrummikub/model/IPlayer.html create mode 100644 doc/jrummikub/model/IStoneTray.html create mode 100644 doc/jrummikub/model/ITable.html create mode 100644 doc/jrummikub/model/Player.html create mode 100644 doc/jrummikub/model/Position.html create mode 100644 doc/jrummikub/model/Sizeable.html create mode 100644 doc/jrummikub/model/Stone.html create mode 100644 doc/jrummikub/model/StoneColor.html create mode 100644 doc/jrummikub/model/StoneHeap.html create mode 100644 doc/jrummikub/model/StoneSet.Type.html create mode 100644 doc/jrummikub/model/StoneSet.html create mode 100644 doc/jrummikub/model/StoneTray.Direction.html create mode 100644 doc/jrummikub/model/StoneTray.html create mode 100644 doc/jrummikub/model/Table.html create mode 100644 doc/jrummikub/model/class-use/GameState.html create mode 100644 doc/jrummikub/model/class-use/Hand.html create mode 100644 doc/jrummikub/model/class-use/IGameState.html create mode 100644 doc/jrummikub/model/class-use/IHand.html create mode 100644 doc/jrummikub/model/class-use/IPlayer.html create mode 100644 doc/jrummikub/model/class-use/IStoneTray.html create mode 100644 doc/jrummikub/model/class-use/ITable.html create mode 100644 doc/jrummikub/model/class-use/Player.html create mode 100644 doc/jrummikub/model/class-use/Position.html create mode 100644 doc/jrummikub/model/class-use/Sizeable.html create mode 100644 doc/jrummikub/model/class-use/Stone.html create mode 100644 doc/jrummikub/model/class-use/StoneColor.html create mode 100644 doc/jrummikub/model/class-use/StoneHeap.html create mode 100644 doc/jrummikub/model/class-use/StoneSet.Type.html create mode 100644 doc/jrummikub/model/class-use/StoneSet.html create mode 100644 doc/jrummikub/model/class-use/StoneTray.Direction.html create mode 100644 doc/jrummikub/model/class-use/StoneTray.html create mode 100644 doc/jrummikub/model/class-use/Table.html create mode 100644 doc/jrummikub/model/package-frame.html create mode 100644 doc/jrummikub/model/package-summary.html create mode 100644 doc/jrummikub/model/package-tree.html create mode 100644 doc/jrummikub/model/package-use.html create mode 100644 doc/jrummikub/package-frame.html create mode 100644 doc/jrummikub/package-summary.html create mode 100644 doc/jrummikub/package-tree.html create mode 100644 doc/jrummikub/package-use.html create mode 100644 doc/jrummikub/util/Connection.html create mode 100644 doc/jrummikub/util/Event.html create mode 100644 doc/jrummikub/util/Event1.html create mode 100644 doc/jrummikub/util/Event2.html create mode 100644 doc/jrummikub/util/IEvent.html create mode 100644 doc/jrummikub/util/IEvent1.html create mode 100644 doc/jrummikub/util/IEvent2.html create mode 100644 doc/jrummikub/util/IListener.html create mode 100644 doc/jrummikub/util/IListener1.html create mode 100644 doc/jrummikub/util/IListener2.html create mode 100644 doc/jrummikub/util/Pair.html create mode 100644 doc/jrummikub/util/class-use/Connection.html create mode 100644 doc/jrummikub/util/class-use/Event.html create mode 100644 doc/jrummikub/util/class-use/Event1.html create mode 100644 doc/jrummikub/util/class-use/Event2.html create mode 100644 doc/jrummikub/util/class-use/IEvent.html create mode 100644 doc/jrummikub/util/class-use/IEvent1.html create mode 100644 doc/jrummikub/util/class-use/IEvent2.html create mode 100644 doc/jrummikub/util/class-use/IListener.html create mode 100644 doc/jrummikub/util/class-use/IListener1.html create mode 100644 doc/jrummikub/util/class-use/IListener2.html create mode 100644 doc/jrummikub/util/class-use/Pair.html create mode 100644 doc/jrummikub/util/package-frame.html create mode 100644 doc/jrummikub/util/package-summary.html create mode 100644 doc/jrummikub/util/package-tree.html create mode 100644 doc/jrummikub/util/package-use.html create mode 100644 doc/jrummikub/view/IClickable.html create mode 100644 doc/jrummikub/view/IHandPanel.html create mode 100644 doc/jrummikub/view/IPlayerPanel.html create mode 100644 doc/jrummikub/view/IStoneCollectionPanel.html create mode 100644 doc/jrummikub/view/IStonePanel.html create mode 100644 doc/jrummikub/view/ITablePanel.html create mode 100644 doc/jrummikub/view/IView.html create mode 100644 doc/jrummikub/view/class-use/IClickable.html create mode 100644 doc/jrummikub/view/class-use/IHandPanel.html create mode 100644 doc/jrummikub/view/class-use/IPlayerPanel.html create mode 100644 doc/jrummikub/view/class-use/IStoneCollectionPanel.html create mode 100644 doc/jrummikub/view/class-use/IStonePanel.html create mode 100644 doc/jrummikub/view/class-use/ITablePanel.html create mode 100644 doc/jrummikub/view/class-use/IView.html create mode 100644 doc/jrummikub/view/impl/AbstractStonePanel.html create mode 100644 doc/jrummikub/view/impl/HandPanel.html create mode 100644 doc/jrummikub/view/impl/PlayerPanel.html create mode 100644 doc/jrummikub/view/impl/StartTurnPanel.html create mode 100644 doc/jrummikub/view/impl/StoneCollectionPanel.html create mode 100644 doc/jrummikub/view/impl/StonePainter.html create mode 100644 doc/jrummikub/view/impl/TablePanel.html create mode 100644 doc/jrummikub/view/impl/View.html create mode 100644 doc/jrummikub/view/impl/WinPanel.html create mode 100644 doc/jrummikub/view/impl/class-use/AbstractStonePanel.html create mode 100644 doc/jrummikub/view/impl/class-use/HandPanel.html create mode 100644 doc/jrummikub/view/impl/class-use/PlayerPanel.html create mode 100644 doc/jrummikub/view/impl/class-use/StartTurnPanel.html create mode 100644 doc/jrummikub/view/impl/class-use/StoneCollectionPanel.html create mode 100644 doc/jrummikub/view/impl/class-use/StonePainter.html create mode 100644 doc/jrummikub/view/impl/class-use/TablePanel.html create mode 100644 doc/jrummikub/view/impl/class-use/View.html create mode 100644 doc/jrummikub/view/impl/class-use/WinPanel.html create mode 100644 doc/jrummikub/view/impl/package-frame.html create mode 100644 doc/jrummikub/view/impl/package-summary.html create mode 100644 doc/jrummikub/view/impl/package-tree.html create mode 100644 doc/jrummikub/view/impl/package-use.html create mode 100644 doc/jrummikub/view/package-frame.html create mode 100644 doc/jrummikub/view/package-summary.html create mode 100644 doc/jrummikub/view/package-tree.html create mode 100644 doc/jrummikub/view/package-use.html create mode 100644 doc/overview-frame.html create mode 100644 doc/overview-summary.html create mode 100644 doc/overview-tree.html create mode 100644 doc/package-list create mode 100644 doc/resources/inherit.gif create mode 100644 doc/serialized-form.html create mode 100644 doc/stylesheet.css (limited to 'doc') diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html new file mode 100644 index 0000000..78d2bc2 --- /dev/null +++ b/doc/allclasses-frame.html @@ -0,0 +1,133 @@ + + + + + + +All Classes + + + + + + + + + + + +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 +
+
+ + + diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html new file mode 100644 index 0000000..841ef65 --- /dev/null +++ b/doc/allclasses-noframe.html @@ -0,0 +1,133 @@ + + + + + + +All Classes + + + + + + + + + + + +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 +
+
+ + + diff --git a/doc/constant-values.html b/doc/constant-values.html new file mode 100644 index 0000000..14d5cb7 --- /dev/null +++ b/doc/constant-values.html @@ -0,0 +1,238 @@ + + + + + + +Constant Field Values + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+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
+ +

+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html new file mode 100644 index 0000000..bedc4be --- /dev/null +++ b/doc/deprecated-list.html @@ -0,0 +1,146 @@ + + + + + + +Deprecated List + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Deprecated API

+
+
+Contents + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/help-doc.html b/doc/help-doc.html new file mode 100644 index 0000000..cbc134a --- /dev/null +++ b/doc/help-doc.html @@ -0,0 +1,223 @@ + + + + + + +API Help + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+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

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. +
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +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 new file mode 100644 index 0000000..0e7dffb --- /dev/null +++ b/doc/index-files/index-1.html @@ -0,0 +1,169 @@ + + + + + + +A-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+A

+
+
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 +
  +
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 +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html new file mode 100644 index 0000000..0170212 --- /dev/null +++ b/doc/index-files/index-10.html @@ -0,0 +1,145 @@ + + + + + + +M-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+M

+
+
main(String[]) - +Static method in class jrummikub.JRummikub +
The main method +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html new file mode 100644 index 0000000..5fc99ab --- /dev/null +++ b/doc/index-files/index-11.html @@ -0,0 +1,148 @@ + + + + + + +N-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+N

+
+
nextPlayer() - +Method in class jrummikub.model.GameState +
  +
nextPlayer() - +Method in interface jrummikub.model.IGameState +
Changes the activePlayer to the next Player in the list +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html new file mode 100644 index 0000000..75865e3 --- /dev/null +++ b/doc/index-files/index-12.html @@ -0,0 +1,145 @@ + + + + + + +O-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+O

+
+
objects - +Variable in class jrummikub.model.StoneTray +
  +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html new file mode 100644 index 0000000..c2b4eac --- /dev/null +++ b/doc/index-files/index-13.html @@ -0,0 +1,182 @@ + + + + + + +P-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+P

+
+
paintComponent(Graphics) - +Method in class jrummikub.view.impl.HandPanel +
  +
paintComponent(Graphics) - +Method in class jrummikub.view.impl.StoneCollectionPanel +
  +
paintComponent(Graphics) - +Method in class jrummikub.view.impl.TablePanel +
  +
paintStone(Graphics2D, Stone, Position, boolean, boolean) - +Method in class jrummikub.view.impl.StonePainter +
Paints a stone +
Pair<T1,T2> - Class in jrummikub.util
A pair of objects
Pair(T1, T2) - +Constructor for class jrummikub.util.Pair +
Create a new pair from two values +
pickUp(E) - +Method in interface jrummikub.model.IStoneTray +
Tries to pick up (remove) a given object +
pickUp(E) - +Method in class jrummikub.model.StoneTray +
  +
pickUpStone(Stone) - +Method in interface jrummikub.model.ITable +
Removes Stone from the Table +
pickUpStone(Stone) - +Method in class jrummikub.model.Table +
Removes Stone from the Table +
Player - Class in jrummikub.model
Class managing player data.
Player(String, Color) - +Constructor for class jrummikub.model.Player +
Create a new player with a given name and color +
PlayerPanel - Class in jrummikub.view.impl
Implementation of the player panel
PlayerPanel() - +Constructor for class jrummikub.view.impl.PlayerPanel +
Creates a new PlayerPanel instance +
Position - Class in jrummikub.model
Stone Position class to determine positions on Table or + Hand
Position(float, float) - +Constructor for class jrummikub.model.Position +
Create a new position by specifying the coordinates +
putBack(Collection<Stone>) - +Method in class jrummikub.model.StoneHeap +
Put stones back on the heap +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html new file mode 100644 index 0000000..d205c75 --- /dev/null +++ b/doc/index-files/index-14.html @@ -0,0 +1,166 @@ + + + + + + +R-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+R

+
+
remove() - +Method in interface jrummikub.util.Connection +
Removes the listener +
remove(IListener) - +Method in class jrummikub.util.Event +
  +
remove(IListener1<T>) - +Method in class jrummikub.util.Event1 +
  +
remove(IListener2<T1, T2>) - +Method in class jrummikub.util.Event2 +
  +
remove(IListener) - +Method in interface jrummikub.util.IEvent +
Stop publishing events to a given listener +
remove(IListener1<T>) - +Method in interface jrummikub.util.IEvent1 +
Stop publishing events to a given listener +
remove(IListener2<T1, T2>) - +Method in interface jrummikub.util.IEvent2 +
Stop publishing events to a given listener +
RoundControl - Class in jrummikub.control
Controller that manages a single round of rummikub
RoundControl(IGameState, IView) - +Constructor for class jrummikub.control.RoundControl +
Create a new RoundControl using the given gameState and view +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html new file mode 100644 index 0000000..fcae312 --- /dev/null +++ b/doc/index-files/index-15.html @@ -0,0 +1,290 @@ + + + + + + +S-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+S

+
+
setCurrentPlayerName(String) - +Method in class jrummikub.view.impl.PlayerPanel +
Sets the current player name +
setCurrentPlayerName(String) - +Method in class jrummikub.view.impl.StartTurnPanel +
Sets the current player name +
setCurrentPlayerName(String) - +Method in class jrummikub.view.impl.View +
  +
setCurrentPlayerName(String) - +Method in class jrummikub.view.impl.WinPanel +
Sets the name of the current player +
setCurrentPlayerName(String) - +Method in interface jrummikub.view.IView +
Sets the current player's name +
setHandHeight(int) - +Method in interface jrummikub.view.IHandPanel +
Set the number of stones that fit on the hand vertically +
setHandHeight(int) - +Method in class jrummikub.view.impl.HandPanel +
  +
setHandWidth(int) - +Method in interface jrummikub.view.IHandPanel +
Set the number of stones that fit on the hand horizontally +
setHandWidth(int) - +Method in class jrummikub.view.impl.HandPanel +
  +
setLeftPlayerName(String) - +Method in class jrummikub.view.impl.TablePanel +
  +
setLeftPlayerName(String) - +Method in interface jrummikub.view.ITablePanel +
Sets the player name on the left label +
setRightPlayerName(String) - +Method in class jrummikub.view.impl.TablePanel +
  +
setRightPlayerName(String) - +Method in interface jrummikub.view.ITablePanel +
Sets the player name on the right label +
setScale(float) - +Method in class jrummikub.view.impl.StonePainter +
Sets the new grid scale +
setSelectedStones(Collection<Stone>) - +Method in class jrummikub.view.impl.HandPanel +
Sets the stones that are to be painted selected +
setSelectedStones(Collection<Stone>) - +Method in class jrummikub.view.impl.StoneCollectionPanel +
Sets the stones to be shown in the collection +
setSelectedStones(Collection<Stone>) - +Method in class jrummikub.view.impl.TablePanel +
Sets the currently selected stones +
setSelectedStones(Collection<Stone>) - +Method in class jrummikub.view.impl.View +
  +
setSelectedStones(Collection<Stone>) - +Method in interface jrummikub.view.IView +
Sets the stones that are to be painted selected +
setStones(Iterable<Pair<Stone, Position>>) - +Method in interface jrummikub.view.IHandPanel +
Set the player's stones to display on the board +
setStones(Iterable<Pair<Stone, Position>>) - +Method in class jrummikub.view.impl.AbstractStonePanel +
Sets the list of stones that can be clicked on +
setStones(Iterable<Pair<Stone, Position>>) - +Method in class jrummikub.view.impl.HandPanel +
  +
setStoneSets(Iterable<Pair<StoneSet, Position>>) - +Method in class jrummikub.view.impl.TablePanel +
  +
setStoneSets(Iterable<Pair<StoneSet, Position>>) - +Method in interface jrummikub.view.ITablePanel +
Sets the stone sets lying on the table +
setTable(ITable) - +Method in class jrummikub.model.GameState +
  +
setTable(ITable) - +Method in interface jrummikub.model.IGameState +
Sets the current Table +
setTimeLeft(int) - +Method in class jrummikub.view.impl.PlayerPanel +
  +
setTimeLeft(int) - +Method in interface jrummikub.view.IPlayerPanel +
Sets the time the player has left for his turn +
setTopPlayerName(String) - +Method in class jrummikub.view.impl.TablePanel +
  +
setTopPlayerName(String) - +Method in interface jrummikub.view.ITablePanel +
Sets the player name on the top label +
size() - +Method in class jrummikub.model.StoneSet +
Returns the number of stones in the set. +
Sizeable - Interface in jrummikub.model
Objects that have a size.
splitAt(int) - +Method in class jrummikub.model.StoneSet +
Splits the StoneSet at a specified Position and returns two new + Stone Sets +
startGame() - +Method in class jrummikub.control.GameControl +
Game gets started by initializing the first Round +
startRound() - +Method in class jrummikub.control.RoundControl +
Begin the round +
startTimer() - +Method in interface jrummikub.control.ITurnTimer +
Starts the timer +
startTimer() - +Method in class jrummikub.control.TurnTimer +
  +
startTurn() - +Method in class jrummikub.control.TurnControl +
Start the turn +
StartTurnPanel - Class in jrummikub.view.impl
A panel that is displayed before a player's turn
StartTurnPanel() - +Constructor for class jrummikub.view.impl.StartTurnPanel +
Creates a new StartTurnPanel +
Stone - Class in jrummikub.model
Basic Rummikub Stone
Stone(StoneColor) - +Constructor for class jrummikub.model.Stone +
Creates a joker of the given color. +
Stone(int, StoneColor) - +Constructor for class jrummikub.model.Stone +
Creates a normal stone of a given color and value +
StoneCollectionPanel - Class in jrummikub.view.impl
Implementation of the stone collection (selection)
StoneCollectionPanel() - +Constructor for class jrummikub.view.impl.StoneCollectionPanel +
Creates a new StoneCollection instance +
StoneColor - Enum in jrummikub.model
Class specifying possible StoneColors
StoneHeap - Class in jrummikub.model
StoneHeap creates all Stones for a game, manages them and allows + players to draw one or more random Stones.
StoneHeap() - +Constructor for class jrummikub.model.StoneHeap +
Creates 106 Stones according to standard rules +
StonePainter - Class in jrummikub.view.impl
The StonePainter paints stones and converts between pixel and grid + coordinates
StonePainter(float) - +Constructor for class jrummikub.view.impl.StonePainter +
  +
StoneSet - Class in jrummikub.model
Class managing Stones joined together to form sets
StoneSet(Stone) - +Constructor for class jrummikub.model.StoneSet +
Create a new single stone stone set +
StoneSet(List<Stone>) - +Constructor for class jrummikub.model.StoneSet +
Create a stone set from a list of stones +
StoneSet.Type - Enum in jrummikub.model
Validity type of the set
StoneTray<E extends Sizeable> - Class in jrummikub.model
A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
StoneTray() - +Constructor for class jrummikub.model.StoneTray +
  +
StoneTray.Direction - Enum in jrummikub.model
Possible move directions in case of overlapping Stones/Sets
stopTimer() - +Method in interface jrummikub.control.ITurnTimer +
Stops the timer. +
stopTimer() - +Method in class jrummikub.control.TurnTimer +
  +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html new file mode 100644 index 0000000..b30faee --- /dev/null +++ b/doc/index-files/index-16.html @@ -0,0 +1,173 @@ + + + + + + +T-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+T

+
+
Table - Class in jrummikub.model
Class administering the Stones on the game-Table
Table() - +Constructor for class jrummikub.model.Table +
  +
tableDifference(ITable, ITable) - +Static method in class jrummikub.control.RoundControl +
  +
TablePanel - Class in jrummikub.view.impl
The implementation of the table
TablePanel() - +Constructor for class jrummikub.view.impl.TablePanel +
Creates a new Table instance +
toString() - +Method in class jrummikub.model.Position +
  +
toString() - +Method in class jrummikub.model.Stone +
  +
toString() - +Method in class jrummikub.model.StoneSet +
  +
TurnControl - Class in jrummikub.control
Controller for a single turn made by a human player
TurnControl(IHand, ITable, IView) - +Constructor for class jrummikub.control.TurnControl +
Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction. +
TurnControl(IHand, ITable, IView, ITurnTimer) - +Constructor for class jrummikub.control.TurnControl +
Test only constructor +
TurnControl.HandStonePositionComparator - Class in jrummikub.control
 
TurnControl.HandStonePositionComparator() - +Constructor for class jrummikub.control.TurnControl.HandStonePositionComparator +
  +
TurnTimer - Class in jrummikub.control
Count-down timer used to limit the turn time
TurnTimer(IView) - +Constructor for class jrummikub.control.TurnTimer +
Create a new timer using a given view to display the current time left +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html new file mode 100644 index 0000000..b7f11be --- /dev/null +++ b/doc/index-files/index-17.html @@ -0,0 +1,169 @@ + + + + + + +V-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+V

+
+
valueOf(String) - +Static method in enum jrummikub.model.StoneColor +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum jrummikub.model.StoneSet.Type +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum jrummikub.model.StoneTray.Direction +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum jrummikub.model.StoneColor +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum jrummikub.model.StoneSet.Type +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum jrummikub.model.StoneTray.Direction +
Returns an array containing the constants of this enum type, in +the order they are declared. +
VERTICAL_BORDER - +Static variable in class jrummikub.model.StoneSet +
  +
View - Class in jrummikub.view.impl
Implementation of the top-level view interface
View() - +Constructor for class jrummikub.view.impl.View +
Create a new instance of the view +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-18.html b/doc/index-files/index-18.html new file mode 100644 index 0000000..e115368 --- /dev/null +++ b/doc/index-files/index-18.html @@ -0,0 +1,151 @@ + + + + + + +W-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+W

+
+
WIDTH - +Static variable in class jrummikub.model.Hand +
The width of the hand +
WIDTH_SCALE - +Static variable in class jrummikub.view.impl.StonePainter +
The width of one pixel in the scale of 1.0 +
WinPanel - Class in jrummikub.view.impl
A panel that is displayed when a player has won
WinPanel() - +Constructor for class jrummikub.view.impl.WinPanel +
Creates a new WinPanel +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html new file mode 100644 index 0000000..6f79eb4 --- /dev/null +++ b/doc/index-files/index-2.html @@ -0,0 +1,161 @@ + + + + + + +C-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+C

+
+
calculatePosition(int, int) - +Method in class jrummikub.view.impl.StonePainter +
  +
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 +
  +
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
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html new file mode 100644 index 0000000..3868b16 --- /dev/null +++ b/doc/index-files/index-3.html @@ -0,0 +1,160 @@ + + + + + + +D-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+D

+
+
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 +
  +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html new file mode 100644 index 0000000..0ab35e1 --- /dev/null +++ b/doc/index-files/index-4.html @@ -0,0 +1,175 @@ + + + + + + +E-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+E

+
+
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 +
  +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html new file mode 100644 index 0000000..80198a0 --- /dev/null +++ b/doc/index-files/index-5.html @@ -0,0 +1,155 @@ + + + + + + +F-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+F

+
+
findStoneSet(Stone) - +Method in interface jrummikub.model.ITable +
Finds the StoneSet containing the given Stone +
findStoneSet(Stone) - +Method in class jrummikub.model.Table +
  +
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 +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html new file mode 100644 index 0000000..17f00e5 --- /dev/null +++ b/doc/index-files/index-6.html @@ -0,0 +1,403 @@ + + + + + + +G-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+G

+
+
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. and wants to select a range instead of a single stone +
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. and wants to select a whole set instead of a single stone +
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() - +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 +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html new file mode 100644 index 0000000..e432595 --- /dev/null +++ b/doc/index-files/index-7.html @@ -0,0 +1,187 @@ + + + + + + +H-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+H

+
+
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 +
  +
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html new file mode 100644 index 0000000..4a610b0 --- /dev/null +++ b/doc/index-files/index-8.html @@ -0,0 +1,162 @@ + + + + + + +I-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+I

+
+
IClickable - Interface in jrummikub.view
An interface for view elements that can emit click events
IEvent - Interface in jrummikub.util
Interface for classes that can generate parameterless events
IEvent1<T> - Interface in jrummikub.util
Interface for classes that can generate events having a single parameter
IEvent2<T1,T2> - Interface in jrummikub.util
Interface for classes that can generate events having a two parameters
IGameState - Interface in jrummikub.model
Interface for GameState model
IHand - Interface in jrummikub.model
Interface for the Hand model
IHandPanel - Interface in jrummikub.view
The view for a player's hand that displays his stones
IListener - Interface in jrummikub.util
Interface for classes that can receive parameterless events
IListener1<T> - Interface in jrummikub.util
Interface for classes that can receive parameterless events having a single + parameter
IListener2<T1,T2> - Interface in jrummikub.util
Interface for classes that can receive parameterless events having a two + parameters
IPlayer - Interface in jrummikub.model
Interface for Player model
IPlayerPanel - Interface in jrummikub.view
The player panel that contains a player's board and other user interfaces
isJoker() - +Method in class jrummikub.model.Stone +
Returns whether the stone is a joker or not. +
IStoneCollectionPanel - Interface in jrummikub.view
The view of the collection that shows the stones a player has selected
IStonePanel - Interface in jrummikub.view
An interface for view elements that can emit click events for clicks on stones
IStoneTray<E extends Sizeable> - Interface in jrummikub.model
Interface for the StoneTray model
isValid() - +Method in interface jrummikub.model.ITable +
Tests the Table for rule conflicts by checking all the StoneSet +
isValid() - +Method in class jrummikub.model.StoneSet +
Test for rule conflict within the StoneSet +
isValid() - +Method in class jrummikub.model.Table +
Tests the Table for rule conflicts by checking all the StoneSet +
ITable - Interface in jrummikub.model
Interface for the Table model
ITablePanel - Interface in jrummikub.view
The view of the table, where the stone sets lie
iterator() - +Method in class jrummikub.model.StoneSet +
  +
iterator() - +Method in class jrummikub.model.StoneTray +
  +
ITurnTimer - Interface in jrummikub.control
Interface for the TurnTimer
IView - Interface in jrummikub.view
The top-level view interface
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html new file mode 100644 index 0000000..e05bfb1 --- /dev/null +++ b/doc/index-files/index-9.html @@ -0,0 +1,148 @@ + + + + + + +J-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+

+J

+
+
join(StoneSet) - +Method in class jrummikub.model.StoneSet +
Joins StoneSet to another StoneSet and returns the resulting new StoneSet +
JRummikub - Class in jrummikub
The main class
JRummikub() - +Constructor for class jrummikub.JRummikub +
  +
jrummikub.view.impl - package jrummikub.view.impl
 
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +A C D E F G H I J M N O P R S T V W
+ + + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..65090a5 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,39 @@ + + + + + + +Generated Documentation (Untitled) + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/doc/jrummikub/JRummikub.html b/doc/jrummikub/JRummikub.html new file mode 100644 index 0000000..25d0b82 --- /dev/null +++ b/doc/jrummikub/JRummikub.html @@ -0,0 +1,258 @@ + + + + + + +JRummikub + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub +
+Class JRummikub

+
+java.lang.Object
+  extended by jrummikub.JRummikub
+
+
+
+
public class JRummikub
extends java.lang.Object
+ + +

+The main class +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
JRummikub() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(java.lang.String[] args) + +
+          The main method
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+JRummikub

+
+public JRummikub()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(java.lang.String[] args)
+
+
The main method +

+

+
Parameters:
args - command line arguments
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/class-use/JRummikub.html b/doc/jrummikub/class-use/JRummikub.html new file mode 100644 index 0000000..ef6799d --- /dev/null +++ b/doc/jrummikub/class-use/JRummikub.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.JRummikub + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.JRummikub

+
+No usage of jrummikub.JRummikub +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/GameControl.html b/doc/jrummikub/control/GameControl.html new file mode 100644 index 0000000..31d6456 --- /dev/null +++ b/doc/jrummikub/control/GameControl.html @@ -0,0 +1,262 @@ + + + + + + +GameControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class GameControl

+
+java.lang.Object
+  extended by jrummikub.control.GameControl
+
+
+
+
public class GameControl
extends java.lang.Object
+ + +

+Controls a Game, at some point including all Rounds, starts new Rounds +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
GameControl(IView view) + +
+          Constructor
+  + + + + + + + + + + + +
+Method Summary
+ voidstartGame() + +
+          Game gets started by initializing the first Round
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameControl

+
+public GameControl(IView view)
+
+
Constructor +

+

+
Parameters:
view - the view
+
+ + + + + + + + +
+Method Detail
+ +

+startGame

+
+public void startGame()
+
+
Game gets started by initializing the first Round +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/ITurnTimer.html b/doc/jrummikub/control/ITurnTimer.html new file mode 100644 index 0000000..18671ae --- /dev/null +++ b/doc/jrummikub/control/ITurnTimer.html @@ -0,0 +1,258 @@ + + + + + + +ITurnTimer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Interface ITurnTimer

+
+
All Known Implementing Classes:
TurnTimer
+
+
+
+
public interface ITurnTimer
+ + +

+Interface for the TurnTimer +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IEventgetTimeRunOutEvent() + +
+          Returns the event that is emitted if the timer timed out.
+ voidstartTimer() + +
+          Starts the timer
+ voidstopTimer() + +
+          Stops the timer.
+  +

+ + + + + + + + +
+Method Detail
+ +

+startTimer

+
+void startTimer()
+
+
Starts the timer +

+

+
+
+
+
+ +

+stopTimer

+
+void stopTimer()
+
+
Stops the timer. Stopping an already stopped timer is a no-op. +

+

+
+
+
+
+ +

+getTimeRunOutEvent

+
+IEvent getTimeRunOutEvent()
+
+
Returns the event that is emitted if the timer timed out. +

+

+ +
Returns:
time out event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/RoundControl.html b/doc/jrummikub/control/RoundControl.html new file mode 100644 index 0000000..e4df927 --- /dev/null +++ b/doc/jrummikub/control/RoundControl.html @@ -0,0 +1,345 @@ + + + + + + +RoundControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class RoundControl

+
+java.lang.Object
+  extended by jrummikub.control.RoundControl
+
+
+
+
public class RoundControl
extends java.lang.Object
+ + +

+Controller that manages a single round of rummikub +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
RoundControl(IGameState gameState, + IView view) + +
+          Create a new RoundControl using the given gameState and view
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+(package private)  voiddeal() + +
+           
+(package private)  voiddealStone() + +
+           
+ IEventgetEndRoundEvent() + +
+          End the round
+ voidstartRound() + +
+          Begin the round
+(package private) static java.util.Set<Stone>tableDifference(ITable oldTable, + ITable newTable) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RoundControl

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

+

+
Parameters:
gameState - initial game state
view - view used for user interaction
+
+ + + + + + + + +
+Method Detail
+ +

+getEndRoundEvent

+
+public IEvent getEndRoundEvent()
+
+
End the round +

+

+ +
Returns:
endRoundEvent
+
+
+
+ +

+startRound

+
+public void startRound()
+
+
Begin the round +

+

+
+
+
+
+ +

+deal

+
+void deal()
+
+
+
+
+
+
+ +

+tableDifference

+
+static java.util.Set<Stone> tableDifference(ITable oldTable,
+                                            ITable newTable)
+
+
+
+
+
+
+ +

+dealStone

+
+void dealStone()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/TurnControl.HandStonePositionComparator.html b/doc/jrummikub/control/TurnControl.HandStonePositionComparator.html new file mode 100644 index 0000000..a691289 --- /dev/null +++ b/doc/jrummikub/control/TurnControl.HandStonePositionComparator.html @@ -0,0 +1,272 @@ + + + + + + +TurnControl.HandStonePositionComparator + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class TurnControl.HandStonePositionComparator

+
+java.lang.Object
+  extended by jrummikub.control.TurnControl.HandStonePositionComparator
+
+
+
All Implemented Interfaces:
java.util.Comparator<Pair<Stone,Position>>
+
+
+
Enclosing class:
TurnControl
+
+
+
+
static class TurnControl.HandStonePositionComparator
extends java.lang.Object
implements java.util.Comparator<Pair<Stone,Position>>
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
TurnControl.HandStonePositionComparator() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ intcompare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface java.util.Comparator
equals
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TurnControl.HandStonePositionComparator

+
+TurnControl.HandStonePositionComparator()
+
+
+ + + + + + + + +
+Method Detail
+ +

+compare

+
+public int compare(Pair<Stone,Position> pair1,
+                   Pair<Stone,Position> pair2)
+
+
+
Specified by:
compare in interface java.util.Comparator<Pair<Stone,Position>>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/TurnControl.html b/doc/jrummikub/control/TurnControl.html new file mode 100644 index 0000000..465384f --- /dev/null +++ b/doc/jrummikub/control/TurnControl.html @@ -0,0 +1,329 @@ + + + + + + +TurnControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class TurnControl

+
+java.lang.Object
+  extended by jrummikub.control.TurnControl
+
+
+
+
public class TurnControl
extends java.lang.Object
+ + +

+Controller for a single turn made by a human player +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+(package private) static classTurnControl.HandStonePositionComparator + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
TurnControl(IHand hand, + ITable table, + IView view) + +
+          Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction.
TurnControl(IHand hand, + ITable table, + IView view, + ITurnTimer testTimer) + +
+          Test only constructor
+  + + + + + + + + + + + + + + + +
+Method Summary
+ IEventgetEndOfTurnEvent() + +
+          Get the event that is emitted when the turn is over
+ voidstartTurn() + +
+          Start the turn
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TurnControl

+
+public TurnControl(IHand hand,
+                   ITable table,
+                   IView view)
+
+
Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction. +

+

+
Parameters:
hand - active player's hand
table - current table
view - view for user interaction.
+
+
+ +

+TurnControl

+
+TurnControl(IHand hand,
+            ITable table,
+            IView view,
+            ITurnTimer testTimer)
+
+
Test only constructor +

+

+ + + + + + + + +
+Method Detail
+ +

+startTurn

+
+public void startTurn()
+
+
Start the turn +

+

+
+
+
+
+ +

+getEndOfTurnEvent

+
+public IEvent getEndOfTurnEvent()
+
+
Get the event that is emitted when the turn is over +

+

+ +
Returns:
end of turn event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/TurnTimer.html b/doc/jrummikub/control/TurnTimer.html new file mode 100644 index 0000000..293a466 --- /dev/null +++ b/doc/jrummikub/control/TurnTimer.html @@ -0,0 +1,342 @@ + + + + + + +TurnTimer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class TurnTimer

+
+java.lang.Object
+  extended by jrummikub.control.TurnTimer
+
+
+
All Implemented Interfaces:
java.awt.event.ActionListener, java.util.EventListener, ITurnTimer
+
+
+
+
public class TurnTimer
extends java.lang.Object
implements java.awt.event.ActionListener, ITurnTimer
+ + +

+Count-down timer used to limit the turn time +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
TurnTimer(IView view) + +
+          Create a new timer using a given view to display the current time left
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(java.awt.event.ActionEvent arg0) + +
+           
+ IEventgetTimeRunOutEvent() + +
+          Returns the event that is emitted if the timer timed out.
+ voidstartTimer() + +
+          Starts the timer
+ voidstopTimer() + +
+          Stops the timer.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TurnTimer

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

+

+
Parameters:
view - view to display
+
+ + + + + + + + +
+Method Detail
+ +

+startTimer

+
+public void startTimer()
+
+
Description copied from interface: ITurnTimer
+
Starts the timer +

+

+
Specified by:
startTimer in interface ITurnTimer
+
+
+
+
+
+
+ +

+stopTimer

+
+public void stopTimer()
+
+
Description copied from interface: ITurnTimer
+
Stops the timer. Stopping an already stopped timer is a no-op. +

+

+
Specified by:
stopTimer in interface ITurnTimer
+
+
+
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(java.awt.event.ActionEvent arg0)
+
+
+
Specified by:
actionPerformed in interface java.awt.event.ActionListener
+
+
+
+
+
+
+ +

+getTimeRunOutEvent

+
+public IEvent getTimeRunOutEvent()
+
+
Description copied from interface: ITurnTimer
+
Returns the event that is emitted if the timer timed out. +

+

+
Specified by:
getTimeRunOutEvent in interface ITurnTimer
+
+
+ +
Returns:
time out event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/GameControl.html b/doc/jrummikub/control/class-use/GameControl.html new file mode 100644 index 0000000..c006a28 --- /dev/null +++ b/doc/jrummikub/control/class-use/GameControl.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.GameControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.GameControl

+
+No usage of jrummikub.control.GameControl +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/ITurnTimer.html b/doc/jrummikub/control/class-use/ITurnTimer.html new file mode 100644 index 0000000..8730b19 --- /dev/null +++ b/doc/jrummikub/control/class-use/ITurnTimer.html @@ -0,0 +1,197 @@ + + + + + + +Uses of Interface jrummikub.control.ITurnTimer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.control.ITurnTimer

+
+ + + + + + + + + +
+Packages that use ITurnTimer
jrummikub.control  
+  +

+ + + + + +
+Uses of ITurnTimer in jrummikub.control
+  +

+ + + + + + + + + +
Classes in jrummikub.control that implement ITurnTimer
+ classTurnTimer + +
+          Count-down timer used to limit the turn time
+  +

+ + + + + + + + +
Constructors in jrummikub.control with parameters of type ITurnTimer
TurnControl(IHand hand, + ITable table, + IView view, + ITurnTimer testTimer) + +
+          Test only constructor
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/RoundControl.html b/doc/jrummikub/control/class-use/RoundControl.html new file mode 100644 index 0000000..b9f8955 --- /dev/null +++ b/doc/jrummikub/control/class-use/RoundControl.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.RoundControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.RoundControl

+
+No usage of jrummikub.control.RoundControl +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/TurnControl.HandStonePositionComparator.html b/doc/jrummikub/control/class-use/TurnControl.HandStonePositionComparator.html new file mode 100644 index 0000000..592ead4 --- /dev/null +++ b/doc/jrummikub/control/class-use/TurnControl.HandStonePositionComparator.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.TurnControl.HandStonePositionComparator + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.TurnControl.HandStonePositionComparator

+
+No usage of jrummikub.control.TurnControl.HandStonePositionComparator +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/TurnControl.html b/doc/jrummikub/control/class-use/TurnControl.html new file mode 100644 index 0000000..0024dcb --- /dev/null +++ b/doc/jrummikub/control/class-use/TurnControl.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.TurnControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.TurnControl

+
+No usage of jrummikub.control.TurnControl +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/TurnTimer.html b/doc/jrummikub/control/class-use/TurnTimer.html new file mode 100644 index 0000000..a089762 --- /dev/null +++ b/doc/jrummikub/control/class-use/TurnTimer.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.TurnTimer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.TurnTimer

+
+No usage of jrummikub.control.TurnTimer +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/package-frame.html b/doc/jrummikub/control/package-frame.html new file mode 100644 index 0000000..d5826e7 --- /dev/null +++ b/doc/jrummikub/control/package-frame.html @@ -0,0 +1,51 @@ + + + + + + +jrummikub.control + + + + + + + + + + + +jrummikub.control + + + + +
+Interfaces  + +
+ITurnTimer
+ + + + + + +
+Classes  + +
+GameControl +
+RoundControl +
+TurnControl +
+TurnControl.HandStonePositionComparator +
+TurnTimer
+ + + + diff --git a/doc/jrummikub/control/package-summary.html b/doc/jrummikub/control/package-summary.html new file mode 100644 index 0000000..e2b2864 --- /dev/null +++ b/doc/jrummikub/control/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +jrummikub.control + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package jrummikub.control +

+ + + + + + + + + +
+Interface Summary
ITurnTimerInterface for the TurnTimer
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
GameControlControls a Game, at some point including all Rounds, starts new Rounds
RoundControlController that manages a single round of rummikub
TurnControlController for a single turn made by a human player
TurnControl.HandStonePositionComparator 
TurnTimerCount-down timer used to limit the turn time
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/package-tree.html b/doc/jrummikub/control/package-tree.html new file mode 100644 index 0000000..960e887 --- /dev/null +++ b/doc/jrummikub/control/package-tree.html @@ -0,0 +1,160 @@ + + + + + + +jrummikub.control Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package jrummikub.control +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/package-use.html b/doc/jrummikub/control/package-use.html new file mode 100644 index 0000000..1eb0362 --- /dev/null +++ b/doc/jrummikub/control/package-use.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Package jrummikub.control + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
jrummikub.control

+
+ + + + + + + + + +
+Packages that use jrummikub.control
jrummikub.control  
+  +

+ + + + + + + + +
+Classes in jrummikub.control used by jrummikub.control
ITurnTimer + +
+          Interface for the TurnTimer
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/GameState.html b/doc/jrummikub/model/GameState.html new file mode 100644 index 0000000..efc47e6 --- /dev/null +++ b/doc/jrummikub/model/GameState.html @@ -0,0 +1,422 @@ + + + + + + +GameState + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class GameState

+
+java.lang.Object
+  extended by jrummikub.model.GameState
+
+
+
All Implemented Interfaces:
IGameState
+
+
+
+
public class GameState
extends java.lang.Object
implements IGameState
+ + +

+Class managing the overall and momentary GameState +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
GameState() + +
+          Create a new GameState with an empty table and (currently) 4 new players.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IPlayergetActivePlayer() + +
+          Returns the currently active player
+ StoneHeapgetGameHeap() + +
+          Returns the heap of stones to draw from
+ IPlayergetNthNextPlayer(int i) + +
+          Returns the player that would be the active player after i turns
+ intgetPlayerCount() + +
+          Returns the number of players
+ ITablegetTable() + +
+          Get the current Table
+ voidnextPlayer() + +
+          Changes the activePlayer to the next Player in the list
+ voidsetTable(ITable table) + +
+          Sets the current Table
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameState

+
+public GameState()
+
+
Create a new GameState with an empty table and (currently) 4 new players. +

+

+ + + + + + + + +
+Method Detail
+ +

+getTable

+
+public ITable getTable()
+
+
Description copied from interface: IGameState
+
Get the current Table +

+

+
Specified by:
getTable in interface IGameState
+
+
+ +
Returns:
The current Table
+
+
+
+ +

+setTable

+
+public void setTable(ITable table)
+
+
Description copied from interface: IGameState
+
Sets the current Table +

+

+
Specified by:
setTable in interface IGameState
+
+
+
Parameters:
table - The new Table
+
+
+
+ +

+getPlayerCount

+
+public int getPlayerCount()
+
+
Description copied from interface: IGameState
+
Returns the number of players +

+

+
Specified by:
getPlayerCount in interface IGameState
+
+
+ +
Returns:
number of players
+
+
+
+ +

+nextPlayer

+
+public void nextPlayer()
+
+
Description copied from interface: IGameState
+
Changes the activePlayer to the next Player in the list +

+

+
Specified by:
nextPlayer in interface IGameState
+
+
+
+
+
+
+ +

+getNthNextPlayer

+
+public IPlayer getNthNextPlayer(int i)
+
+
Description copied from interface: IGameState
+
Returns the player that would be the active player after i turns +

+

+
Specified by:
getNthNextPlayer in interface IGameState
+
+
+
Parameters:
i - number of turns +
Returns:
player active after i turns
+
+
+
+ +

+getActivePlayer

+
+public IPlayer getActivePlayer()
+
+
Description copied from interface: IGameState
+
Returns the currently active player +

+

+
Specified by:
getActivePlayer in interface IGameState
+
+
+ +
Returns:
currently active player
+
+
+
+ +

+getGameHeap

+
+public StoneHeap getGameHeap()
+
+
Description copied from interface: IGameState
+
Returns the heap of stones to draw from +

+

+
Specified by:
getGameHeap in interface IGameState
+
+
+ +
Returns:
heap of stones
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/Hand.html b/doc/jrummikub/model/Hand.html new file mode 100644 index 0000000..678c2f2 --- /dev/null +++ b/doc/jrummikub/model/Hand.html @@ -0,0 +1,386 @@ + + + + + + +Hand + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class Hand

+
+java.lang.Object
+  extended by jrummikub.model.StoneTray<Stone>
+      extended by jrummikub.model.Hand
+
+
+
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<Stone,Position>>, IHand, IStoneTray<Stone>
+
+
+
+
public class Hand
extends StoneTray<Stone>
implements IHand
+ + +

+Class managing a Player's Stones +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class jrummikub.model.StoneTray
StoneTray.Direction
+  + + + + + + + + + + + + + + + +
+Field Summary
+static intHEIGHT + +
+          The height of the hand
+static intWIDTH + +
+          The width of the hand
+ + + + + + + +
Fields inherited from class jrummikub.model.StoneTray
objects
+  + + + + + + + + + + +
+Constructor Summary
Hand() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+protected  Pair<Position,StoneTray.Direction>fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+ + + + + + + +
Methods inherited from class jrummikub.model.StoneTray
clone, drop, getPosition, getSize, iterator, pickUp
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface jrummikub.model.IStoneTray
clone, drop, getPosition, getSize, pickUp
+ + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

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

+WIDTH

+
+public static final int WIDTH
+
+
The width of the hand +

+

+
See Also:
Constant Field Values
+
+
+ +

+HEIGHT

+
+public static final int HEIGHT
+
+
The height of the hand +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+Hand

+
+public Hand()
+
+
+ + + + + + + + +
+Method Detail
+ +

+fixInvalidDrop

+
+protected Pair<Position,StoneTray.Direction> fixInvalidDrop(Stone stone,
+                                                            Position pos,
+                                                            StoneTray.Direction dir)
+
+
Description copied from class: StoneTray
+
Checks whether the object may be placed on the given position, computes + new position if not +

+

+
Overrides:
fixInvalidDrop in class StoneTray<Stone>
+
+
+
Parameters:
stone - to be dropped
pos - the object is dropped at +
Returns:
null if the drop is valid, new position otherwise
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/IGameState.html b/doc/jrummikub/model/IGameState.html new file mode 100644 index 0000000..b18e2a2 --- /dev/null +++ b/doc/jrummikub/model/IGameState.html @@ -0,0 +1,346 @@ + + + + + + +IGameState + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Interface IGameState

+
+
All Known Implementing Classes:
GameState
+
+
+
+
public interface IGameState
+ + +

+Interface for GameState model +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IPlayergetActivePlayer() + +
+          Returns the currently active player
+ StoneHeapgetGameHeap() + +
+          Returns the heap of stones to draw from
+ IPlayergetNthNextPlayer(int i) + +
+          Returns the player that would be the active player after i turns
+ intgetPlayerCount() + +
+          Returns the number of players
+ ITablegetTable() + +
+          Get the current Table
+ voidnextPlayer() + +
+          Changes the activePlayer to the next Player in the list
+ voidsetTable(ITable table) + +
+          Sets the current Table
+  +

+ + + + + + + + +
+Method Detail
+ +

+getTable

+
+ITable getTable()
+
+
Get the current Table +

+

+ +
Returns:
The current Table
+
+
+
+ +

+setTable

+
+void setTable(ITable table)
+
+
Sets the current Table +

+

+
Parameters:
table - The new Table
+
+
+
+ +

+getPlayerCount

+
+int getPlayerCount()
+
+
Returns the number of players +

+

+ +
Returns:
number of players
+
+
+
+ +

+nextPlayer

+
+void nextPlayer()
+
+
Changes the activePlayer to the next Player in the list +

+

+
+
+
+
+ +

+getActivePlayer

+
+IPlayer getActivePlayer()
+
+
Returns the currently active player +

+

+ +
Returns:
currently active player
+
+
+
+ +

+getGameHeap

+
+StoneHeap getGameHeap()
+
+
Returns the heap of stones to draw from +

+

+ +
Returns:
heap of stones
+
+
+
+ +

+getNthNextPlayer

+
+IPlayer getNthNextPlayer(int i)
+
+
Returns the player that would be the active player after i turns +

+

+
Parameters:
i - number of turns +
Returns:
player active after i turns
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/IHand.html b/doc/jrummikub/model/IHand.html new file mode 100644 index 0000000..5689921 --- /dev/null +++ b/doc/jrummikub/model/IHand.html @@ -0,0 +1,206 @@ + + + + + + +IHand + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Interface IHand

+
+
All Superinterfaces:
java.lang.Cloneable, IStoneTray<Stone>, java.lang.Iterable<Pair<Stone,Position>>
+
+
+
All Known Implementing Classes:
Hand
+
+
+
+
public interface IHand
extends IStoneTray<Stone>
+ + +

+Interface for the Hand model +

+ +

+


+ +

+ + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from interface jrummikub.model.IStoneTray
clone, drop, getPosition, getSize, pickUp
+ + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ +


+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/IPlayer.html b/doc/jrummikub/model/IPlayer.html new file mode 100644 index 0000000..f15bd4a --- /dev/null +++ b/doc/jrummikub/model/IPlayer.html @@ -0,0 +1,260 @@ + + + + + + +IPlayer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Interface IPlayer

+
+
All Known Implementing Classes:
Player
+
+
+
+
public interface IPlayer
+ + +

+Interface for Player model +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.awt.ColorgetColor() + +
+          Return the player's color
+ IHandgetHand() + +
+          Get the current hand of the player
+ java.lang.StringgetName() + +
+          Return the name of the player
+  +

+ + + + + + + + +
+Method Detail
+ +

+getHand

+
+IHand getHand()
+
+
Get the current hand of the player +

+

+ +
Returns:
the player's hand
+
+
+
+ +

+getColor

+
+java.awt.Color getColor()
+
+
Return the player's color +

+

+ +
Returns:
the player's color
+
+
+
+ +

+getName

+
+java.lang.String getName()
+
+
Return the name of the player +

+

+ +
Returns:
the player's name
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/IStoneTray.html b/doc/jrummikub/model/IStoneTray.html new file mode 100644 index 0000000..89b891b --- /dev/null +++ b/doc/jrummikub/model/IStoneTray.html @@ -0,0 +1,337 @@ + + + + + + +IStoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Interface IStoneTray<E extends Sizeable>

+
+
Type Parameters:
E - Objects held by the IStoneTray
+
+
All Superinterfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<E,Position>>
+
+
+
All Known Subinterfaces:
IHand, ITable
+
+
+
All Known Implementing Classes:
Hand, StoneTray, Table
+
+
+
+
public interface IStoneTray<E extends Sizeable>
extends java.lang.Iterable<Pair<E,Position>>, java.lang.Cloneable
+ + +

+Interface for the StoneTray model +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IStoneTray<E>clone() + +
+          Create a clone of the StoneTray
+ voiddrop(E object, + Position position) + +
+          Adds object to the tray
+ PositiongetPosition(E object) + +
+          Returns the position of an object that is already on the tray
+ intgetSize() + +
+          Return the number of objects on the tray
+ booleanpickUp(E object) + +
+          Tries to pick up (remove) a given object
+ + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ + + + + + + + +
+Method Detail
+ +

+drop

+
+void drop(E object,
+          Position position)
+
+
Adds object to the tray +

+

+
+
+
+
Parameters:
object - object to add to Hand
position - Position to put the object
+
+
+
+ +

+getPosition

+
+Position getPosition(E object)
+
+
Returns the position of an object that is already on the tray +

+

+
+
+
+
Parameters:
object - object whose position is requested +
Returns:
position of the object or null when the object is not on the tray
+
+
+
+ +

+pickUp

+
+boolean pickUp(E object)
+
+
Tries to pick up (remove) a given object +

+

+
+
+
+
Parameters:
object - object to pick up +
Returns:
true when the object was successfully removed
+
+
+
+ +

+clone

+
+IStoneTray<E> clone()
+
+
Create a clone of the StoneTray +

+

+
+
+
+ +
Returns:
cloned StoneTray
+
+
+
+ +

+getSize

+
+int getSize()
+
+
Return the number of objects on the tray +

+

+
+
+
+ +
Returns:
number of objects
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/ITable.html b/doc/jrummikub/model/ITable.html new file mode 100644 index 0000000..a4d2b89 --- /dev/null +++ b/doc/jrummikub/model/ITable.html @@ -0,0 +1,289 @@ + + + + + + +ITable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Interface ITable

+
+
All Superinterfaces:
java.lang.Cloneable, IStoneTray<StoneSet>, java.lang.Iterable<Pair<StoneSet,Position>>
+
+
+
All Known Implementing Classes:
Table
+
+
+
+
public interface ITable
extends IStoneTray<StoneSet>
+ + +

+Interface for the Table model +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneSetfindStoneSet(Stone stone) + +
+          Finds the StoneSet containing the given Stone
+ booleanisValid() + +
+          Tests the Table for rule conflicts by checking all the StoneSet
+ voidpickUpStone(Stone stone) + +
+          Removes Stone from the Table
+ + + + + + + +
Methods inherited from interface jrummikub.model.IStoneTray
clone, drop, getPosition, getSize, pickUp
+ + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ + + + + + + + +
+Method Detail
+ +

+pickUpStone

+
+void pickUpStone(Stone stone)
+
+
Removes Stone from the Table +

+

+
+
+
+
Parameters:
stone - stone to pick up
+
+
+
+ +

+isValid

+
+boolean isValid()
+
+
Tests the Table for rule conflicts by checking all the StoneSet +

+

+
+
+
+ +
Returns:
whether all sets on the table are valid
+
+
+
+ +

+findStoneSet

+
+StoneSet findStoneSet(Stone stone)
+
+
Finds the StoneSet containing the given Stone +

+

+
+
+
+
Parameters:
stone - stone whose set we're searching +
Returns:
the set containing the stone or null if no set was found
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/Player.html b/doc/jrummikub/model/Player.html new file mode 100644 index 0000000..9bc12ba --- /dev/null +++ b/doc/jrummikub/model/Player.html @@ -0,0 +1,324 @@ + + + + + + +Player + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class Player

+
+java.lang.Object
+  extended by jrummikub.model.Player
+
+
+
All Implemented Interfaces:
IPlayer
+
+
+
+
public class Player
extends java.lang.Object
implements IPlayer
+ + +

+Class managing player data. No methods in release 1 +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Player(java.lang.String name, + java.awt.Color color) + +
+          Create a new player with a given name and color
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.awt.ColorgetColor() + +
+          Return the player's color
+ IHandgetHand() + +
+          Get the current hand of the player
+ java.lang.StringgetName() + +
+          Return the name of the player
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Player

+
+public Player(java.lang.String name,
+              java.awt.Color color)
+
+
Create a new player with a given name and color +

+

+
Parameters:
name - player name
color - player's color
+
+ + + + + + + + +
+Method Detail
+ +

+getHand

+
+public IHand getHand()
+
+
Description copied from interface: IPlayer
+
Get the current hand of the player +

+

+
Specified by:
getHand in interface IPlayer
+
+
+ +
Returns:
the player's hand
+
+
+
+ +

+getColor

+
+public java.awt.Color getColor()
+
+
Description copied from interface: IPlayer
+
Return the player's color +

+

+
Specified by:
getColor in interface IPlayer
+
+
+ +
Returns:
the player's color
+
+
+
+ +

+getName

+
+public java.lang.String getName()
+
+
Description copied from interface: IPlayer
+
Return the name of the player +

+

+
Specified by:
getName in interface IPlayer
+
+
+ +
Returns:
the player's name
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/Position.html b/doc/jrummikub/model/Position.html new file mode 100644 index 0000000..ab41483 --- /dev/null +++ b/doc/jrummikub/model/Position.html @@ -0,0 +1,354 @@ + + + + + + +Position + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class Position

+
+java.lang.Object
+  extended by jrummikub.model.Position
+
+
+
+
public class Position
extends java.lang.Object
+ + +

+Stone Position class to determine positions on Table or + Hand +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Position(float x, + float y) + +
+          Create a new position by specifying the coordinates
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(java.lang.Object obj) + +
+           
+ floatgetX() + +
+          Get the x coordinate of the position
+ floatgetY() + +
+          Get the y coordinate of the position
+ inthashCode() + +
+           
+ java.lang.StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Position

+
+public Position(float x,
+                float y)
+
+
Create a new position by specifying the coordinates +

+

+
Parameters:
x - x coordinate
y - y coordinate
+
+ + + + + + + + +
+Method Detail
+ +

+getX

+
+public float getX()
+
+
Get the x coordinate of the position +

+

+ +
Returns:
x coordinate
+
+
+
+ +

+getY

+
+public float getY()
+
+
Get the y coordinate of the position +

+

+ +
Returns:
y coordinate
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object obj)
+
+
+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/Sizeable.html b/doc/jrummikub/model/Sizeable.html new file mode 100644 index 0000000..0c6ee5a --- /dev/null +++ b/doc/jrummikub/model/Sizeable.html @@ -0,0 +1,240 @@ + + + + + + +Sizeable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Interface Sizeable

+
+
All Known Implementing Classes:
Stone, StoneSet
+
+
+
+
public interface Sizeable
+ + +

+Objects that have a size. This interface has to be implemented for objects + placed on a @{link StoneTray} to make detection of overlapping objects + possible. +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ floatgetHeight() + +
+          Get the height of the object
+ floatgetWidth() + +
+          Get the width of the object
+  +

+ + + + + + + + +
+Method Detail
+ +

+getWidth

+
+float getWidth()
+
+
Get the width of the object +

+

+ +
Returns:
object width
+
+
+
+ +

+getHeight

+
+float getHeight()
+
+
Get the height of the object +

+

+ +
Returns:
object height
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/Stone.html b/doc/jrummikub/model/Stone.html new file mode 100644 index 0000000..647f08c --- /dev/null +++ b/doc/jrummikub/model/Stone.html @@ -0,0 +1,414 @@ + + + + + + +Stone + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class Stone

+
+java.lang.Object
+  extended by jrummikub.model.Stone
+
+
+
All Implemented Interfaces:
Sizeable
+
+
+
+
public class Stone
extends java.lang.Object
implements Sizeable
+ + +

+Basic Rummikub Stone +

+ +

+


+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
Stone(int value, + StoneColor color) + +
+          Creates a normal stone of a given color and value
Stone(StoneColor color) + +
+          Creates a joker of the given color.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneColorgetColor() + +
+          Returns the color of the stone.
+ floatgetHeight() + +
+          Get the height of the object
+ intgetValue() + +
+          Returns the value of the stone.
+ floatgetWidth() + +
+          Get the width of the object
+ booleanisJoker() + +
+          Returns whether the stone is a joker or not.
+ java.lang.StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Stone

+
+public Stone(StoneColor color)
+
+
Creates a joker of the given color. The color is only used for + displaying. +

+

+
Parameters:
color - joker color
+
+
+ +

+Stone

+
+public Stone(int value,
+             StoneColor color)
+
+
Creates a normal stone of a given color and value +

+

+
Parameters:
value - stone value
color - stone color
+
+ + + + + + + + +
+Method Detail
+ +

+getColor

+
+public StoneColor getColor()
+
+
Returns the color of the stone. +

+

+
+
+
+ +
Returns:
stone color
+
+
+
+ +

+isJoker

+
+public boolean isJoker()
+
+
Returns whether the stone is a joker or not. +

+

+
+
+
+ +
Returns:
true when the stone is a joker
+
+
+
+ +

+getValue

+
+public int getValue()
+
+
Returns the value of the stone. Don't use this value for jokers. +

+

+
+
+
+ +
Returns:
stone value
+
+
+
+ +

+getWidth

+
+public float getWidth()
+
+
Description copied from interface: Sizeable
+
Get the width of the object +

+

+
Specified by:
getWidth in interface Sizeable
+
+
+ +
Returns:
object width
+
+
+
+ +

+getHeight

+
+public float getHeight()
+
+
Description copied from interface: Sizeable
+
Get the height of the object +

+

+
Specified by:
getHeight in interface Sizeable
+
+
+ +
Returns:
object height
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneColor.html b/doc/jrummikub/model/StoneColor.html new file mode 100644 index 0000000..bd4667a --- /dev/null +++ b/doc/jrummikub/model/StoneColor.html @@ -0,0 +1,358 @@ + + + + + + +StoneColor + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Enum StoneColor

+
+java.lang.Object
+  extended by java.lang.Enum<StoneColor>
+      extended by jrummikub.model.StoneColor
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StoneColor>
+
+
+
+
public enum StoneColor
extends java.lang.Enum<StoneColor>
+ + +

+Class specifying possible StoneColors +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
BLACK + +
+           
BLUE + +
+           
ORANGE + +
+           
RED + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StoneColorvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneColor[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+BLACK

+
+public static final StoneColor BLACK
+
+
+
+
+
+ +

+ORANGE

+
+public static final StoneColor ORANGE
+
+
+
+
+
+ +

+BLUE

+
+public static final StoneColor BLUE
+
+
+
+
+
+ +

+RED

+
+public static final StoneColor RED
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static StoneColor[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (StoneColor c : StoneColor.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static StoneColor valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneHeap.html b/doc/jrummikub/model/StoneHeap.html new file mode 100644 index 0000000..d08f77c --- /dev/null +++ b/doc/jrummikub/model/StoneHeap.html @@ -0,0 +1,363 @@ + + + + + + +StoneHeap + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class StoneHeap

+
+java.lang.Object
+  extended by jrummikub.model.StoneHeap
+
+
+
+
public class StoneHeap
extends java.lang.Object
+ + +

+StoneHeap creates all Stones for a game, manages them and allows + players to draw one or more random Stones. +

+ +

+


+ +

+ + + + + + + + + + + +
+Field Summary
+(package private)  java.util.List<Stone>heap + +
+           
+  + + + + + + + + + + +
+Constructor Summary
StoneHeap() + +
+          Creates 106 Stones according to standard rules
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StonedrawStone() + +
+          Removes random Stone from the heap and returns it
+ java.util.List<Stone>drawStones(int number) + +
+          Removes several Stones from the heap and returns them
+ intgetSize() + +
+          Get the number of stones left
+ voidputBack(java.util.Collection<Stone> stones) + +
+          Put stones back on the heap
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+heap

+
+java.util.List<Stone> heap
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StoneHeap

+
+public StoneHeap()
+
+
Creates 106 Stones according to standard rules +

+

+ + + + + + + + +
+Method Detail
+ +

+drawStone

+
+public Stone drawStone()
+
+
Removes random Stone from the heap and returns it +

+

+ +
Returns:
the drawn stone
+
+
+
+ +

+drawStones

+
+public java.util.List<Stone> drawStones(int number)
+
+
Removes several Stones from the heap and returns them +

+

+
Parameters:
number - number of requested Stones +
Returns:
list of drawn stones
+
+
+
+ +

+getSize

+
+public int getSize()
+
+
Get the number of stones left +

+

+ +
Returns:
number of stones on the heap
+
+
+
+ +

+putBack

+
+public void putBack(java.util.Collection<Stone> stones)
+
+
Put stones back on the heap +

+

+
Parameters:
stones - collection of stones to put back
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneSet.Type.html b/doc/jrummikub/model/StoneSet.Type.html new file mode 100644 index 0000000..d349fb7 --- /dev/null +++ b/doc/jrummikub/model/StoneSet.Type.html @@ -0,0 +1,351 @@ + + + + + + +StoneSet.Type + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Enum StoneSet.Type

+
+java.lang.Object
+  extended by java.lang.Enum<StoneSet.Type>
+      extended by jrummikub.model.StoneSet.Type
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StoneSet.Type>
+
+
+
Enclosing class:
StoneSet
+
+
+
+
public static enum StoneSet.Type
extends java.lang.Enum<StoneSet.Type>
+ + +

+Validity type of the set +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Enum Constant Summary
GROUP + +
+          Set is a valid group
INVALID + +
+          Set is invalid
RUN + +
+          Set is a valid run
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StoneSet.TypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneSet.Type[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+GROUP

+
+public static final StoneSet.Type GROUP
+
+
Set is a valid group +

+

+
+
+
+ +

+RUN

+
+public static final StoneSet.Type RUN
+
+
Set is a valid run +

+

+
+
+
+ +

+INVALID

+
+public static final StoneSet.Type INVALID
+
+
Set is invalid +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static StoneSet.Type[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (StoneSet.Type c : StoneSet.Type.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static StoneSet.Type valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneSet.html b/doc/jrummikub/model/StoneSet.html new file mode 100644 index 0000000..5cf6895 --- /dev/null +++ b/doc/jrummikub/model/StoneSet.html @@ -0,0 +1,583 @@ + + + + + + +StoneSet + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class StoneSet

+
+java.lang.Object
+  extended by jrummikub.model.StoneSet
+
+
+
All Implemented Interfaces:
java.lang.Iterable<Stone>, Sizeable
+
+
+
+
public class StoneSet
extends java.lang.Object
implements java.lang.Iterable<Stone>, Sizeable
+ + +

+Class managing Stones joined together to form sets +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classStoneSet.Type + +
+          Validity type of the set
+ + + + + + + + + + + + + + +
+Field Summary
+(package private) static floatHORIZONTAL_BORDER + +
+           
+(package private) static floatVERTICAL_BORDER + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
StoneSet(java.util.List<Stone> stones) + +
+          Create a stone set from a list of stones
StoneSet(Stone stone) + +
+          Create a new single stone stone set
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneSet.Typeclassify() + +
+          Test for rule conflict within the StoneSet and determine whether the set + is a group or a run
+ Stoneget(int i) + +
+          Returns the i-th stone of the set (starting with 0)
+ floatgetHeight() + +
+          Get the height of the object
+ floatgetWidth() + +
+          Get the width of the object
+ booleanisValid() + +
+          Test for rule conflict within the StoneSet
+ java.util.Iterator<Stone>iterator() + +
+           
+ StoneSetjoin(StoneSet other) + +
+          Joins StoneSet to another StoneSet and returns the resulting new StoneSet
+ intsize() + +
+          Returns the number of stones in the set.
+ Pair<StoneSet,StoneSet>splitAt(int position) + +
+          Splits the StoneSet at a specified Position and returns two new + Stone Sets
+ java.lang.StringtoString() + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

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

+VERTICAL_BORDER

+
+static final float VERTICAL_BORDER
+
+
+
See Also:
Constant Field Values
+
+
+ +

+HORIZONTAL_BORDER

+
+static final float HORIZONTAL_BORDER
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+StoneSet

+
+public StoneSet(Stone stone)
+
+
Create a new single stone stone set +

+

+
Parameters:
stone - single stone of the set
+
+
+ +

+StoneSet

+
+public StoneSet(java.util.List<Stone> stones)
+
+
Create a stone set from a list of stones +

+

+
Parameters:
stones - list of stones to build a set of
+
+ + + + + + + + +
+Method Detail
+ +

+isValid

+
+public boolean isValid()
+
+
Test for rule conflict within the StoneSet +

+

+
+
+
+ +
Returns:
true when the set is valid according to the rules
+
+
+
+ +

+classify

+
+public StoneSet.Type classify()
+
+
Test for rule conflict within the StoneSet and determine whether the set + is a group or a run +

+

+
+
+
+ +
Returns:
GROUP or RUN for valid sets, INVALID otherwise
+
+
+
+ +

+splitAt

+
+public Pair<StoneSet,StoneSet> splitAt(int position)
+
+
Splits the StoneSet at a specified Position and returns two new + Stone Sets +

+

+
+
+
+
Parameters:
position - Splitting Position +
Returns:
A pair of StoneSets, one for each split part
+
+
+
+ +

+join

+
+public StoneSet join(StoneSet other)
+
+
Joins StoneSet to another StoneSet and returns the resulting new StoneSet +

+

+
+
+
+
Parameters:
other - StoneSet to be joined to active StoneSet +
Returns:
the combined StoneSet
+
+
+
+ +

+size

+
+public int size()
+
+
Returns the number of stones in the set. +

+

+
+
+
+ +
Returns:
number of stones
+
+
+
+ +

+get

+
+public Stone get(int i)
+
+
Returns the i-th stone of the set (starting with 0) +

+

+
+
+
+
Parameters:
i - number of the stone to return +
Returns:
the i-th stone
+
+
+
+ +

+iterator

+
+public java.util.Iterator<Stone> iterator()
+
+
+
Specified by:
iterator in interface java.lang.Iterable<Stone>
+
+
+
+
+
+
+ +

+getWidth

+
+public float getWidth()
+
+
Description copied from interface: Sizeable
+
Get the width of the object +

+

+
Specified by:
getWidth in interface Sizeable
+
+
+ +
Returns:
object width
+
+
+
+ +

+getHeight

+
+public float getHeight()
+
+
Description copied from interface: Sizeable
+
Get the height of the object +

+

+
Specified by:
getHeight in interface Sizeable
+
+
+ +
Returns:
object height
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneTray.Direction.html b/doc/jrummikub/model/StoneTray.Direction.html new file mode 100644 index 0000000..49c60bc --- /dev/null +++ b/doc/jrummikub/model/StoneTray.Direction.html @@ -0,0 +1,361 @@ + + + + + + +StoneTray.Direction + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Enum StoneTray.Direction

+
+java.lang.Object
+  extended by java.lang.Enum<StoneTray.Direction>
+      extended by jrummikub.model.StoneTray.Direction
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StoneTray.Direction>
+
+
+
Enclosing class:
StoneTray<E extends Sizeable>
+
+
+
+
protected static enum StoneTray.Direction
extends java.lang.Enum<StoneTray.Direction>
+ + +

+Possible move directions in case of overlapping Stones/Sets +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
BOTTOM + +
+           
LEFT + +
+           
RIGHT + +
+           
TOP + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StoneTray.DirectionvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneTray.Direction[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+ + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+ + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+LEFT

+
+public static final StoneTray.Direction LEFT
+
+
+
+
+
+ +

+RIGHT

+
+public static final StoneTray.Direction RIGHT
+
+
+
+
+
+ +

+TOP

+
+public static final StoneTray.Direction TOP
+
+
+
+
+
+ +

+BOTTOM

+
+public static final StoneTray.Direction BOTTOM
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static StoneTray.Direction[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (StoneTray.Direction c : StoneTray.Direction.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static StoneTray.Direction valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneTray.html b/doc/jrummikub/model/StoneTray.html new file mode 100644 index 0000000..a980742 --- /dev/null +++ b/doc/jrummikub/model/StoneTray.html @@ -0,0 +1,483 @@ + + + + + + +StoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class StoneTray<E extends Sizeable>

+
+java.lang.Object
+  extended by jrummikub.model.StoneTray<E>
+
+
+
Type Parameters:
E - Type of positioned objects (must implement Sizeable)
+
+
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<E,Position>>, IStoneTray<E>
+
+
+
Direct Known Subclasses:
Hand, Table
+
+
+
+
public class StoneTray<E extends Sizeable>
extends java.lang.Object
implements IStoneTray<E>
+ + +

+A StoneTray is a collection of positioned objects (for example Stones + or StoneSets. +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+protected static classStoneTray.Direction + +
+          Possible move directions in case of overlapping Stones/Sets
+ + + + + + + + + + +
+Field Summary
+protected  java.util.HashMap<E,Pair<E,Position>>objects + +
+           
+  + + + + + + + + + + +
+Constructor Summary
StoneTray() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IStoneTray<E>clone() + +
+          Create a clone of the StoneTray
+ voiddrop(E object, + Position position) + +
+          Adds object to the tray
+protected  Pair<Position,StoneTray.Direction>fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+ PositiongetPosition(E object) + +
+          Returns the position of an object that is already on the tray
+ intgetSize() + +
+          Return the number of objects on the tray
+ java.util.Iterator<Pair<E,Position>>iterator() + +
+           
+ booleanpickUp(E object) + +
+          Tries to pick up (remove) a given object
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+objects

+
+protected java.util.HashMap<E extends Sizeable,Pair<E extends Sizeable,Position>> objects
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StoneTray

+
+public StoneTray()
+
+
+ + + + + + + + +
+Method Detail
+ +

+drop

+
+public void drop(E object,
+                 Position position)
+
+
Description copied from interface: IStoneTray
+
Adds object to the tray +

+

+
Specified by:
drop in interface IStoneTray<E extends Sizeable>
+
+
+
Parameters:
object - object to add to Hand
position - Position to put the object
+
+
+
+ +

+fixInvalidDrop

+
+protected Pair<Position,StoneTray.Direction> fixInvalidDrop(E object,
+                                                            Position pos,
+                                                            StoneTray.Direction dir)
+
+
Checks whether the object may be placed on the given position, computes + new position if not +

+

+
+
+
+
Parameters:
object - to be dropped
dir -
pos - the object is dropped at +
Returns:
null if the drop is valid, new position otherwise
+
+
+
+ +

+getPosition

+
+public Position getPosition(E object)
+
+
Description copied from interface: IStoneTray
+
Returns the position of an object that is already on the tray +

+

+
Specified by:
getPosition in interface IStoneTray<E extends Sizeable>
+
+
+
Parameters:
object - object whose position is requested +
Returns:
position of the object or null when the object is not on the tray
+
+
+
+ +

+iterator

+
+public java.util.Iterator<Pair<E,Position>> iterator()
+
+
+
Specified by:
iterator in interface java.lang.Iterable<Pair<E extends Sizeable,Position>>
+
+
+
+
+
+
+ +

+pickUp

+
+public boolean pickUp(E object)
+
+
Description copied from interface: IStoneTray
+
Tries to pick up (remove) a given object +

+

+
Specified by:
pickUp in interface IStoneTray<E extends Sizeable>
+
+
+
Parameters:
object - object to pick up +
Returns:
true when the object was successfully removed
+
+
+
+ +

+clone

+
+public IStoneTray<E> clone()
+
+
Description copied from interface: IStoneTray
+
Create a clone of the StoneTray +

+

+
Specified by:
clone in interface IStoneTray<E extends Sizeable>
Overrides:
clone in class java.lang.Object
+
+
+ +
Returns:
cloned StoneTray
+
+
+
+ +

+getSize

+
+public int getSize()
+
+
Description copied from interface: IStoneTray
+
Return the number of objects on the tray +

+

+
Specified by:
getSize in interface IStoneTray<E extends Sizeable>
+
+
+ +
Returns:
number of objects
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/Table.html b/doc/jrummikub/model/Table.html new file mode 100644 index 0000000..721ef67 --- /dev/null +++ b/doc/jrummikub/model/Table.html @@ -0,0 +1,380 @@ + + + + + + +Table + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.model +
+Class Table

+
+java.lang.Object
+  extended by jrummikub.model.StoneTray<StoneSet>
+      extended by jrummikub.model.Table
+
+
+
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<StoneSet,Position>>, IStoneTray<StoneSet>, ITable
+
+
+
+
public class Table
extends StoneTray<StoneSet>
implements ITable
+ + +

+Class administering the Stones on the game-Table +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class jrummikub.model.StoneTray
StoneTray.Direction
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class jrummikub.model.StoneTray
objects
+  + + + + + + + + + + +
+Constructor Summary
Table() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneSetfindStoneSet(Stone stone) + +
+          Finds the StoneSet containing the given Stone
+ booleanisValid() + +
+          Tests the Table for rule conflicts by checking all the StoneSet
+ voidpickUpStone(Stone stone) + +
+          Removes Stone from the Table
+ + + + + + + +
Methods inherited from class jrummikub.model.StoneTray
clone, drop, fixInvalidDrop, getPosition, getSize, iterator, pickUp
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface jrummikub.model.IStoneTray
clone, drop, getPosition, getSize, pickUp
+ + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Table

+
+public Table()
+
+
+ + + + + + + + +
+Method Detail
+ +

+pickUpStone

+
+public void pickUpStone(Stone stone)
+
+
Removes Stone from the Table +

+

+
Specified by:
pickUpStone in interface ITable
+
+
+
Parameters:
stone - stone to pick up
+
+
+
+ +

+findStoneSet

+
+public StoneSet findStoneSet(Stone stone)
+
+
Description copied from interface: ITable
+
Finds the StoneSet containing the given Stone +

+

+
Specified by:
findStoneSet in interface ITable
+
+
+
Parameters:
stone - stone whose set we're searching +
Returns:
the set containing the stone or null if no set was found
+
+
+
+ +

+isValid

+
+public boolean isValid()
+
+
Tests the Table for rule conflicts by checking all the StoneSet +

+

+
Specified by:
isValid in interface ITable
+
+
+ +
Returns:
whether all sets on the table are valid
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/GameState.html b/doc/jrummikub/model/class-use/GameState.html new file mode 100644 index 0000000..ae05b77 --- /dev/null +++ b/doc/jrummikub/model/class-use/GameState.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.model.GameState + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.GameState

+
+No usage of jrummikub.model.GameState +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Hand.html b/doc/jrummikub/model/class-use/Hand.html new file mode 100644 index 0000000..4100345 --- /dev/null +++ b/doc/jrummikub/model/class-use/Hand.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.model.Hand + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.Hand

+
+No usage of jrummikub.model.Hand +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/IGameState.html b/doc/jrummikub/model/class-use/IGameState.html new file mode 100644 index 0000000..2912a4d --- /dev/null +++ b/doc/jrummikub/model/class-use/IGameState.html @@ -0,0 +1,208 @@ + + + + + + +Uses of Interface jrummikub.model.IGameState + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.model.IGameState

+
+ + + + + + + + + + + + + +
+Packages that use IGameState
jrummikub.control  
jrummikub.model  
+  +

+ + + + + +
+Uses of IGameState in jrummikub.control
+  +

+ + + + + + + + +
Constructors in jrummikub.control with parameters of type IGameState
RoundControl(IGameState gameState, + IView view) + +
+          Create a new RoundControl using the given gameState and view
+  +

+ + + + + +
+Uses of IGameState in jrummikub.model
+  +

+ + + + + + + + + +
Classes in jrummikub.model that implement IGameState
+ classGameState + +
+          Class managing the overall and momentary GameState
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/IHand.html b/doc/jrummikub/model/class-use/IHand.html new file mode 100644 index 0000000..5f3a4a4 --- /dev/null +++ b/doc/jrummikub/model/class-use/IHand.html @@ -0,0 +1,243 @@ + + + + + + +Uses of Interface jrummikub.model.IHand + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.model.IHand

+
+ + + + + + + + + + + + + +
+Packages that use IHand
jrummikub.control  
jrummikub.model  
+  +

+ + + + + +
+Uses of IHand in jrummikub.control
+  +

+ + + + + + + + + + + +
Constructors in jrummikub.control with parameters of type IHand
TurnControl(IHand hand, + ITable table, + IView view) + +
+          Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction.
TurnControl(IHand hand, + ITable table, + IView view, + ITurnTimer testTimer) + +
+          Test only constructor
+  +

+ + + + + +
+Uses of IHand in jrummikub.model
+  +

+ + + + + + + + + +
Classes in jrummikub.model that implement IHand
+ classHand + +
+          Class managing a Player's Stones
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return IHand
+ IHandPlayer.getHand() + +
+           
+ IHandIPlayer.getHand() + +
+          Get the current hand of the player
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/IPlayer.html b/doc/jrummikub/model/class-use/IPlayer.html new file mode 100644 index 0000000..8c8bad6 --- /dev/null +++ b/doc/jrummikub/model/class-use/IPlayer.html @@ -0,0 +1,220 @@ + + + + + + +Uses of Interface jrummikub.model.IPlayer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.model.IPlayer

+
+ + + + + + + + + +
+Packages that use IPlayer
jrummikub.model  
+  +

+ + + + + +
+Uses of IPlayer in jrummikub.model
+  +

+ + + + + + + + + +
Classes in jrummikub.model that implement IPlayer
+ classPlayer + +
+          Class managing player data.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return IPlayer
+ IPlayerGameState.getActivePlayer() + +
+           
+ IPlayerIGameState.getActivePlayer() + +
+          Returns the currently active player
+ IPlayerGameState.getNthNextPlayer(int i) + +
+           
+ IPlayerIGameState.getNthNextPlayer(int i) + +
+          Returns the player that would be the active player after i turns
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/IStoneTray.html b/doc/jrummikub/model/class-use/IStoneTray.html new file mode 100644 index 0000000..44ec421 --- /dev/null +++ b/doc/jrummikub/model/class-use/IStoneTray.html @@ -0,0 +1,245 @@ + + + + + + +Uses of Interface jrummikub.model.IStoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.model.IStoneTray

+
+ + + + + + + + + +
+Packages that use IStoneTray
jrummikub.model  
+  +

+ + + + + +
+Uses of IStoneTray in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Subinterfaces of IStoneTray in jrummikub.model
+ interfaceIHand + +
+          Interface for the Hand model
+ interfaceITable + +
+          Interface for the Table model
+  +

+ + + + + + + + + + + + + + + + + +
Classes in jrummikub.model that implement IStoneTray
+ classHand + +
+          Class managing a Player's Stones
+ classStoneTray<E extends Sizeable> + +
+          A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
+ classTable + +
+          Class administering the Stones on the game-Table
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return IStoneTray
+ IStoneTray<E>StoneTray.clone() + +
+           
+ IStoneTray<E>IStoneTray.clone() + +
+          Create a clone of the StoneTray
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/ITable.html b/doc/jrummikub/model/class-use/ITable.html new file mode 100644 index 0000000..389391a --- /dev/null +++ b/doc/jrummikub/model/class-use/ITable.html @@ -0,0 +1,284 @@ + + + + + + +Uses of Interface jrummikub.model.ITable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.model.ITable

+
+ + + + + + + + + + + + + +
+Packages that use ITable
jrummikub.control  
jrummikub.model  
+  +

+ + + + + +
+Uses of ITable in jrummikub.control
+  +

+ + + + + + + + + +
Methods in jrummikub.control with parameters of type ITable
+(package private) static java.util.Set<Stone>RoundControl.tableDifference(ITable oldTable, + ITable newTable) + +
+           
+  +

+ + + + + + + + + + + +
Constructors in jrummikub.control with parameters of type ITable
TurnControl(IHand hand, + ITable table, + IView view) + +
+          Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction.
TurnControl(IHand hand, + ITable table, + IView view, + ITurnTimer testTimer) + +
+          Test only constructor
+  +

+ + + + + +
+Uses of ITable in jrummikub.model
+  +

+ + + + + + + + + +
Classes in jrummikub.model that implement ITable
+ classTable + +
+          Class administering the Stones on the game-Table
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return ITable
+ ITableGameState.getTable() + +
+           
+ ITableIGameState.getTable() + +
+          Get the current Table
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model with parameters of type ITable
+ voidGameState.setTable(ITable table) + +
+           
+ voidIGameState.setTable(ITable table) + +
+          Sets the current Table
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Player.html b/doc/jrummikub/model/class-use/Player.html new file mode 100644 index 0000000..ca51d52 --- /dev/null +++ b/doc/jrummikub/model/class-use/Player.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.model.Player + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.Player

+
+No usage of jrummikub.model.Player +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Position.html b/doc/jrummikub/model/class-use/Position.html new file mode 100644 index 0000000..02e14f5 --- /dev/null +++ b/doc/jrummikub/model/class-use/Position.html @@ -0,0 +1,526 @@ + + + + + + +Uses of Class jrummikub.model.Position + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.Position

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use Position
jrummikub.control  
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of Position in jrummikub.control
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.control with type arguments of type Position
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+  +

+ + + + + +
+Uses of Position in jrummikub.model
+  +

+ + + + + + + + + +
Fields in jrummikub.model with type parameters of type Position
+protected  java.util.HashMap<E,Pair<E,Position>>StoneTray.objects + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return Position
+ PositionStoneTray.getPosition(E object) + +
+           
+ PositionIStoneTray.getPosition(E object) + +
+          Returns the position of an object that is already on the tray
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type Position
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+ java.util.Iterator<Pair<E,Position>>StoneTray.iterator() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.model with parameters of type Position
+ voidStoneTray.drop(E object, + Position position) + +
+           
+ voidIStoneTray.drop(E object, + Position position) + +
+          Adds object to the tray
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+  +

+ + + + + +
+Uses of Position in jrummikub.view
+  +

+ + + + + + + + + +
Methods in jrummikub.view that return types with arguments of type Position
+ IEvent1<Position>IClickable.getClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.view with type arguments of type Position
+ voidIHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Set the player's stones to display on the board
+ voidITablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+          Sets the stone sets lying on the table
+  +

+ + + + + +
+Uses of Position in jrummikub.view.impl
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return Position
+ PositionStonePainter.calculatePosition(int x, + int y) + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return types with arguments of type Position
+ Event1<Position>AbstractStonePanel.getClickEvent() + +
+           
+protected  java.lang.Iterable<Pair<Stone,Position>>AbstractStonePanel.getStones() + +
+          Returns the list of stones and positions currently set
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.view.impl with parameters of type Position
+protected  booleanStoneCollectionPanel.handleOtherClickEvent(Position pos) + +
+           
+protected  booleanTablePanel.handleOtherClickEvent(Position pos) + +
+           
+protected  booleanAbstractStonePanel.handleOtherClickEvent(Position pos) + +
+          Overwrite this method to signal if special zone was clicked
+protected  voidTablePanel.handleOtherMoveEvent(Position pos) + +
+           
+protected  voidAbstractStonePanel.handleOtherMoveEvent(Position pos) + +
+          Overwrite this method to signal if special zone was hovered
+ voidStonePainter.paintStone(java.awt.Graphics2D g, + Stone stone, + Position p, + boolean selected, + boolean hovered) + +
+          Paints a stone
+  +

+ + + + + + + + + + + + + + + + + +
Method parameters in jrummikub.view.impl with type arguments of type Position
+ voidHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+           
+protected  voidAbstractStonePanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Sets the list of stones that can be clicked on
+ voidTablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Sizeable.html b/doc/jrummikub/model/class-use/Sizeable.html new file mode 100644 index 0000000..d618618 --- /dev/null +++ b/doc/jrummikub/model/class-use/Sizeable.html @@ -0,0 +1,213 @@ + + + + + + +Uses of Interface jrummikub.model.Sizeable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.model.Sizeable

+
+ + + + + + + + + +
+Packages that use Sizeable
jrummikub.model  
+  +

+ + + + + +
+Uses of Sizeable in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Classes in jrummikub.model with type parameters of type Sizeable
+ interfaceIStoneTray<E extends Sizeable> + +
+          Interface for the StoneTray model
+ classStoneTray<E extends Sizeable> + +
+          A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
+  +

+ + + + + + + + + + + + + +
Classes in jrummikub.model that implement Sizeable
+ classStone + +
+          Basic Rummikub Stone
+ classStoneSet + +
+          Class managing Stones joined together to form sets
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Stone.html b/doc/jrummikub/model/class-use/Stone.html new file mode 100644 index 0000000..4f4ffb2 --- /dev/null +++ b/doc/jrummikub/model/class-use/Stone.html @@ -0,0 +1,594 @@ + + + + + + +Uses of Class jrummikub.model.Stone + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.Stone

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use Stone
jrummikub.control  
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of Stone in jrummikub.control
+  +

+ + + + + + + + + +
Methods in jrummikub.control that return types with arguments of type Stone
+(package private) static java.util.Set<Stone>RoundControl.tableDifference(ITable oldTable, + ITable newTable) + +
+           
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.control with type arguments of type Stone
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+  +

+ + + + + +
+Uses of Stone in jrummikub.model
+  +

+ + + + + + + + + +
Fields in jrummikub.model with type parameters of type Stone
+(package private)  java.util.List<Stone>StoneHeap.heap + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return Stone
+ StoneStoneHeap.drawStone() + +
+          Removes random Stone from the heap and returns it
+ StoneStoneSet.get(int i) + +
+          Returns the i-th stone of the set (starting with 0)
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type Stone
+ java.util.List<Stone>StoneHeap.drawStones(int number) + +
+          Removes several Stones from the heap and returns them
+ java.util.Iterator<Stone>StoneSet.iterator() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.model with parameters of type Stone
+ StoneSetTable.findStoneSet(Stone stone) + +
+           
+ StoneSetITable.findStoneSet(Stone stone) + +
+          Finds the StoneSet containing the given Stone
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+ voidTable.pickUpStone(Stone stone) + +
+          Removes Stone from the Table
+ voidITable.pickUpStone(Stone stone) + +
+          Removes Stone from the Table
+  +

+ + + + + + + + + +
Method parameters in jrummikub.model with type arguments of type Stone
+ voidStoneHeap.putBack(java.util.Collection<Stone> stones) + +
+          Put stones back on the heap
+  +

+ + + + + + + + +
Constructors in jrummikub.model with parameters of type Stone
StoneSet(Stone stone) + +
+          Create a new single stone stone set
+  +

+ + + + + + + + +
Constructor parameters in jrummikub.model with type arguments of type Stone
StoneSet(java.util.List<Stone> stones) + +
+          Create a stone set from a list of stones
+  +

+ + + + + +
+Uses of Stone in jrummikub.view
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.view that return types with arguments of type Stone
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getRangeClickEvent() + +
+          the range click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a range instead of a single stone
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getSetClickEvent() + +
+          the set click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a whole set instead of a single stone
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getStoneClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.view with type arguments of type Stone
+ voidIView.setSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the stones that are to be painted selected
+ voidIHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Set the player's stones to display on the board
+  +

+ + + + + +
+Uses of Stone in jrummikub.view.impl
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return Stone
+protected  StoneAbstractStonePanel.getHoveredStone() + +
+          Returns the stone the mouse pointer is hovering over
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return types with arguments of type Stone
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getRangeClickEvent() + +
+           
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getSetClickEvent() + +
+           
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getStoneClickEvent() + +
+           
+protected  java.lang.Iterable<Pair<Stone,Position>>AbstractStonePanel.getStones() + +
+          Returns the list of stones and positions currently set
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl with parameters of type Stone
+ voidStonePainter.paintStone(java.awt.Graphics2D g, + Stone stone, + Position p, + boolean selected, + boolean hovered) + +
+          Paints a stone
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method parameters in jrummikub.view.impl with type arguments of type Stone
+ voidView.setSelectedStones(java.util.Collection<Stone> stones) + +
+           
+(package private)  voidHandPanel.setSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the stones that are to be painted selected
+(package private)  voidStoneCollectionPanel.setSelectedStones(java.util.Collection<Stone> selectedStones) + +
+          Sets the stones to be shown in the collection
+(package private)  voidTablePanel.setSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the currently selected stones
+ voidHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+           
+protected  voidAbstractStonePanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Sets the list of stones that can be clicked on
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneColor.html b/doc/jrummikub/model/class-use/StoneColor.html new file mode 100644 index 0000000..607384d --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneColor.html @@ -0,0 +1,218 @@ + + + + + + +Uses of Class jrummikub.model.StoneColor + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneColor

+
+ + + + + + + + + +
+Packages that use StoneColor
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneColor in jrummikub.model
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneColor
+ StoneColorStone.getColor() + +
+          Returns the color of the stone.
+static StoneColorStoneColor.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneColor[]StoneColor.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + +
Constructors in jrummikub.model with parameters of type StoneColor
Stone(int value, + StoneColor color) + +
+          Creates a normal stone of a given color and value
Stone(StoneColor color) + +
+          Creates a joker of the given color.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneHeap.html b/doc/jrummikub/model/class-use/StoneHeap.html new file mode 100644 index 0000000..444c48e --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneHeap.html @@ -0,0 +1,188 @@ + + + + + + +Uses of Class jrummikub.model.StoneHeap + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneHeap

+
+ + + + + + + + + +
+Packages that use StoneHeap
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneHeap in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneHeap
+ StoneHeapGameState.getGameHeap() + +
+           
+ StoneHeapIGameState.getGameHeap() + +
+          Returns the heap of stones to draw from
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneSet.Type.html b/doc/jrummikub/model/class-use/StoneSet.Type.html new file mode 100644 index 0000000..db9e788 --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneSet.Type.html @@ -0,0 +1,198 @@ + + + + + + +Uses of Class jrummikub.model.StoneSet.Type + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneSet.Type

+
+ + + + + + + + + +
+Packages that use StoneSet.Type
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneSet.Type in jrummikub.model
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneSet.Type
+ StoneSet.TypeStoneSet.classify() + +
+          Test for rule conflict within the StoneSet and determine whether the set + is a group or a run
+static StoneSet.TypeStoneSet.Type.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneSet.Type[]StoneSet.Type.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneSet.html b/doc/jrummikub/model/class-use/StoneSet.html new file mode 100644 index 0000000..aa76b18 --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneSet.html @@ -0,0 +1,346 @@ + + + + + + +Uses of Class jrummikub.model.StoneSet + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneSet

+
+ + + + + + + + + + + + + + + + + +
+Packages that use StoneSet
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of StoneSet in jrummikub.model
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneSet
+ StoneSetTable.findStoneSet(Stone stone) + +
+           
+ StoneSetITable.findStoneSet(Stone stone) + +
+          Finds the StoneSet containing the given Stone
+ StoneSetStoneSet.join(StoneSet other) + +
+          Joins StoneSet to another StoneSet and returns the resulting new StoneSet
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type StoneSet
+ Pair<StoneSet,StoneSet>StoneSet.splitAt(int position) + +
+          Splits the StoneSet at a specified Position and returns two new + Stone Sets
+ Pair<StoneSet,StoneSet>StoneSet.splitAt(int position) + +
+          Splits the StoneSet at a specified Position and returns two new + Stone Sets
+  +

+ + + + + + + + + +
Methods in jrummikub.model with parameters of type StoneSet
+ StoneSetStoneSet.join(StoneSet other) + +
+          Joins StoneSet to another StoneSet and returns the resulting new StoneSet
+  +

+ + + + + +
+Uses of StoneSet in jrummikub.view
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.view that return types with arguments of type StoneSet
+ Event1<StoneSet>ITablePanel.getLeftConnectorClickEvent() + +
+          the left connector click event is emitted when the player clicks on a left + connector of a stone set on the table .
+ Event1<StoneSet>ITablePanel.getRightConnectorClickEvent() + +
+          the right connector click event is emitted when the player clicks on a + right connector of a stone set on the table .
+  +

+ + + + + + + + + +
Method parameters in jrummikub.view with type arguments of type StoneSet
+ voidITablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+          Sets the stone sets lying on the table
+  +

+ + + + + +
+Uses of StoneSet in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return types with arguments of type StoneSet
+ Event1<StoneSet>TablePanel.getLeftConnectorClickEvent() + +
+           
+ Event1<StoneSet>TablePanel.getRightConnectorClickEvent() + +
+           
+  +

+ + + + + + + + + +
Method parameters in jrummikub.view.impl with type arguments of type StoneSet
+ voidTablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneTray.Direction.html b/doc/jrummikub/model/class-use/StoneTray.Direction.html new file mode 100644 index 0000000..99dba01 --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneTray.Direction.html @@ -0,0 +1,247 @@ + + + + + + +Uses of Class jrummikub.model.StoneTray.Direction + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneTray.Direction

+
+ + + + + + + + + +
+Packages that use StoneTray.Direction
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneTray.Direction in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneTray.Direction
+static StoneTray.DirectionStoneTray.Direction.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneTray.Direction[]StoneTray.Direction.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type StoneTray.Direction
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model with parameters of type StoneTray.Direction
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneTray.html b/doc/jrummikub/model/class-use/StoneTray.html new file mode 100644 index 0000000..151751d --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneTray.html @@ -0,0 +1,188 @@ + + + + + + +Uses of Class jrummikub.model.StoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneTray

+
+ + + + + + + + + +
+Packages that use StoneTray
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneTray in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Subclasses of StoneTray in jrummikub.model
+ classHand + +
+          Class managing a Player's Stones
+ classTable + +
+          Class administering the Stones on the game-Table
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Table.html b/doc/jrummikub/model/class-use/Table.html new file mode 100644 index 0000000..a609b30 --- /dev/null +++ b/doc/jrummikub/model/class-use/Table.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.model.Table + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.model.Table

+
+No usage of jrummikub.model.Table +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/package-frame.html b/doc/jrummikub/model/package-frame.html new file mode 100644 index 0000000..2a14a75 --- /dev/null +++ b/doc/jrummikub/model/package-frame.html @@ -0,0 +1,84 @@ + + + + + + +jrummikub.model + + + + + + + + + + + +jrummikub.model + + + + +
+Interfaces  + +
+IGameState +
+IHand +
+IPlayer +
+IStoneTray +
+ITable +
+Sizeable
+ + + + + + +
+Classes  + +
+GameState +
+Hand +
+Player +
+Position +
+Stone +
+StoneHeap +
+StoneSet +
+StoneTray +
+Table
+ + + + + + +
+Enums  + +
+StoneColor +
+StoneSet.Type +
+StoneTray.Direction
+ + + + diff --git a/doc/jrummikub/model/package-summary.html b/doc/jrummikub/model/package-summary.html new file mode 100644 index 0000000..808ee51 --- /dev/null +++ b/doc/jrummikub/model/package-summary.html @@ -0,0 +1,248 @@ + + + + + + +jrummikub.model + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package jrummikub.model +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
IGameStateInterface for GameState model
IHandInterface for the Hand model
IPlayerInterface for Player model
IStoneTray<E extends Sizeable>Interface for the StoneTray model
ITableInterface for the Table model
SizeableObjects that have a size.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
GameStateClass managing the overall and momentary GameState
HandClass managing a Player's Stones
PlayerClass managing player data.
PositionStone Position class to determine positions on Table or + Hand
StoneBasic Rummikub Stone
StoneHeapStoneHeap creates all Stones for a game, manages them and allows + players to draw one or more random Stones.
StoneSetClass managing Stones joined together to form sets
StoneTray<E extends Sizeable>A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
TableClass administering the Stones on the game-Table
+  + +

+ + + + + + + + + + + + + + + + + +
+Enum Summary
StoneColorClass specifying possible StoneColors
StoneSet.TypeValidity type of the set
StoneTray.DirectionPossible move directions in case of overlapping Stones/Sets
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/package-tree.html b/doc/jrummikub/model/package-tree.html new file mode 100644 index 0000000..5c93b2e --- /dev/null +++ b/doc/jrummikub/model/package-tree.html @@ -0,0 +1,187 @@ + + + + + + +jrummikub.model Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package jrummikub.model +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/model/package-use.html b/doc/jrummikub/model/package-use.html new file mode 100644 index 0000000..faa02f2 --- /dev/null +++ b/doc/jrummikub/model/package-use.html @@ -0,0 +1,359 @@ + + + + + + +Uses of Package jrummikub.model + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
jrummikub.model

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use jrummikub.model
jrummikub.control  
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.model used by jrummikub.control
IGameState + +
+          Interface for GameState model
IHand + +
+          Interface for the Hand model
ITable + +
+          Interface for the Table model
Position + +
+          Stone Position class to determine positions on Table or + Hand
Stone + +
+          Basic Rummikub Stone
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.model used by jrummikub.model
IGameState + +
+          Interface for GameState model
IHand + +
+          Interface for the Hand model
IPlayer + +
+          Interface for Player model
IStoneTray + +
+          Interface for the StoneTray model
ITable + +
+          Interface for the Table model
Position + +
+          Stone Position class to determine positions on Table or + Hand
Sizeable + +
+          Objects that have a size.
Stone + +
+          Basic Rummikub Stone
StoneColor + +
+          Class specifying possible StoneColors
StoneHeap + +
+          StoneHeap creates all Stones for a game, manages them and allows + players to draw one or more random Stones.
StoneSet + +
+          Class managing Stones joined together to form sets
StoneSet.Type + +
+          Validity type of the set
StoneTray + +
+          A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
StoneTray.Direction + +
+          Possible move directions in case of overlapping Stones/Sets
+  +

+ + + + + + + + + + + + + + +
+Classes in jrummikub.model used by jrummikub.view
Position + +
+          Stone Position class to determine positions on Table or + Hand
Stone + +
+          Basic Rummikub Stone
StoneSet + +
+          Class managing Stones joined together to form sets
+  +

+ + + + + + + + + + + + + + +
+Classes in jrummikub.model used by jrummikub.view.impl
Position + +
+          Stone Position class to determine positions on Table or + Hand
Stone + +
+          Basic Rummikub Stone
StoneSet + +
+          Class managing Stones joined together to form sets
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/package-frame.html b/doc/jrummikub/package-frame.html new file mode 100644 index 0000000..12ccb4a --- /dev/null +++ b/doc/jrummikub/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +jrummikub + + + + + + + + + + + +jrummikub + + + + +
+Classes  + +
+JRummikub
+ + + + diff --git a/doc/jrummikub/package-summary.html b/doc/jrummikub/package-summary.html new file mode 100644 index 0000000..50410b4 --- /dev/null +++ b/doc/jrummikub/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +jrummikub + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package jrummikub +

+ + + + + + + + + +
+Class Summary
JRummikubThe main class
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/package-tree.html b/doc/jrummikub/package-tree.html new file mode 100644 index 0000000..8232457 --- /dev/null +++ b/doc/jrummikub/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +jrummikub Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package jrummikub +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/package-use.html b/doc/jrummikub/package-use.html new file mode 100644 index 0000000..abd1a32 --- /dev/null +++ b/doc/jrummikub/package-use.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Package jrummikub + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
jrummikub

+
+No usage of jrummikub +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/Connection.html b/doc/jrummikub/util/Connection.html new file mode 100644 index 0000000..c3482cd --- /dev/null +++ b/doc/jrummikub/util/Connection.html @@ -0,0 +1,212 @@ + + + + + + +Connection + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Interface Connection

+
+
+
public interface Connection
+ + +

+A Connection object can be used to remove a listener from a event +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidremove() + +
+          Removes the listener
+  +

+ + + + + + + + +
+Method Detail
+ +

+remove

+
+void remove()
+
+
Removes the listener +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/Event.html b/doc/jrummikub/util/Event.html new file mode 100644 index 0000000..731f999 --- /dev/null +++ b/doc/jrummikub/util/Event.html @@ -0,0 +1,315 @@ + + + + + + +Event + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Class Event

+
+java.lang.Object
+  extended by jrummikub.util.Event
+
+
+
All Implemented Interfaces:
IEvent
+
+
+
+
public class Event
extends java.lang.Object
implements IEvent
+ + +

+Simple parameterless event generator +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Event() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Connectionadd(IListener listener) + +
+          Start to publish all events to a given listener
+ voidemit() + +
+          Generate a single event
+ voidremove(IListener listener) + +
+          Stop publishing events to a given listener
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Event

+
+public Event()
+
+
+ + + + + + + + +
+Method Detail
+ +

+add

+
+public Connection add(IListener listener)
+
+
Description copied from interface: IEvent
+
Start to publish all events to a given listener +

+

+
Specified by:
add in interface IEvent
+
+
+
Parameters:
listener - target listener +
Returns:
a connection to remove the listener
+
+
+
+ +

+remove

+
+public void remove(IListener listener)
+
+
Description copied from interface: IEvent
+
Stop publishing events to a given listener +

+

+
Specified by:
remove in interface IEvent
+
+
+
Parameters:
listener - target listener
+
+
+
+ +

+emit

+
+public void emit()
+
+
Generate a single event +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/Event1.html b/doc/jrummikub/util/Event1.html new file mode 100644 index 0000000..cf2d329 --- /dev/null +++ b/doc/jrummikub/util/Event1.html @@ -0,0 +1,317 @@ + + + + + + +Event1 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Class Event1<T>

+
+java.lang.Object
+  extended by jrummikub.util.Event1<T>
+
+
+
Type Parameters:
T - type of the event parameter
+
+
All Implemented Interfaces:
IEvent1<T>
+
+
+
+
public class Event1<T>
extends java.lang.Object
implements IEvent1<T>
+ + +

+Simple single parameter event generator +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Event1() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Connectionadd(IListener1<T> listener) + +
+          Start to publish all events to a given listener
+ voidemit(T value) + +
+          Generate a single event
+ voidremove(IListener1<T> listener) + +
+          Stop publishing events to a given listener
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Event1

+
+public Event1()
+
+
+ + + + + + + + +
+Method Detail
+ +

+add

+
+public Connection add(IListener1<T> listener)
+
+
Description copied from interface: IEvent1
+
Start to publish all events to a given listener +

+

+
Specified by:
add in interface IEvent1<T>
+
+
+
Parameters:
listener - target listener +
Returns:
a connection to remove the listener
+
+
+
+ +

+remove

+
+public void remove(IListener1<T> listener)
+
+
Description copied from interface: IEvent1
+
Stop publishing events to a given listener +

+

+
Specified by:
remove in interface IEvent1<T>
+
+
+
Parameters:
listener - target listener
+
+
+
+ +

+emit

+
+public void emit(T value)
+
+
Generate a single event +

+

+
+
+
+
Parameters:
value - the event parameter
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/Event2.html b/doc/jrummikub/util/Event2.html new file mode 100644 index 0000000..4d98f5a --- /dev/null +++ b/doc/jrummikub/util/Event2.html @@ -0,0 +1,319 @@ + + + + + + +Event2 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Class Event2<T1,T2>

+
+java.lang.Object
+  extended by jrummikub.util.Event2<T1,T2>
+
+
+
Type Parameters:
T1 - type of the first event parameter
T2 - type of the second event parameter
+
+
All Implemented Interfaces:
IEvent2<T1,T2>
+
+
+
+
public class Event2<T1,T2>
extends java.lang.Object
implements IEvent2<T1,T2>
+ + +

+Simple single parameter event generator +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Event2() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Connectionadd(IListener2<T1,T2> listener) + +
+          Start to publish all events to a given listener
+ voidemit(T1 value1, + T2 value2) + +
+          Generate a single event
+ voidremove(IListener2<T1,T2> listener) + +
+          Stop publishing events to a given listener
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Event2

+
+public Event2()
+
+
+ + + + + + + + +
+Method Detail
+ +

+add

+
+public Connection add(IListener2<T1,T2> listener)
+
+
Description copied from interface: IEvent2
+
Start to publish all events to a given listener +

+

+
Specified by:
add in interface IEvent2<T1,T2>
+
+
+
Parameters:
listener - target listener +
Returns:
a connection to remove the listener
+
+
+
+ +

+remove

+
+public void remove(IListener2<T1,T2> listener)
+
+
Description copied from interface: IEvent2
+
Stop publishing events to a given listener +

+

+
Specified by:
remove in interface IEvent2<T1,T2>
+
+
+
Parameters:
listener - target listener
+
+
+
+ +

+emit

+
+public void emit(T1 value1,
+                 T2 value2)
+
+
Generate a single event +

+

+
+
+
+
Parameters:
value1 - the first event parameter
value2 - the second event parameter
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/IEvent.html b/doc/jrummikub/util/IEvent.html new file mode 100644 index 0000000..064f38a --- /dev/null +++ b/doc/jrummikub/util/IEvent.html @@ -0,0 +1,237 @@ + + + + + + +IEvent + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Interface IEvent

+
+
All Known Implementing Classes:
Event
+
+
+
+
public interface IEvent
+ + +

+Interface for classes that can generate parameterless events +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ Connectionadd(IListener listener) + +
+          Start to publish all events to a given listener
+ voidremove(IListener listener) + +
+          Stop publishing events to a given listener
+  +

+ + + + + + + + +
+Method Detail
+ +

+add

+
+Connection add(IListener listener)
+
+
Start to publish all events to a given listener +

+

+
Parameters:
listener - target listener +
Returns:
a connection to remove the listener
+
+
+
+ +

+remove

+
+void remove(IListener listener)
+
+
Stop publishing events to a given listener +

+

+
Parameters:
listener - target listener
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/IEvent1.html b/doc/jrummikub/util/IEvent1.html new file mode 100644 index 0000000..6c4f728 --- /dev/null +++ b/doc/jrummikub/util/IEvent1.html @@ -0,0 +1,239 @@ + + + + + + +IEvent1 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Interface IEvent1<T>

+
+
Type Parameters:
T - type of the event parameter
+
+
All Known Implementing Classes:
Event1
+
+
+
+
public interface IEvent1<T>
+ + +

+Interface for classes that can generate events having a single parameter +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ Connectionadd(IListener1<T> listener) + +
+          Start to publish all events to a given listener
+ voidremove(IListener1<T> listener) + +
+          Stop publishing events to a given listener
+  +

+ + + + + + + + +
+Method Detail
+ +

+add

+
+Connection add(IListener1<T> listener)
+
+
Start to publish all events to a given listener +

+

+
Parameters:
listener - target listener +
Returns:
a connection to remove the listener
+
+
+
+ +

+remove

+
+void remove(IListener1<T> listener)
+
+
Stop publishing events to a given listener +

+

+
Parameters:
listener - target listener
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/IEvent2.html b/doc/jrummikub/util/IEvent2.html new file mode 100644 index 0000000..bcceb8c --- /dev/null +++ b/doc/jrummikub/util/IEvent2.html @@ -0,0 +1,239 @@ + + + + + + +IEvent2 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Interface IEvent2<T1,T2>

+
+
Type Parameters:
T1 - type of the first event parameter
T2 - type of the second event parameter
+
+
All Known Implementing Classes:
Event2
+
+
+
+
public interface IEvent2<T1,T2>
+ + +

+Interface for classes that can generate events having a two parameters +

+ +

+


+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ Connectionadd(IListener2<T1,T2> listener) + +
+          Start to publish all events to a given listener
+ voidremove(IListener2<T1,T2> listener) + +
+          Stop publishing events to a given listener
+  +

+ + + + + + + + +
+Method Detail
+ +

+add

+
+Connection add(IListener2<T1,T2> listener)
+
+
Start to publish all events to a given listener +

+

+
Parameters:
listener - target listener +
Returns:
a connection to remove the listener
+
+
+
+ +

+remove

+
+void remove(IListener2<T1,T2> listener)
+
+
Stop publishing events to a given listener +

+

+
Parameters:
listener - target listener
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/IListener.html b/doc/jrummikub/util/IListener.html new file mode 100644 index 0000000..d0beb53 --- /dev/null +++ b/doc/jrummikub/util/IListener.html @@ -0,0 +1,212 @@ + + + + + + +IListener + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Interface IListener

+
+
+
public interface IListener
+ + +

+Interface for classes that can receive parameterless events +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidhandle() + +
+          This method is called whenever a class we're listening to emits an event
+  +

+ + + + + + + + +
+Method Detail
+ +

+handle

+
+void handle()
+
+
This method is called whenever a class we're listening to emits an event +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/IListener1.html b/doc/jrummikub/util/IListener1.html new file mode 100644 index 0000000..154ff13 --- /dev/null +++ b/doc/jrummikub/util/IListener1.html @@ -0,0 +1,215 @@ + + + + + + +IListener1 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Interface IListener1<T>

+
+
Type Parameters:
T - type of the event parameter
+
+
+
public interface IListener1<T>
+ + +

+Interface for classes that can receive parameterless events having a single + parameter +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidhandle(T value) + +
+          This method is called whenever a class we're listening to emits an event
+  +

+ + + + + + + + +
+Method Detail
+ +

+handle

+
+void handle(T value)
+
+
This method is called whenever a class we're listening to emits an event +

+

+
Parameters:
value - the event parameter
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/IListener2.html b/doc/jrummikub/util/IListener2.html new file mode 100644 index 0000000..62dd420 --- /dev/null +++ b/doc/jrummikub/util/IListener2.html @@ -0,0 +1,217 @@ + + + + + + +IListener2 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Interface IListener2<T1,T2>

+
+
Type Parameters:
T1 - type of the first event parameter
T2 - type of the first event parameter
+
+
+
public interface IListener2<T1,T2>
+ + +

+Interface for classes that can receive parameterless events having a two + parameters +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ voidhandle(T1 value1, + T2 value2) + +
+          This method is called whenever a class we're listening to emits an event
+  +

+ + + + + + + + +
+Method Detail
+ +

+handle

+
+void handle(T1 value1,
+            T2 value2)
+
+
This method is called whenever a class we're listening to emits an event +

+

+
Parameters:
value1 - the first event parameter
value2 - the second event parameter
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/Pair.html b/doc/jrummikub/util/Pair.html new file mode 100644 index 0000000..f06ff3e --- /dev/null +++ b/doc/jrummikub/util/Pair.html @@ -0,0 +1,289 @@ + + + + + + +Pair + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.util +
+Class Pair<T1,T2>

+
+java.lang.Object
+  extended by jrummikub.util.Pair<T1,T2>
+
+
+
Type Parameters:
T1 - Type of first component
T2 - Type of second component
+
+
+
public class Pair<T1,T2>
extends java.lang.Object
+ + +

+A pair of objects +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
Pair(T1 first, + T2 second) + +
+          Create a new pair from two values
+  + + + + + + + + + + + + + + + +
+Method Summary
+ T1getFirst() + +
+          Extract the first component of a pair
+ T2getSecond() + +
+          Extract the second component of a pair
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Pair

+
+public Pair(T1 first,
+            T2 second)
+
+
Create a new pair from two values +

+

+
Parameters:
first - the first pair component
second - the second pair component
+
+ + + + + + + + +
+Method Detail
+ +

+getFirst

+
+public T1 getFirst()
+
+
Extract the first component of a pair +

+

+ +
Returns:
the first pair component
+
+
+
+ +

+getSecond

+
+public T2 getSecond()
+
+
Extract the second component of a pair +

+

+ +
Returns:
the second pair component
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/Connection.html b/doc/jrummikub/util/class-use/Connection.html new file mode 100644 index 0000000..f7787cc --- /dev/null +++ b/doc/jrummikub/util/class-use/Connection.html @@ -0,0 +1,220 @@ + + + + + + +Uses of Interface jrummikub.util.Connection + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.util.Connection

+
+ + + + + + + + + +
+Packages that use Connection
jrummikub.util  
+  +

+ + + + + +
+Uses of Connection in jrummikub.util
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.util that return Connection
+ ConnectionEvent.add(IListener listener) + +
+           
+ ConnectionIEvent.add(IListener listener) + +
+          Start to publish all events to a given listener
+ ConnectionIEvent1.add(IListener1<T> listener) + +
+          Start to publish all events to a given listener
+ ConnectionEvent1.add(IListener1<T> listener) + +
+           
+ ConnectionIEvent2.add(IListener2<T1,T2> listener) + +
+          Start to publish all events to a given listener
+ ConnectionEvent2.add(IListener2<T1,T2> listener) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/Event.html b/doc/jrummikub/util/class-use/Event.html new file mode 100644 index 0000000..d5aa835 --- /dev/null +++ b/doc/jrummikub/util/class-use/Event.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.util.Event + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.util.Event

+
+No usage of jrummikub.util.Event +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/Event1.html b/doc/jrummikub/util/class-use/Event1.html new file mode 100644 index 0000000..01666dc --- /dev/null +++ b/doc/jrummikub/util/class-use/Event1.html @@ -0,0 +1,235 @@ + + + + + + +Uses of Class jrummikub.util.Event1 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.util.Event1

+
+ + + + + + + + + + + + + +
+Packages that use Event1
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of Event1 in jrummikub.view
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.view that return Event1
+ Event1<StoneSet>ITablePanel.getLeftConnectorClickEvent() + +
+          the left connector click event is emitted when the player clicks on a left + connector of a stone set on the table .
+ Event1<StoneSet>ITablePanel.getRightConnectorClickEvent() + +
+          the right connector click event is emitted when the player clicks on a + right connector of a stone set on the table .
+  +

+ + + + + +
+Uses of Event1 in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return Event1
+ Event1<Position>AbstractStonePanel.getClickEvent() + +
+           
+ Event1<StoneSet>TablePanel.getLeftConnectorClickEvent() + +
+           
+ Event1<StoneSet>TablePanel.getRightConnectorClickEvent() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/Event2.html b/doc/jrummikub/util/class-use/Event2.html new file mode 100644 index 0000000..5092039 --- /dev/null +++ b/doc/jrummikub/util/class-use/Event2.html @@ -0,0 +1,196 @@ + + + + + + +Uses of Class jrummikub.util.Event2 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.util.Event2

+
+ + + + + + + + + +
+Packages that use Event2
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of Event2 in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return Event2
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getRangeClickEvent() + +
+           
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getSetClickEvent() + +
+           
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getStoneClickEvent() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/IEvent.html b/doc/jrummikub/util/class-use/IEvent.html new file mode 100644 index 0000000..0e13c4b --- /dev/null +++ b/doc/jrummikub/util/class-use/IEvent.html @@ -0,0 +1,398 @@ + + + + + + +Uses of Interface jrummikub.util.IEvent + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.util.IEvent

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use IEvent
jrummikub.control  
jrummikub.util  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of IEvent in jrummikub.control
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.control that return IEvent
+ IEventTurnControl.getEndOfTurnEvent() + +
+          Get the event that is emitted when the turn is over
+ IEventRoundControl.getEndRoundEvent() + +
+          End the round
+ IEventITurnTimer.getTimeRunOutEvent() + +
+          Returns the event that is emitted if the timer timed out.
+ IEventTurnTimer.getTimeRunOutEvent() + +
+           
+  +

+ + + + + +
+Uses of IEvent in jrummikub.util
+  +

+ + + + + + + + + +
Classes in jrummikub.util that implement IEvent
+ classEvent + +
+          Simple parameterless event generator
+  +

+ + + + + +
+Uses of IEvent in jrummikub.view
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.view that return IEvent
+ IEventIPlayerPanel.getEndTurnEvent() + +
+          The end turn event is emitted when the player wants to end his turn
+ IEventIView.getNewGameEvent() + +
+          The new game event is emitted when the player wants to start a new game
+ IEventIView.getQuitEvent() + +
+          The quit event is emitted when the player wants to quit the game
+ IEventIPlayerPanel.getSortByGroupsEvent() + +
+          The sort by groups event is emitted when the player wants to sort his + stones by groups
+ IEventIPlayerPanel.getSortByRunsEvent() + +
+          The sort by runs event is emitted when the player wants to sort his stones + by runs
+ IEventIView.getStartTurnEvent() + +
+          The start turn event is emitted when the player wants to start his turn
+  +

+ + + + + +
+Uses of IEvent in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return IEvent
+ IEventPlayerPanel.getEndTurnEvent() + +
+           
+ IEventView.getNewGameEvent() + +
+           
+(package private)  IEventWinPanel.getNewGameEvent() + +
+          The new game event is emitted when the player wants to start a new game
+ IEventView.getQuitEvent() + +
+           
+(package private)  IEventWinPanel.getQuitEvent() + +
+          The quit event is emitted when the player wants to quit the program
+ IEventPlayerPanel.getSortByGroupsEvent() + +
+           
+ IEventPlayerPanel.getSortByRunsEvent() + +
+           
+ IEventView.getStartTurnEvent() + +
+           
+(package private)  IEventStartTurnPanel.getStartTurnEvent() + +
+          The start turn event is emitted when the current player has clicked the + start turn button
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/IEvent1.html b/doc/jrummikub/util/class-use/IEvent1.html new file mode 100644 index 0000000..1f00da1 --- /dev/null +++ b/doc/jrummikub/util/class-use/IEvent1.html @@ -0,0 +1,239 @@ + + + + + + +Uses of Interface jrummikub.util.IEvent1 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.util.IEvent1

+
+ + + + + + + + + + + + + + + + + +
+Packages that use IEvent1
jrummikub.util  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of IEvent1 in jrummikub.util
+  +

+ + + + + + + + + +
Classes in jrummikub.util that implement IEvent1
+ classEvent1<T> + +
+          Simple single parameter event generator
+  +

+ + + + + +
+Uses of IEvent1 in jrummikub.view
+  +

+ + + + + + + + + +
Methods in jrummikub.view that return IEvent1
+ IEvent1<Position>IClickable.getClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+  +

+ + + + + +
+Uses of IEvent1 in jrummikub.view.impl
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return IEvent1
+(package private)  IEvent1<java.awt.Point>StoneCollectionPanel.getOtherClickEvent() + +
+          The other click event is emitted by the stone collection when the player + has clicked on it, but hasn't hit a stone.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/IEvent2.html b/doc/jrummikub/util/class-use/IEvent2.html new file mode 100644 index 0000000..8cb2eae --- /dev/null +++ b/doc/jrummikub/util/class-use/IEvent2.html @@ -0,0 +1,227 @@ + + + + + + +Uses of Interface jrummikub.util.IEvent2 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.util.IEvent2

+
+ + + + + + + + + + + + + +
+Packages that use IEvent2
jrummikub.util  
jrummikub.view  
+  +

+ + + + + +
+Uses of IEvent2 in jrummikub.util
+  +

+ + + + + + + + + +
Classes in jrummikub.util that implement IEvent2
+ classEvent2<T1,T2> + +
+          Simple single parameter event generator
+  +

+ + + + + +
+Uses of IEvent2 in jrummikub.view
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.view that return IEvent2
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getRangeClickEvent() + +
+          the range click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a range instead of a single stone
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getSetClickEvent() + +
+          the set click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a whole set instead of a single stone
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getStoneClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/IListener.html b/doc/jrummikub/util/class-use/IListener.html new file mode 100644 index 0000000..153acde --- /dev/null +++ b/doc/jrummikub/util/class-use/IListener.html @@ -0,0 +1,204 @@ + + + + + + +Uses of Interface jrummikub.util.IListener + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.util.IListener

+
+ + + + + + + + + +
+Packages that use IListener
jrummikub.util  
+  +

+ + + + + +
+Uses of IListener in jrummikub.util
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.util with parameters of type IListener
+ ConnectionEvent.add(IListener listener) + +
+           
+ ConnectionIEvent.add(IListener listener) + +
+          Start to publish all events to a given listener
+ voidEvent.remove(IListener listener) + +
+           
+ voidIEvent.remove(IListener listener) + +
+          Stop publishing events to a given listener
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/IListener1.html b/doc/jrummikub/util/class-use/IListener1.html new file mode 100644 index 0000000..c68eee7 --- /dev/null +++ b/doc/jrummikub/util/class-use/IListener1.html @@ -0,0 +1,204 @@ + + + + + + +Uses of Interface jrummikub.util.IListener1 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.util.IListener1

+
+ + + + + + + + + +
+Packages that use IListener1
jrummikub.util  
+  +

+ + + + + +
+Uses of IListener1 in jrummikub.util
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.util with parameters of type IListener1
+ ConnectionIEvent1.add(IListener1<T> listener) + +
+          Start to publish all events to a given listener
+ ConnectionEvent1.add(IListener1<T> listener) + +
+           
+ voidIEvent1.remove(IListener1<T> listener) + +
+          Stop publishing events to a given listener
+ voidEvent1.remove(IListener1<T> listener) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/IListener2.html b/doc/jrummikub/util/class-use/IListener2.html new file mode 100644 index 0000000..4a4baa8 --- /dev/null +++ b/doc/jrummikub/util/class-use/IListener2.html @@ -0,0 +1,204 @@ + + + + + + +Uses of Interface jrummikub.util.IListener2 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.util.IListener2

+
+ + + + + + + + + +
+Packages that use IListener2
jrummikub.util  
+  +

+ + + + + +
+Uses of IListener2 in jrummikub.util
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.util with parameters of type IListener2
+ ConnectionIEvent2.add(IListener2<T1,T2> listener) + +
+          Start to publish all events to a given listener
+ ConnectionEvent2.add(IListener2<T1,T2> listener) + +
+           
+ voidIEvent2.remove(IListener2<T1,T2> listener) + +
+          Stop publishing events to a given listener
+ voidEvent2.remove(IListener2<T1,T2> listener) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/class-use/Pair.html b/doc/jrummikub/util/class-use/Pair.html new file mode 100644 index 0000000..407702b --- /dev/null +++ b/doc/jrummikub/util/class-use/Pair.html @@ -0,0 +1,403 @@ + + + + + + +Uses of Class jrummikub.util.Pair + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.util.Pair

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use Pair
jrummikub.control  
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of Pair in jrummikub.control
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.control with parameters of type Pair
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+  +

+ + + + + +
+Uses of Pair in jrummikub.model
+  +

+ + + + + + + + + +
Fields in jrummikub.model with type parameters of type Pair
+protected  java.util.HashMap<E,Pair<E,Position>>StoneTray.objects + +
+           
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return Pair
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+ Pair<StoneSet,StoneSet>StoneSet.splitAt(int position) + +
+          Splits the StoneSet at a specified Position and returns two new + Stone Sets
+  +

+ + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type Pair
+ java.util.Iterator<Pair<E,Position>>StoneTray.iterator() + +
+           
+  +

+ + + + + +
+Uses of Pair in jrummikub.view
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.view with type arguments of type Pair
+ voidIHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Set the player's stones to display on the board
+ voidITablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+          Sets the stone sets lying on the table
+  +

+ + + + + +
+Uses of Pair in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return Pair
+protected  Pair<java.lang.Integer,java.lang.Integer>StoneCollectionPanel.getTranslation() + +
+           
+protected  Pair<java.lang.Integer,java.lang.Integer>TablePanel.getTranslation() + +
+           
+protected  Pair<java.lang.Integer,java.lang.Integer>AbstractStonePanel.getTranslation() + +
+          Returns the translation in pixels the stones in this panel are painted with
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return types with arguments of type Pair
+protected  java.lang.Iterable<Pair<Stone,Position>>AbstractStonePanel.getStones() + +
+          Returns the list of stones and positions currently set
+  +

+ + + + + + + + + + + + + + + + + +
Method parameters in jrummikub.view.impl with type arguments of type Pair
+ voidHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+           
+protected  voidAbstractStonePanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Sets the list of stones that can be clicked on
+ voidTablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/package-frame.html b/doc/jrummikub/util/package-frame.html new file mode 100644 index 0000000..9a8ba9b --- /dev/null +++ b/doc/jrummikub/util/package-frame.html @@ -0,0 +1,61 @@ + + + + + + +jrummikub.util + + + + + + + + + + + +jrummikub.util + + + + +
+Interfaces  + +
+Connection +
+IEvent +
+IEvent1 +
+IEvent2 +
+IListener +
+IListener1 +
+IListener2
+ + + + + + +
+Classes  + +
+Event +
+Event1 +
+Event2 +
+Pair
+ + + + diff --git a/doc/jrummikub/util/package-summary.html b/doc/jrummikub/util/package-summary.html new file mode 100644 index 0000000..0c54057 --- /dev/null +++ b/doc/jrummikub/util/package-summary.html @@ -0,0 +1,209 @@ + + + + + + +jrummikub.util + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package jrummikub.util +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
ConnectionA Connection object can be used to remove a listener from a event
IEventInterface for classes that can generate parameterless events
IEvent1<T>Interface for classes that can generate events having a single parameter
IEvent2<T1,T2>Interface for classes that can generate events having a two parameters
IListenerInterface for classes that can receive parameterless events
IListener1<T>Interface for classes that can receive parameterless events having a single + parameter
IListener2<T1,T2>Interface for classes that can receive parameterless events having a two + parameters
+  + +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
EventSimple parameterless event generator
Event1<T>Simple single parameter event generator
Event2<T1,T2>Simple single parameter event generator
Pair<T1,T2>A pair of objects
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/package-tree.html b/doc/jrummikub/util/package-tree.html new file mode 100644 index 0000000..2a029ad --- /dev/null +++ b/doc/jrummikub/util/package-tree.html @@ -0,0 +1,161 @@ + + + + + + +jrummikub.util Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package jrummikub.util +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/util/package-use.html b/doc/jrummikub/util/package-use.html new file mode 100644 index 0000000..226fa5d --- /dev/null +++ b/doc/jrummikub/util/package-use.html @@ -0,0 +1,338 @@ + + + + + + +Uses of Package jrummikub.util + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
jrummikub.util

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use jrummikub.util
jrummikub.control  
jrummikub.model  
jrummikub.util  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + + + + + + + +
+Classes in jrummikub.util used by jrummikub.control
IEvent + +
+          Interface for classes that can generate parameterless events
Pair + +
+          A pair of objects
+  +

+ + + + + + + + +
+Classes in jrummikub.util used by jrummikub.model
Pair + +
+          A pair of objects
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.util used by jrummikub.util
Connection + +
+          A Connection object can be used to remove a listener from a event
IEvent + +
+          Interface for classes that can generate parameterless events
IEvent1 + +
+          Interface for classes that can generate events having a single parameter
IEvent2 + +
+          Interface for classes that can generate events having a two parameters
IListener + +
+          Interface for classes that can receive parameterless events
IListener1 + +
+          Interface for classes that can receive parameterless events having a single + parameter
IListener2 + +
+          Interface for classes that can receive parameterless events having a two + parameters
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.util used by jrummikub.view
Event1 + +
+          Simple single parameter event generator
IEvent + +
+          Interface for classes that can generate parameterless events
IEvent1 + +
+          Interface for classes that can generate events having a single parameter
IEvent2 + +
+          Interface for classes that can generate events having a two parameters
Pair + +
+          A pair of objects
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.util used by jrummikub.view.impl
Event1 + +
+          Simple single parameter event generator
Event2 + +
+          Simple single parameter event generator
IEvent + +
+          Interface for classes that can generate parameterless events
IEvent1 + +
+          Interface for classes that can generate events having a single parameter
Pair + +
+          A pair of objects
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/IClickable.html b/doc/jrummikub/view/IClickable.html new file mode 100644 index 0000000..10878fc --- /dev/null +++ b/doc/jrummikub/view/IClickable.html @@ -0,0 +1,221 @@ + + + + + + +IClickable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view +
+Interface IClickable

+
+
All Known Subinterfaces:
IHandPanel, ITablePanel
+
+
+
All Known Implementing Classes:
AbstractStonePanel, HandPanel, StoneCollectionPanel, TablePanel
+
+
+
+
public interface IClickable
+ + +

+An interface for view elements that can emit click events +

+ +

+


+ +

+ + + + + + + + + + + + +
+Method Summary
+ IEvent1<Position>getClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getClickEvent

+
+IEvent1<Position> getClickEvent()
+
+
the click event is emitted when the player clicks on the table/hand/etc. +

+

+ +
Returns:
the event; the first parameter is the position of the click in grid + coordinates, the second is true when the player wants to add stones + to his selection instead of replacing them
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/IHandPanel.html b/doc/jrummikub/view/IHandPanel.html new file mode 100644 index 0000000..aed36ab --- /dev/null +++ b/doc/jrummikub/view/IHandPanel.html @@ -0,0 +1,287 @@ + + + + + + +IHandPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view +
+Interface IHandPanel

+
+
All Superinterfaces:
IClickable, IStonePanel
+
+
+
All Known Implementing Classes:
HandPanel
+
+
+
+
public interface IHandPanel
extends IStonePanel, IClickable
+ + +

+The view for a player's hand that displays his stones +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidsetHandHeight(int height) + +
+          Set the number of stones that fit on the hand vertically
+ voidsetHandWidth(int width) + +
+          Set the number of stones that fit on the hand horizontally
+ voidsetStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Set the player's stones to display on the board
+ + + + + + + +
Methods inherited from interface jrummikub.view.IStonePanel
getRangeClickEvent, getSetClickEvent, getStoneClickEvent
+ + + + + + + +
Methods inherited from interface jrummikub.view.IClickable
getClickEvent
+  +

+ + + + + + + + +
+Method Detail
+ +

+setStones

+
+void setStones(java.lang.Iterable<Pair<Stone,Position>> stones)
+
+
Set the player's stones to display on the board +

+

+
+
+
+
Parameters:
stones - the stones
+
+
+
+ +

+setHandWidth

+
+void setHandWidth(int width)
+
+
Set the number of stones that fit on the hand horizontally +

+

+
+
+
+
Parameters:
width - number of stones
+
+
+
+ +

+setHandHeight

+
+void setHandHeight(int height)
+
+
Set the number of stones that fit on the hand vertically +

+

+
+
+
+
Parameters:
height - number of stones
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/IPlayerPanel.html b/doc/jrummikub/view/IPlayerPanel.html new file mode 100644 index 0000000..18721d5 --- /dev/null +++ b/doc/jrummikub/view/IPlayerPanel.html @@ -0,0 +1,305 @@ + + + + + + +IPlayerPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view +
+Interface IPlayerPanel

+
+
All Known Implementing Classes:
PlayerPanel
+
+
+
+
public interface IPlayerPanel
+ + +

+The player panel that contains a player's board and other user interfaces +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IEventgetEndTurnEvent() + +
+          The end turn event is emitted when the player wants to end his turn
+ IHandPanelgetHandPanel() + +
+           
+ IEventgetSortByGroupsEvent() + +
+          The sort by groups event is emitted when the player wants to sort his + stones by groups
+ IEventgetSortByRunsEvent() + +
+          The sort by runs event is emitted when the player wants to sort his stones + by runs
+ voidsetTimeLeft(int time) + +
+          Sets the time the player has left for his turn
+  +

+ + + + + + + + +
+Method Detail
+ +

+getHandPanel

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

+setTimeLeft

+
+void setTimeLeft(int time)
+
+
Sets the time the player has left for his turn +

+

+
Parameters:
time - the time left
+
+
+
+ +

+getSortByGroupsEvent

+
+IEvent getSortByGroupsEvent()
+
+
The sort by groups event is emitted when the player wants to sort his + stones by groups +

+

+ +
Returns:
the event
+
+
+
+ +

+getSortByRunsEvent

+
+IEvent getSortByRunsEvent()
+
+
The sort by runs event is emitted when the player wants to sort his stones + by runs +

+

+ +
Returns:
the event
+
+
+
+ +

+getEndTurnEvent

+
+IEvent getEndTurnEvent()
+
+
The end turn event is emitted when the player wants to end his turn +

+

+ +
Returns:
the event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/IStoneCollectionPanel.html b/doc/jrummikub/view/IStoneCollectionPanel.html new file mode 100644 index 0000000..17c1c75 --- /dev/null +++ b/doc/jrummikub/view/IStoneCollectionPanel.html @@ -0,0 +1,197 @@ + + + + + + +IStoneCollectionPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view +
+Interface IStoneCollectionPanel

+
+
All Superinterfaces:
IStonePanel
+
+
+
All Known Implementing Classes:
StoneCollectionPanel
+
+
+
+
public interface IStoneCollectionPanel
extends IStonePanel
+ + +

+The view of the collection that shows the stones a player has selected +

+ +

+


+ +

+ + + + + + + + +
+Method Summary
+ + + + + + + +
Methods inherited from interface jrummikub.view.IStonePanel
getRangeClickEvent, getSetClickEvent, getStoneClickEvent
+  +

+ +


+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/IStonePanel.html b/doc/jrummikub/view/IStonePanel.html new file mode 100644 index 0000000..516f2a9 --- /dev/null +++ b/doc/jrummikub/view/IStonePanel.html @@ -0,0 +1,273 @@ + + + + + + +IStonePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view +
+Interface IStonePanel

+
+
All Known Subinterfaces:
IHandPanel, IStoneCollectionPanel, ITablePanel
+
+
+
All Known Implementing Classes:
AbstractStonePanel, HandPanel, StoneCollectionPanel, TablePanel
+
+
+
+
public interface IStonePanel
+ + +

+An interface for view elements that can emit click events for clicks on stones +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IEvent2<Stone,java.lang.Boolean>getRangeClickEvent() + +
+          the range click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a range instead of a single stone
+ IEvent2<Stone,java.lang.Boolean>getSetClickEvent() + +
+          the set click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a whole set instead of a single stone
+ IEvent2<Stone,java.lang.Boolean>getStoneClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+  +

+ + + + + + + + +
+Method Detail
+ +

+getStoneClickEvent

+
+IEvent2<Stone,java.lang.Boolean> getStoneClickEvent()
+
+
the click event is emitted when the player clicks on the table/hand/etc. +

+

+ +
Returns:
the event; the first parameter is the position of the click in grid + coordinates, the second is true when the player wants to add stones + to his selection instead of replacing them
+
+
+
+ +

+getRangeClickEvent

+
+IEvent2<Stone,java.lang.Boolean> getRangeClickEvent()
+
+
the range click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a range instead of a single stone +

+

+ +
Returns:
the event; the first parameter is the position of the click in grid + coordinates, the second is true when the player wants to add stones + to his selection instead of replacing them
+
+
+
+ +

+getSetClickEvent

+
+IEvent2<Stone,java.lang.Boolean> getSetClickEvent()
+
+
the set click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a whole set instead of a single stone +

+

+ +
Returns:
the event; the first parameter is the position of the click in grid + coordinates, the second is true when the player wants to add stones + to his selection instead of replacing them
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/ITablePanel.html b/doc/jrummikub/view/ITablePanel.html new file mode 100644 index 0000000..ae759e7 --- /dev/null +++ b/doc/jrummikub/view/ITablePanel.html @@ -0,0 +1,392 @@ + + + + + + +ITablePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view +
+Interface ITablePanel

+
+
All Superinterfaces:
IClickable, IStonePanel
+
+
+
All Known Implementing Classes:
TablePanel
+
+
+
+
public interface ITablePanel
extends IStonePanel, IClickable
+ + +

+The view of the table, where the stone sets lie +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Event1<StoneSet>getLeftConnectorClickEvent() + +
+          the left connector click event is emitted when the player clicks on a left + connector of a stone set on the table .
+ Event1<StoneSet>getRightConnectorClickEvent() + +
+          the right connector click event is emitted when the player clicks on a + right connector of a stone set on the table .
+ IStoneCollectionPanelgetStoneCollectionPanel() + +
+          Returns the stone collection (the panel showing the stones currently + selected)
+ voidsetLeftPlayerName(java.lang.String playerName) + +
+          Sets the player name on the left label
+ voidsetRightPlayerName(java.lang.String playerName) + +
+          Sets the player name on the right label
+ voidsetStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+          Sets the stone sets lying on the table
+ voidsetTopPlayerName(java.lang.String playerName) + +
+          Sets the player name on the top label
+ + + + + + + +
Methods inherited from interface jrummikub.view.IStonePanel
getRangeClickEvent, getSetClickEvent, getStoneClickEvent
+ + + + + + + +
Methods inherited from interface jrummikub.view.IClickable
getClickEvent
+  +

+ + + + + + + + +
+Method Detail
+ +

+setLeftPlayerName

+
+void setLeftPlayerName(java.lang.String playerName)
+
+
Sets the player name on the left label +

+

+
+
+
+
Parameters:
playerName - the name to set
+
+
+
+ +

+setTopPlayerName

+
+void setTopPlayerName(java.lang.String playerName)
+
+
Sets the player name on the top label +

+

+
+
+
+
Parameters:
playerName - the name to set
+
+
+
+ +

+setRightPlayerName

+
+void setRightPlayerName(java.lang.String playerName)
+
+
Sets the player name on the right label +

+

+
+
+
+
Parameters:
playerName - the name to set
+
+
+
+ +

+setStoneSets

+
+void setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets)
+
+
Sets the stone sets lying on the table +

+

+
+
+
+
Parameters:
stoneSets - set stone sets on the table
+
+
+
+ +

+getStoneCollectionPanel

+
+IStoneCollectionPanel getStoneCollectionPanel()
+
+
Returns the stone collection (the panel showing the stones currently + selected) +

+

+
+
+
+ +
Returns:
the stone collection
+
+
+
+ +

+getLeftConnectorClickEvent

+
+Event1<StoneSet> getLeftConnectorClickEvent()
+
+
the left connector click event is emitted when the player clicks on a left + connector of a stone set on the table . +

+

+
+
+
+ +
Returns:
the event
+
+
+
+ +

+getRightConnectorClickEvent

+
+Event1<StoneSet> getRightConnectorClickEvent()
+
+
the right connector click event is emitted when the player clicks on a + right connector of a stone set on the table . +

+

+
+
+
+ +
Returns:
the event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/IView.html b/doc/jrummikub/view/IView.html new file mode 100644 index 0000000..b43a756 --- /dev/null +++ b/doc/jrummikub/view/IView.html @@ -0,0 +1,388 @@ + + + + + + +IView + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view +
+Interface IView

+
+
All Known Implementing Classes:
View
+
+
+
+
public interface IView
+ + +

+The top-level view interface +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidenableStartTurnPanel(boolean enable) + +
+          Enables or disables the player's StartTurnPanel
+ voidenableWinPanel(boolean enable) + +
+          Enables or disables the panel shown when a player has won
+ IEventgetNewGameEvent() + +
+          The new game event is emitted when the player wants to start a new game
+ IPlayerPanelgetPlayerPanel() + +
+          Returns the player panel
+ IEventgetQuitEvent() + +
+          The quit event is emitted when the player wants to quit the game
+ IEventgetStartTurnEvent() + +
+          The start turn event is emitted when the player wants to start his turn
+ ITablePanelgetTablePanel() + +
+          Returns the table
+ voidsetCurrentPlayerName(java.lang.String playerName) + +
+          Sets the current player's name
+ voidsetSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the stones that are to be painted selected
+  +

+ + + + + + + + +
+Method Detail
+ +

+getTablePanel

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

+

+ +
Returns:
the table
+
+
+
+ +

+getPlayerPanel

+
+IPlayerPanel getPlayerPanel()
+
+
Returns the player panel +

+

+ +
Returns:
the playerPanel
+
+
+
+ +

+setCurrentPlayerName

+
+void setCurrentPlayerName(java.lang.String playerName)
+
+
Sets the current player's name +

+

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

+setSelectedStones

+
+void setSelectedStones(java.util.Collection<Stone> stones)
+
+
Sets the stones that are to be painted selected +

+

+
Parameters:
stones - the stones to be painted selected
+
+
+
+ +

+enableStartTurnPanel

+
+void enableStartTurnPanel(boolean enable)
+
+
Enables or disables the player's StartTurnPanel +

+

+
Parameters:
enable - enable/disable
+
+
+
+ +

+getStartTurnEvent

+
+IEvent getStartTurnEvent()
+
+
The start turn event is emitted when the player wants to start his turn +

+

+ +
Returns:
the event
+
+
+
+ +

+enableWinPanel

+
+void enableWinPanel(boolean enable)
+
+
Enables or disables the panel shown when a player has won +

+

+
Parameters:
enable - enable/disable
+
+
+
+ +

+getQuitEvent

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

+

+ +
Returns:
the event
+
+
+
+ +

+getNewGameEvent

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

+

+ +
Returns:
the event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/class-use/IClickable.html b/doc/jrummikub/view/class-use/IClickable.html new file mode 100644 index 0000000..ee6883c --- /dev/null +++ b/doc/jrummikub/view/class-use/IClickable.html @@ -0,0 +1,241 @@ + + + + + + +Uses of Interface jrummikub.view.IClickable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.view.IClickable

+
+ + + + + + + + + + + + + +
+Packages that use IClickable
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of IClickable in jrummikub.view
+  +

+ + + + + + + + + + + + + +
Subinterfaces of IClickable in jrummikub.view
+ interfaceIHandPanel + +
+          The view for a player's hand that displays his stones
+ interfaceITablePanel + +
+          The view of the table, where the stone sets lie
+  +

+ + + + + +
+Uses of IClickable in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Classes in jrummikub.view.impl that implement IClickable
+(package private)  classAbstractStonePanel + +
+          Base class for panels that draw stones
+(package private)  classHandPanel + +
+          Implementation of the board
+(package private)  classStoneCollectionPanel + +
+          Implementation of the stone collection (selection)
+(package private)  classTablePanel + +
+          The implementation of the table
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/class-use/IHandPanel.html b/doc/jrummikub/view/class-use/IHandPanel.html new file mode 100644 index 0000000..5663756 --- /dev/null +++ b/doc/jrummikub/view/class-use/IHandPanel.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Interface jrummikub.view.IHandPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.view.IHandPanel

+
+ + + + + + + + + + + + + +
+Packages that use IHandPanel
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of IHandPanel in jrummikub.view
+  +

+ + + + + + + + + +
Methods in jrummikub.view that return IHandPanel
+ IHandPanelIPlayerPanel.getHandPanel() + +
+           
+  +

+ + + + + +
+Uses of IHandPanel in jrummikub.view.impl
+  +

+ + + + + + + + + +
Classes in jrummikub.view.impl that implement IHandPanel
+(package private)  classHandPanel + +
+          Implementation of the board
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/class-use/IPlayerPanel.html b/doc/jrummikub/view/class-use/IPlayerPanel.html new file mode 100644 index 0000000..6ebde84 --- /dev/null +++ b/doc/jrummikub/view/class-use/IPlayerPanel.html @@ -0,0 +1,225 @@ + + + + + + +Uses of Interface jrummikub.view.IPlayerPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.view.IPlayerPanel

+
+ + + + + + + + + + + + + +
+Packages that use IPlayerPanel
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of IPlayerPanel in jrummikub.view
+  +

+ + + + + + + + + +
Methods in jrummikub.view that return IPlayerPanel
+ IPlayerPanelIView.getPlayerPanel() + +
+          Returns the player panel
+  +

+ + + + + +
+Uses of IPlayerPanel in jrummikub.view.impl
+  +

+ + + + + + + + + +
Classes in jrummikub.view.impl that implement IPlayerPanel
+(package private)  classPlayerPanel + +
+          Implementation of the player panel
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return IPlayerPanel
+ IPlayerPanelView.getPlayerPanel() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/class-use/IStoneCollectionPanel.html b/doc/jrummikub/view/class-use/IStoneCollectionPanel.html new file mode 100644 index 0000000..eec8be6 --- /dev/null +++ b/doc/jrummikub/view/class-use/IStoneCollectionPanel.html @@ -0,0 +1,226 @@ + + + + + + +Uses of Interface jrummikub.view.IStoneCollectionPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.view.IStoneCollectionPanel

+
+ + + + + + + + + + + + + +
+Packages that use IStoneCollectionPanel
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of IStoneCollectionPanel in jrummikub.view
+  +

+ + + + + + + + + +
Methods in jrummikub.view that return IStoneCollectionPanel
+ IStoneCollectionPanelITablePanel.getStoneCollectionPanel() + +
+          Returns the stone collection (the panel showing the stones currently + selected)
+  +

+ + + + + +
+Uses of IStoneCollectionPanel in jrummikub.view.impl
+  +

+ + + + + + + + + +
Classes in jrummikub.view.impl that implement IStoneCollectionPanel
+(package private)  classStoneCollectionPanel + +
+          Implementation of the stone collection (selection)
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return IStoneCollectionPanel
+ IStoneCollectionPanelTablePanel.getStoneCollectionPanel() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/class-use/IStonePanel.html b/doc/jrummikub/view/class-use/IStonePanel.html new file mode 100644 index 0000000..12549e6 --- /dev/null +++ b/doc/jrummikub/view/class-use/IStonePanel.html @@ -0,0 +1,249 @@ + + + + + + +Uses of Interface jrummikub.view.IStonePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.view.IStonePanel

+
+ + + + + + + + + + + + + +
+Packages that use IStonePanel
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of IStonePanel in jrummikub.view
+  +

+ + + + + + + + + + + + + + + + + +
Subinterfaces of IStonePanel in jrummikub.view
+ interfaceIHandPanel + +
+          The view for a player's hand that displays his stones
+ interfaceIStoneCollectionPanel + +
+          The view of the collection that shows the stones a player has selected
+ interfaceITablePanel + +
+          The view of the table, where the stone sets lie
+  +

+ + + + + +
+Uses of IStonePanel in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Classes in jrummikub.view.impl that implement IStonePanel
+(package private)  classAbstractStonePanel + +
+          Base class for panels that draw stones
+(package private)  classHandPanel + +
+          Implementation of the board
+(package private)  classStoneCollectionPanel + +
+          Implementation of the stone collection (selection)
+(package private)  classTablePanel + +
+          The implementation of the table
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/class-use/ITablePanel.html b/doc/jrummikub/view/class-use/ITablePanel.html new file mode 100644 index 0000000..27a8c3d --- /dev/null +++ b/doc/jrummikub/view/class-use/ITablePanel.html @@ -0,0 +1,225 @@ + + + + + + +Uses of Interface jrummikub.view.ITablePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.view.ITablePanel

+
+ + + + + + + + + + + + + +
+Packages that use ITablePanel
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of ITablePanel in jrummikub.view
+  +

+ + + + + + + + + +
Methods in jrummikub.view that return ITablePanel
+ ITablePanelIView.getTablePanel() + +
+          Returns the table
+  +

+ + + + + +
+Uses of ITablePanel in jrummikub.view.impl
+  +

+ + + + + + + + + +
Classes in jrummikub.view.impl that implement ITablePanel
+(package private)  classTablePanel + +
+          The implementation of the table
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return ITablePanel
+ ITablePanelView.getTablePanel() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/class-use/IView.html b/doc/jrummikub/view/class-use/IView.html new file mode 100644 index 0000000..f6cadd8 --- /dev/null +++ b/doc/jrummikub/view/class-use/IView.html @@ -0,0 +1,238 @@ + + + + + + +Uses of Interface jrummikub.view.IView + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.view.IView

+
+ + + + + + + + + + + + + +
+Packages that use IView
jrummikub.control  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of IView in jrummikub.control
+  +

+ + + + + + + + + + + + + + + + + + + + +
Constructors in jrummikub.control with parameters of type IView
GameControl(IView view) + +
+          Constructor
RoundControl(IGameState gameState, + IView view) + +
+          Create a new RoundControl using the given gameState and view
TurnControl(IHand hand, + ITable table, + IView view) + +
+          Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction.
TurnControl(IHand hand, + ITable table, + IView view, + ITurnTimer testTimer) + +
+          Test only constructor
TurnTimer(IView view) + +
+          Create a new timer using a given view to display the current time left
+  +

+ + + + + +
+Uses of IView in jrummikub.view.impl
+  +

+ + + + + + + + + +
Classes in jrummikub.view.impl that implement IView
+ classView + +
+          Implementation of the top-level view interface
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/AbstractStonePanel.html b/doc/jrummikub/view/impl/AbstractStonePanel.html new file mode 100644 index 0000000..ba29bdf --- /dev/null +++ b/doc/jrummikub/view/impl/AbstractStonePanel.html @@ -0,0 +1,707 @@ + + + + + + +AbstractStonePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class AbstractStonePanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by jrummikub.view.impl.AbstractStonePanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, IClickable, IStonePanel
+
+
+
Direct Known Subclasses:
HandPanel, StoneCollectionPanel, TablePanel
+
+
+
+
abstract class AbstractStonePanel
extends javax.swing.JPanel
implements IStonePanel, IClickable
+ + +

+Base class for panels that draw stones +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+ + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+ + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + + + + +
+Constructor Summary
AbstractStonePanel() + +
+          Create a new StonePanel with default scale factor
AbstractStonePanel(float scale) + +
+          Create a new StonePanel with a given scale factor
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  voidclickAt(java.awt.Point p, + int clickCount, + boolean shift, + boolean control, + boolean alt) + +
+          clickAt is called when a click has occurred
+ Event1<Position>getClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+protected  StonegetHoveredStone() + +
+          Returns the stone the mouse pointer is hovering over
+ Event2<Stone,java.lang.Boolean>getRangeClickEvent() + +
+          the range click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a range instead of a single stone
+ Event2<Stone,java.lang.Boolean>getSetClickEvent() + +
+          the set click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a whole set instead of a single stone
+ Event2<Stone,java.lang.Boolean>getStoneClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+protected  StonePaintergetStonePainter() + +
+           
+protected  java.lang.Iterable<Pair<Stone,Position>>getStones() + +
+          Returns the list of stones and positions currently set
+protected  Pair<java.lang.Integer,java.lang.Integer>getTranslation() + +
+          Returns the translation in pixels the stones in this panel are painted with
+protected  booleanhandleOtherClickEvent(Position pos) + +
+          Overwrite this method to signal if special zone was clicked
+protected  voidhandleOtherMoveEvent(Position pos) + +
+          Overwrite this method to signal if special zone was hovered
+protected  voidsetStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Sets the list of stones that can be clicked on
+ + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
+ + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+ + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
+ + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AbstractStonePanel

+
+public AbstractStonePanel()
+
+
Create a new StonePanel with default scale factor +

+

+
+ +

+AbstractStonePanel

+
+public AbstractStonePanel(float scale)
+
+
Create a new StonePanel with a given scale factor +

+

+
Parameters:
scale - the grid scale
+
+ + + + + + + + +
+Method Detail
+ +

+getStonePainter

+
+protected StonePainter getStonePainter()
+
+
+
+
+
+ +
Returns:
the stone painter
+
+
+
+ +

+clickAt

+
+protected void clickAt(java.awt.Point p,
+                       int clickCount,
+                       boolean shift,
+                       boolean control,
+                       boolean alt)
+
+
clickAt is called when a click has occurred +

+

+
+
+
+
Parameters:
p - the point in component coordinates
clickCount - the click count
shift - is shift down?
control - is control down?
alt - is alt down?
+
+
+
+ +

+getHoveredStone

+
+protected Stone getHoveredStone()
+
+
Returns the stone the mouse pointer is hovering over +

+

+
+
+
+ +
Returns:
the hovered stone
+
+
+
+ +

+handleOtherClickEvent

+
+protected boolean handleOtherClickEvent(Position pos)
+
+
Overwrite this method to signal if special zone was clicked +

+

+
+
+
+
Parameters:
pos - the clicked position +
Returns:
special zone clicked
+
+
+
+ +

+handleOtherMoveEvent

+
+protected void handleOtherMoveEvent(Position pos)
+
+
Overwrite this method to signal if special zone was hovered +

+

+
+
+
+
Parameters:
pos - the hovered position
+
+
+
+ +

+setStones

+
+protected void setStones(java.lang.Iterable<Pair<Stone,Position>> stones)
+
+
Sets the list of stones that can be clicked on +

+

+
+
+
+
Parameters:
stones - the stones and positions
+
+
+
+ +

+getTranslation

+
+protected Pair<java.lang.Integer,java.lang.Integer> getTranslation()
+
+
Returns the translation in pixels the stones in this panel are painted with +

+

+
+
+
+ +
Returns:
the translation
+
+
+
+ +

+getStones

+
+protected java.lang.Iterable<Pair<Stone,Position>> getStones()
+
+
Returns the list of stones and positions currently set +

+

+
+
+
+ +
Returns:
the stones
+
+
+
+ +

+getClickEvent

+
+public Event1<Position> getClickEvent()
+
+
Description copied from interface: IClickable
+
the click event is emitted when the player clicks on the table/hand/etc. +

+

+
Specified by:
getClickEvent in interface IClickable
+
+
+ +
Returns:
the event; the first parameter is the position of the click in grid + coordinates, the second is true when the player wants to add stones + to his selection instead of replacing them
+
+
+
+ +

+getStoneClickEvent

+
+public Event2<Stone,java.lang.Boolean> getStoneClickEvent()
+
+
Description copied from interface: IStonePanel
+
the click event is emitted when the player clicks on the table/hand/etc. +

+

+
Specified by:
getStoneClickEvent in interface IStonePanel
+
+
+ +
Returns:
the event; the first parameter is the position of the click in grid + coordinates, the second is true when the player wants to add stones + to his selection instead of replacing them
+
+
+
+ +

+getRangeClickEvent

+
+public Event2<Stone,java.lang.Boolean> getRangeClickEvent()
+
+
Description copied from interface: IStonePanel
+
the range click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a range instead of a single stone +

+

+
Specified by:
getRangeClickEvent in interface IStonePanel
+
+
+ +
Returns:
the event; the first parameter is the position of the click in grid + coordinates, the second is true when the player wants to add stones + to his selection instead of replacing them
+
+
+
+ +

+getSetClickEvent

+
+public Event2<Stone,java.lang.Boolean> getSetClickEvent()
+
+
Description copied from interface: IStonePanel
+
the set click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a whole set instead of a single stone +

+

+
Specified by:
getSetClickEvent in interface IStonePanel
+
+
+ +
Returns:
the event; the first parameter is the position of the click in grid + coordinates, the second is true when the player wants to add stones + to his selection instead of replacing them
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/HandPanel.html b/doc/jrummikub/view/impl/HandPanel.html new file mode 100644 index 0000000..9fc0c2f --- /dev/null +++ b/doc/jrummikub/view/impl/HandPanel.html @@ -0,0 +1,516 @@ + + + + + + +HandPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class HandPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by jrummikub.view.impl.AbstractStonePanel
+                      extended by jrummikub.view.impl.HandPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, IClickable, IHandPanel, IStonePanel
+
+
+
+
 class HandPanel
extends AbstractStonePanel
implements IHandPanel
+ + +

+Implementation of the board +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+ + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+ + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
HandPanel() + +
+          Creates a new Board instance
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  voidpaintComponent(java.awt.Graphics g1) + +
+           
+ voidsetHandHeight(int height) + +
+          Set the number of stones that fit on the hand vertically
+ voidsetHandWidth(int width) + +
+          Set the number of stones that fit on the hand horizontally
+(package private)  voidsetSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the stones that are to be painted selected
+ voidsetStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Sets the list of stones that can be clicked on
+ + + + + + + +
Methods inherited from class jrummikub.view.impl.AbstractStonePanel
clickAt, getClickEvent, getHoveredStone, getRangeClickEvent, getSetClickEvent, getStoneClickEvent, getStonePainter, getStones, getTranslation, handleOtherClickEvent, handleOtherMoveEvent
+ + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
+ + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+ + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
+ + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface jrummikub.view.IStonePanel
getRangeClickEvent, getSetClickEvent, getStoneClickEvent
+ + + + + + + +
Methods inherited from interface jrummikub.view.IClickable
getClickEvent
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HandPanel

+
+HandPanel()
+
+
Creates a new Board instance +

+

+ + + + + + + + +
+Method Detail
+ +

+setHandWidth

+
+public void setHandWidth(int width)
+
+
Description copied from interface: IHandPanel
+
Set the number of stones that fit on the hand horizontally +

+

+
Specified by:
setHandWidth in interface IHandPanel
+
+
+
Parameters:
width - number of stones
+
+
+
+ +

+setHandHeight

+
+public void setHandHeight(int height)
+
+
Description copied from interface: IHandPanel
+
Set the number of stones that fit on the hand vertically +

+

+
Specified by:
setHandHeight in interface IHandPanel
+
+
+
Parameters:
height - number of stones
+
+
+
+ +

+paintComponent

+
+protected void paintComponent(java.awt.Graphics g1)
+
+
+
Overrides:
paintComponent in class javax.swing.JComponent
+
+
+
+
+
+
+ +

+setStones

+
+public void setStones(java.lang.Iterable<Pair<Stone,Position>> stones)
+
+
Description copied from class: AbstractStonePanel
+
Sets the list of stones that can be clicked on +

+

+
Specified by:
setStones in interface IHandPanel
Overrides:
setStones in class AbstractStonePanel
+
+
+
Parameters:
stones - the stones and positions
+
+
+
+ +

+setSelectedStones

+
+void setSelectedStones(java.util.Collection<Stone> stones)
+
+
Sets the stones that are to be painted selected +

+

+
+
+
+
Parameters:
stones - the selected stones
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/PlayerPanel.html b/doc/jrummikub/view/impl/PlayerPanel.html new file mode 100644 index 0000000..ee9ab4e --- /dev/null +++ b/doc/jrummikub/view/impl/PlayerPanel.html @@ -0,0 +1,521 @@ + + + + + + +PlayerPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class PlayerPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by jrummikub.view.impl.PlayerPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, IPlayerPanel
+
+
+
+
 class PlayerPanel
extends javax.swing.JPanel
implements IPlayerPanel
+ + +

+Implementation of the player panel +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+ + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+ + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
PlayerPanel() + +
+          Creates a new PlayerPanel instance
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IEventgetEndTurnEvent() + +
+          The end turn event is emitted when the player wants to end his turn
+ HandPanelgetHandPanel() + +
+           
+ IEventgetSortByGroupsEvent() + +
+          The sort by groups event is emitted when the player wants to sort his + stones by groups
+ IEventgetSortByRunsEvent() + +
+          The sort by runs event is emitted when the player wants to sort his stones + by runs
+(package private)  voidsetCurrentPlayerName(java.lang.String playerName) + +
+          Sets the current player name
+ voidsetTimeLeft(int time) + +
+          Sets the time the player has left for his turn
+ + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
+ + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+ + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
+ + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+PlayerPanel

+
+PlayerPanel()
+
+
Creates a new PlayerPanel instance +

+

+ + + + + + + + +
+Method Detail
+ +

+getHandPanel

+
+public HandPanel getHandPanel()
+
+
+
Specified by:
getHandPanel in interface IPlayerPanel
+
+
+ +
Returns:
the board where the players hand stones are displayed
+
+
+
+ +

+setCurrentPlayerName

+
+void setCurrentPlayerName(java.lang.String playerName)
+
+
Sets the current player name +

+

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

+setTimeLeft

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

+

+
Specified by:
setTimeLeft in interface IPlayerPanel
+
+
+
Parameters:
time - the time left
+
+
+
+ +

+getSortByGroupsEvent

+
+public IEvent getSortByGroupsEvent()
+
+
Description copied from interface: IPlayerPanel
+
The sort by groups event is emitted when the player wants to sort his + stones by groups +

+

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

+getSortByRunsEvent

+
+public IEvent getSortByRunsEvent()
+
+
Description copied from interface: IPlayerPanel
+
The sort by runs event is emitted when the player wants to sort his stones + by runs +

+

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

+getEndTurnEvent

+
+public IEvent getEndTurnEvent()
+
+
Description copied from interface: IPlayerPanel
+
The end turn event is emitted when the player wants to end his turn +

+

+
Specified by:
getEndTurnEvent in interface IPlayerPanel
+
+
+ +
Returns:
the event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/StartTurnPanel.html b/doc/jrummikub/view/impl/StartTurnPanel.html new file mode 100644 index 0000000..1de5d67 --- /dev/null +++ b/doc/jrummikub/view/impl/StartTurnPanel.html @@ -0,0 +1,412 @@ + + + + + + +StartTurnPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class StartTurnPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by jrummikub.view.impl.StartTurnPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
 class StartTurnPanel
extends javax.swing.JPanel
+ + +

+A panel that is displayed before a player's turn +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+ + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+ + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
StartTurnPanel() + +
+          Creates a new StartTurnPanel
+  + + + + + + + + + + + + + + + +
+Method Summary
+(package private)  IEventgetStartTurnEvent() + +
+          The start turn event is emitted when the current player has clicked the + start turn button
+(package private)  voidsetCurrentPlayerName(java.lang.String playerName) + +
+          Sets the current player name
+ + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
+ + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+ + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
+ + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StartTurnPanel

+
+StartTurnPanel()
+
+
Creates a new StartTurnPanel +

+

+ + + + + + + + +
+Method Detail
+ +

+setCurrentPlayerName

+
+void setCurrentPlayerName(java.lang.String playerName)
+
+
Sets the current player name +

+

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

+getStartTurnEvent

+
+IEvent getStartTurnEvent()
+
+
The start turn event is emitted when the current player has clicked the + start turn button +

+

+ +
Returns:
the event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/StoneCollectionPanel.html b/doc/jrummikub/view/impl/StoneCollectionPanel.html new file mode 100644 index 0000000..cb2d49e --- /dev/null +++ b/doc/jrummikub/view/impl/StoneCollectionPanel.html @@ -0,0 +1,513 @@ + + + + + + +StoneCollectionPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class StoneCollectionPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by jrummikub.view.impl.AbstractStonePanel
+                      extended by jrummikub.view.impl.StoneCollectionPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, IClickable, IStoneCollectionPanel, IStonePanel
+
+
+
+
 class StoneCollectionPanel
extends AbstractStonePanel
implements IStoneCollectionPanel
+ + +

+Implementation of the stone collection (selection) +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+ + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+ + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
StoneCollectionPanel() + +
+          Creates a new StoneCollection instance
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+(package private)  IEvent1<java.awt.Point>getOtherClickEvent() + +
+          The other click event is emitted by the stone collection when the player + has clicked on it, but hasn't hit a stone.
+protected  Pair<java.lang.Integer,java.lang.Integer>getTranslation() + +
+          Returns the translation in pixels the stones in this panel are painted with
+protected  booleanhandleOtherClickEvent(Position pos) + +
+          Overwrite this method to signal if special zone was clicked
+ voidpaintComponent(java.awt.Graphics g1) + +
+           
+(package private)  voidsetSelectedStones(java.util.Collection<Stone> selectedStones) + +
+          Sets the stones to be shown in the collection
+ + + + + + + +
Methods inherited from class jrummikub.view.impl.AbstractStonePanel
clickAt, getClickEvent, getHoveredStone, getRangeClickEvent, getSetClickEvent, getStoneClickEvent, getStonePainter, getStones, handleOtherMoveEvent, setStones
+ + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
+ + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+ + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
+ + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface jrummikub.view.IStonePanel
getRangeClickEvent, getSetClickEvent, getStoneClickEvent
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+StoneCollectionPanel

+
+StoneCollectionPanel()
+
+
Creates a new StoneCollection instance +

+

+ + + + + + + + +
+Method Detail
+ +

+setSelectedStones

+
+void setSelectedStones(java.util.Collection<Stone> selectedStones)
+
+
Sets the stones to be shown in the collection +

+

+
+
+
+
Parameters:
selectedStones - the selected stones
+
+
+
+ +

+getTranslation

+
+protected Pair<java.lang.Integer,java.lang.Integer> getTranslation()
+
+
Description copied from class: AbstractStonePanel
+
Returns the translation in pixels the stones in this panel are painted with +

+

+
Overrides:
getTranslation in class AbstractStonePanel
+
+
+ +
Returns:
the translation
+
+
+
+ +

+getOtherClickEvent

+
+IEvent1<java.awt.Point> getOtherClickEvent()
+
+
The other click event is emitted by the stone collection when the player + has clicked on it, but hasn't hit a stone. This is rather probable as the + stone collection panel is filling the whole table width while being mostly + invisible. +

+

+
+
+
+ +
Returns:
the event
+
+
+
+ +

+handleOtherClickEvent

+
+protected boolean handleOtherClickEvent(Position pos)
+
+
Description copied from class: AbstractStonePanel
+
Overwrite this method to signal if special zone was clicked +

+

+
Overrides:
handleOtherClickEvent in class AbstractStonePanel
+
+
+
Parameters:
pos - the clicked position +
Returns:
special zone clicked
+
+
+
+ +

+paintComponent

+
+public void paintComponent(java.awt.Graphics g1)
+
+
+
Overrides:
paintComponent in class javax.swing.JComponent
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/StonePainter.html b/doc/jrummikub/view/impl/StonePainter.html new file mode 100644 index 0000000..36669ce --- /dev/null +++ b/doc/jrummikub/view/impl/StonePainter.html @@ -0,0 +1,410 @@ + + + + + + +StonePainter + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class StonePainter

+
+java.lang.Object
+  extended by jrummikub.view.impl.StonePainter
+
+
+
+
 class StonePainter
extends java.lang.Object
+ + +

+The StonePainter paints stones and converts between pixel and grid + coordinates +

+ +

+


+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+static floatHEIGHT_SCALE + +
+          The height of one pixel in the scale of 1.0
+static floatWIDTH_SCALE + +
+          The width of one pixel in the scale of 1.0
+  + + + + + + + + + + +
+Constructor Summary
StonePainter(float scale) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PositioncalculatePosition(int x, + int y) + +
+           
+ intgetStoneHeight() + +
+           
+ intgetStoneWidth() + +
+           
+ voidpaintStone(java.awt.Graphics2D g, + Stone stone, + Position p, + boolean selected, + boolean hovered) + +
+          Paints a stone
+ voidsetScale(float scale) + +
+          Sets the new grid scale
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+WIDTH_SCALE

+
+public static final float WIDTH_SCALE
+
+
The width of one pixel in the scale of 1.0 +

+

+
See Also:
Constant Field Values
+
+
+ +

+HEIGHT_SCALE

+
+public static final float HEIGHT_SCALE
+
+
The height of one pixel in the scale of 1.0 +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+StonePainter

+
+StonePainter(float scale)
+
+
+
Parameters:
scale - the scaling factor for the grid coordinates
+
+ + + + + + + + +
+Method Detail
+ +

+setScale

+
+public void setScale(float scale)
+
+
Sets the new grid scale +

+

+
Parameters:
scale - the new scale
+
+
+
+ +

+calculatePosition

+
+public Position calculatePosition(int x,
+                                  int y)
+
+
+
Parameters:
x - x position in screen coordinates
y - y position in screen coordinates +
Returns:
position in grid coordinates
+
+
+
+ +

+getStoneWidth

+
+public int getStoneWidth()
+
+
+ +
Returns:
the width of a stone in the current scale in pixels
+
+
+
+ +

+getStoneHeight

+
+public int getStoneHeight()
+
+
+ +
Returns:
the height of a stone in the current scale in pixels
+
+
+
+ +

+paintStone

+
+public void paintStone(java.awt.Graphics2D g,
+                       Stone stone,
+                       Position p,
+                       boolean selected,
+                       boolean hovered)
+
+
Paints a stone +

+

+
Parameters:
g - the graphics context to paint the stone on
stone - the stone to paint
p - the position of the stone
selected - if selected is true the stone will be painted darker
hovered - if hovered is true the stone will be painted brighter
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/TablePanel.html b/doc/jrummikub/view/impl/TablePanel.html new file mode 100644 index 0000000..f4eaa8a --- /dev/null +++ b/doc/jrummikub/view/impl/TablePanel.html @@ -0,0 +1,702 @@ + + + + + + +TablePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class TablePanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by jrummikub.view.impl.AbstractStonePanel
+                      extended by jrummikub.view.impl.TablePanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, IClickable, IStonePanel, ITablePanel
+
+
+
+
 class TablePanel
extends AbstractStonePanel
implements ITablePanel
+ + +

+The implementation of the table +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+ + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+ + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
TablePanel() + +
+          Creates a new Table instance
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Event1<StoneSet>getLeftConnectorClickEvent() + +
+          the left connector click event is emitted when the player clicks on a left + connector of a stone set on the table .
+ Event1<StoneSet>getRightConnectorClickEvent() + +
+          the right connector click event is emitted when the player clicks on a + right connector of a stone set on the table .
+ IStoneCollectionPanelgetStoneCollectionPanel() + +
+          Returns the stone collection (the panel showing the stones currently + selected)
+protected  Pair<java.lang.Integer,java.lang.Integer>getTranslation() + +
+          Returns the translation in pixels the stones in this panel are painted with
+protected  booleanhandleOtherClickEvent(Position pos) + +
+          Overwrite this method to signal if special zone was clicked
+protected  voidhandleOtherMoveEvent(Position pos) + +
+          Overwrite this method to signal if special zone was hovered
+protected  voidpaintComponent(java.awt.Graphics g1) + +
+           
+ voidsetLeftPlayerName(java.lang.String playerName) + +
+          Sets the player name on the left label
+ voidsetRightPlayerName(java.lang.String playerName) + +
+          Sets the player name on the right label
+(package private)  voidsetSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the currently selected stones
+ voidsetStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+          Sets the stone sets lying on the table
+ voidsetTopPlayerName(java.lang.String playerName) + +
+          Sets the player name on the top label
+ + + + + + + +
Methods inherited from class jrummikub.view.impl.AbstractStonePanel
clickAt, getClickEvent, getHoveredStone, getRangeClickEvent, getSetClickEvent, getStoneClickEvent, getStonePainter, getStones, setStones
+ + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
+ + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+ + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
+ + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface jrummikub.view.IStonePanel
getRangeClickEvent, getSetClickEvent, getStoneClickEvent
+ + + + + + + +
Methods inherited from interface jrummikub.view.IClickable
getClickEvent
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TablePanel

+
+TablePanel()
+
+
Creates a new Table instance +

+

+ + + + + + + + +
+Method Detail
+ +

+setLeftPlayerName

+
+public void setLeftPlayerName(java.lang.String playerName)
+
+
Description copied from interface: ITablePanel
+
Sets the player name on the left label +

+

+
Specified by:
setLeftPlayerName in interface ITablePanel
+
+
+
Parameters:
playerName - the name to set
+
+
+
+ +

+setTopPlayerName

+
+public void setTopPlayerName(java.lang.String playerName)
+
+
Description copied from interface: ITablePanel
+
Sets the player name on the top label +

+

+
Specified by:
setTopPlayerName in interface ITablePanel
+
+
+
Parameters:
playerName - the name to set
+
+
+
+ +

+setRightPlayerName

+
+public void setRightPlayerName(java.lang.String playerName)
+
+
Description copied from interface: ITablePanel
+
Sets the player name on the right label +

+

+
Specified by:
setRightPlayerName in interface ITablePanel
+
+
+
Parameters:
playerName - the name to set
+
+
+
+ +

+getLeftConnectorClickEvent

+
+public Event1<StoneSet> getLeftConnectorClickEvent()
+
+
Description copied from interface: ITablePanel
+
the left connector click event is emitted when the player clicks on a left + connector of a stone set on the table . +

+

+
Specified by:
getLeftConnectorClickEvent in interface ITablePanel
+
+
+ +
Returns:
the event
+
+
+
+ +

+getRightConnectorClickEvent

+
+public Event1<StoneSet> getRightConnectorClickEvent()
+
+
Description copied from interface: ITablePanel
+
the right connector click event is emitted when the player clicks on a + right connector of a stone set on the table . +

+

+
Specified by:
getRightConnectorClickEvent in interface ITablePanel
+
+
+ +
Returns:
the event
+
+
+
+ +

+setStoneSets

+
+public void setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets)
+
+
Description copied from interface: ITablePanel
+
Sets the stone sets lying on the table +

+

+
Specified by:
setStoneSets in interface ITablePanel
+
+
+
Parameters:
stoneSets - set stone sets on the table
+
+
+
+ +

+getStoneCollectionPanel

+
+public IStoneCollectionPanel getStoneCollectionPanel()
+
+
Description copied from interface: ITablePanel
+
Returns the stone collection (the panel showing the stones currently + selected) +

+

+
Specified by:
getStoneCollectionPanel in interface ITablePanel
+
+
+ +
Returns:
the stone collection
+
+
+
+ +

+setSelectedStones

+
+void setSelectedStones(java.util.Collection<Stone> stones)
+
+
Sets the currently selected stones +

+

+
+
+
+
Parameters:
stones - the selected stones
+
+
+
+ +

+handleOtherClickEvent

+
+protected boolean handleOtherClickEvent(Position pos)
+
+
Description copied from class: AbstractStonePanel
+
Overwrite this method to signal if special zone was clicked +

+

+
Overrides:
handleOtherClickEvent in class AbstractStonePanel
+
+
+
Parameters:
pos - the clicked position +
Returns:
special zone clicked
+
+
+
+ +

+handleOtherMoveEvent

+
+protected void handleOtherMoveEvent(Position pos)
+
+
Description copied from class: AbstractStonePanel
+
Overwrite this method to signal if special zone was hovered +

+

+
Overrides:
handleOtherMoveEvent in class AbstractStonePanel
+
+
+
Parameters:
pos - the hovered position
+
+
+
+ +

+getTranslation

+
+protected Pair<java.lang.Integer,java.lang.Integer> getTranslation()
+
+
Description copied from class: AbstractStonePanel
+
Returns the translation in pixels the stones in this panel are painted with +

+

+
Overrides:
getTranslation in class AbstractStonePanel
+
+
+ +
Returns:
the translation
+
+
+
+ +

+paintComponent

+
+protected void paintComponent(java.awt.Graphics g1)
+
+
+
Overrides:
paintComponent in class javax.swing.JComponent
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/View.html b/doc/jrummikub/view/impl/View.html new file mode 100644 index 0000000..7d0e5f8 --- /dev/null +++ b/doc/jrummikub/view/impl/View.html @@ -0,0 +1,646 @@ + + + + + + +View + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class View

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Window
+              extended by java.awt.Frame
+                  extended by javax.swing.JFrame
+                      extended by jrummikub.view.impl.View
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, IView
+
+
+
+
public class View
extends javax.swing.JFrame
implements IView
+ + +

+Implementation of the top-level view interface +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
+ + + + + + + +
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
+ + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+ + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
+ + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
View() + +
+          Create a new instance of the view
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidenableStartTurnPanel(boolean enable) + +
+          Enables or disables the player's StartTurnPanel
+ voidenableWinPanel(boolean enable) + +
+          Enables or disables the panel shown when a player has won
+ IEventgetNewGameEvent() + +
+          The new game event is emitted when the player wants to start a new game
+ IPlayerPanelgetPlayerPanel() + +
+          Returns the player panel
+ IEventgetQuitEvent() + +
+          The quit event is emitted when the player wants to quit the game
+ IEventgetStartTurnEvent() + +
+          The start turn event is emitted when the player wants to start his turn
+ ITablePanelgetTablePanel() + +
+          Returns the table
+ voidsetCurrentPlayerName(java.lang.String playerName) + +
+          Sets the current player's name
+ voidsetSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the stones that are to be painted selected
+ + + + + + + +
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, update
+ + + + + + + +
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
+ + + + + + + +
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
+ + + + + + + +
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
+ + + + + + + +
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
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+ + + + + + + +
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+View

+
+public View()
+
+
Create a new instance of the view +

+

+ + + + + + + + +
+Method Detail
+ +

+getTablePanel

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

+

+
Specified by:
getTablePanel in interface IView
+
+
+ +
Returns:
the table
+
+
+
+ +

+getPlayerPanel

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

+

+
Specified by:
getPlayerPanel in interface IView
+
+
+ +
Returns:
the playerPanel
+
+
+
+ +

+setSelectedStones

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

+

+
Specified by:
setSelectedStones in interface IView
+
+
+
Parameters:
stones - the stones to be painted selected
+
+
+
+ +

+enableStartTurnPanel

+
+public void enableStartTurnPanel(boolean enable)
+
+
Description copied from interface: IView
+
Enables or disables the player's StartTurnPanel +

+

+
Specified by:
enableStartTurnPanel in interface IView
+
+
+
Parameters:
enable - enable/disable
+
+
+
+ +

+enableWinPanel

+
+public void enableWinPanel(boolean enable)
+
+
Description copied from interface: IView
+
Enables or disables the panel shown when a player has won +

+

+
Specified by:
enableWinPanel in interface IView
+
+
+
Parameters:
enable - enable/disable
+
+
+
+ +

+setCurrentPlayerName

+
+public void setCurrentPlayerName(java.lang.String playerName)
+
+
Description copied from interface: IView
+
Sets the current player's name +

+

+
Specified by:
setCurrentPlayerName in interface IView
+
+
+
Parameters:
playerName - the player name
+
+
+
+ +

+getStartTurnEvent

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

+

+
Specified by:
getStartTurnEvent in interface IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getNewGameEvent

+
+public IEvent getNewGameEvent()
+
+
Description copied from interface: IView
+
The new game event is emitted when the player wants to start a new game +

+

+
Specified by:
getNewGameEvent in interface IView
+
+
+ +
Returns:
the event
+
+
+
+ +

+getQuitEvent

+
+public IEvent getQuitEvent()
+
+
Description copied from interface: IView
+
The quit event is emitted when the player wants to quit the game +

+

+
Specified by:
getQuitEvent in interface IView
+
+
+ +
Returns:
the event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/WinPanel.html b/doc/jrummikub/view/impl/WinPanel.html new file mode 100644 index 0000000..cc701d8 --- /dev/null +++ b/doc/jrummikub/view/impl/WinPanel.html @@ -0,0 +1,432 @@ + + + + + + +WinPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.view.impl +
+Class WinPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by jrummikub.view.impl.WinPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
 class WinPanel
extends javax.swing.JPanel
+ + +

+A panel that is displayed when a player has won +

+ +

+


+ +

+ + + + + + + +
+Nested Class Summary
+ + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
+  + + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
+  + + + + + + + +
+Field Summary
+ + + + + + + +
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+ + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+ + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
WinPanel() + +
+          Creates a new WinPanel
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+(package private)  IEventgetNewGameEvent() + +
+          The new game event is emitted when the player wants to start a new game
+(package private)  IEventgetQuitEvent() + +
+          The quit event is emitted when the player wants to quit the program
+(package private)  voidsetCurrentPlayerName(java.lang.String name) + +
+          Sets the name of the current player
+ + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
+ + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+ + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
+ + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WinPanel

+
+WinPanel()
+
+
Creates a new WinPanel +

+

+ + + + + + + + +
+Method Detail
+ +

+setCurrentPlayerName

+
+void setCurrentPlayerName(java.lang.String name)
+
+
Sets the name of the current player +

+

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

+getNewGameEvent

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

+

+ +
Returns:
the event
+
+
+
+ +

+getQuitEvent

+
+IEvent getQuitEvent()
+
+
The quit event is emitted when the player wants to quit the program +

+

+ +
Returns:
the event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/AbstractStonePanel.html b/doc/jrummikub/view/impl/class-use/AbstractStonePanel.html new file mode 100644 index 0000000..bd33100 --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/AbstractStonePanel.html @@ -0,0 +1,196 @@ + + + + + + +Uses of Class jrummikub.view.impl.AbstractStonePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.AbstractStonePanel

+
+ + + + + + + + + +
+Packages that use AbstractStonePanel
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of AbstractStonePanel in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + + + + + +
Subclasses of AbstractStonePanel in jrummikub.view.impl
+(package private)  classHandPanel + +
+          Implementation of the board
+(package private)  classStoneCollectionPanel + +
+          Implementation of the stone collection (selection)
+(package private)  classTablePanel + +
+          The implementation of the table
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/HandPanel.html b/doc/jrummikub/view/impl/class-use/HandPanel.html new file mode 100644 index 0000000..4ad35e3 --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/HandPanel.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class jrummikub.view.impl.HandPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.HandPanel

+
+ + + + + + + + + +
+Packages that use HandPanel
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of HandPanel in jrummikub.view.impl
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return HandPanel
+ HandPanelPlayerPanel.getHandPanel() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/PlayerPanel.html b/doc/jrummikub/view/impl/class-use/PlayerPanel.html new file mode 100644 index 0000000..795ee8a --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/PlayerPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.view.impl.PlayerPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.PlayerPanel

+
+No usage of jrummikub.view.impl.PlayerPanel +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/StartTurnPanel.html b/doc/jrummikub/view/impl/class-use/StartTurnPanel.html new file mode 100644 index 0000000..22c81a1 --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/StartTurnPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.view.impl.StartTurnPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.StartTurnPanel

+
+No usage of jrummikub.view.impl.StartTurnPanel +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/StoneCollectionPanel.html b/doc/jrummikub/view/impl/class-use/StoneCollectionPanel.html new file mode 100644 index 0000000..16c17ca --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/StoneCollectionPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.view.impl.StoneCollectionPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.StoneCollectionPanel

+
+No usage of jrummikub.view.impl.StoneCollectionPanel +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/StonePainter.html b/doc/jrummikub/view/impl/class-use/StonePainter.html new file mode 100644 index 0000000..51ed4ae --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/StonePainter.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class jrummikub.view.impl.StonePainter + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.StonePainter

+
+ + + + + + + + + +
+Packages that use StonePainter
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of StonePainter in jrummikub.view.impl
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return StonePainter
+protected  StonePainterAbstractStonePanel.getStonePainter() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/TablePanel.html b/doc/jrummikub/view/impl/class-use/TablePanel.html new file mode 100644 index 0000000..f9d57be --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/TablePanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.view.impl.TablePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.TablePanel

+
+No usage of jrummikub.view.impl.TablePanel +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/View.html b/doc/jrummikub/view/impl/class-use/View.html new file mode 100644 index 0000000..e12e048 --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/View.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.view.impl.View + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.View

+
+No usage of jrummikub.view.impl.View +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/class-use/WinPanel.html b/doc/jrummikub/view/impl/class-use/WinPanel.html new file mode 100644 index 0000000..ee28a3a --- /dev/null +++ b/doc/jrummikub/view/impl/class-use/WinPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.view.impl.WinPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.view.impl.WinPanel

+
+No usage of jrummikub.view.impl.WinPanel +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/package-frame.html b/doc/jrummikub/view/impl/package-frame.html new file mode 100644 index 0000000..4f17fb6 --- /dev/null +++ b/doc/jrummikub/view/impl/package-frame.html @@ -0,0 +1,48 @@ + + + + + + +jrummikub.view.impl + + + + + + + + + + + +jrummikub.view.impl + + + + +
+Classes  + +
+AbstractStonePanel +
+HandPanel +
+PlayerPanel +
+StartTurnPanel +
+StoneCollectionPanel +
+StonePainter +
+TablePanel +
+View +
+WinPanel
+ + + + diff --git a/doc/jrummikub/view/impl/package-summary.html b/doc/jrummikub/view/impl/package-summary.html new file mode 100644 index 0000000..5908ea3 --- /dev/null +++ b/doc/jrummikub/view/impl/package-summary.html @@ -0,0 +1,190 @@ + + + + + + +jrummikub.view.impl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package jrummikub.view.impl +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
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
ViewImplementation of the top-level view interface
WinPanelA panel that is displayed when a player has won
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/package-tree.html b/doc/jrummikub/view/impl/package-tree.html new file mode 100644 index 0000000..94b6db8 --- /dev/null +++ b/doc/jrummikub/view/impl/package-tree.html @@ -0,0 +1,181 @@ + + + + + + +jrummikub.view.impl Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package jrummikub.view.impl +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/impl/package-use.html b/doc/jrummikub/view/impl/package-use.html new file mode 100644 index 0000000..2c2e4f0 --- /dev/null +++ b/doc/jrummikub/view/impl/package-use.html @@ -0,0 +1,183 @@ + + + + + + +Uses of Package jrummikub.view.impl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
jrummikub.view.impl

+
+ + + + + + + + + +
+Packages that use jrummikub.view.impl
jrummikub.view.impl  
+  +

+ + + + + + + + + + + + + + +
+Classes in jrummikub.view.impl used by jrummikub.view.impl
AbstractStonePanel + +
+          Base class for panels that draw stones
HandPanel + +
+          Implementation of the board
StonePainter + +
+          The StonePainter paints stones and converts between pixel and grid + coordinates
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/package-frame.html b/doc/jrummikub/view/package-frame.html new file mode 100644 index 0000000..96e1317 --- /dev/null +++ b/doc/jrummikub/view/package-frame.html @@ -0,0 +1,44 @@ + + + + + + +jrummikub.view + + + + + + + + + + + +jrummikub.view + + + + +
+Interfaces  + +
+IClickable +
+IHandPanel +
+IPlayerPanel +
+IStoneCollectionPanel +
+IStonePanel +
+ITablePanel +
+IView
+ + + + diff --git a/doc/jrummikub/view/package-summary.html b/doc/jrummikub/view/package-summary.html new file mode 100644 index 0000000..a8909f7 --- /dev/null +++ b/doc/jrummikub/view/package-summary.html @@ -0,0 +1,181 @@ + + + + + + +jrummikub.view + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package jrummikub.view +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
IClickableAn interface for view elements that can emit click events
IHandPanelThe view for a player's hand that displays his stones
IPlayerPanelThe player panel that contains a player's board and other user interfaces
IStoneCollectionPanelThe view of the collection that shows the stones a player has selected
IStonePanelAn interface for view elements that can emit click events for clicks on stones
ITablePanelThe view of the table, where the stone sets lie
IViewThe top-level view interface
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/package-tree.html b/doc/jrummikub/view/package-tree.html new file mode 100644 index 0000000..23ea0e2 --- /dev/null +++ b/doc/jrummikub/view/package-tree.html @@ -0,0 +1,159 @@ + + + + + + +jrummikub.view Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package jrummikub.view +

+
+
+
Package Hierarchies:
All Packages
+
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/view/package-use.html b/doc/jrummikub/view/package-use.html new file mode 100644 index 0000000..59bae37 --- /dev/null +++ b/doc/jrummikub/view/package-use.html @@ -0,0 +1,274 @@ + + + + + + +Uses of Package jrummikub.view + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
jrummikub.view

+
+ + + + + + + + + + + + + + + + + +
+Packages that use jrummikub.view
jrummikub.control  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + + + + +
+Classes in jrummikub.view used by jrummikub.control
IView + +
+          The top-level view interface
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.view used by jrummikub.view
IClickable + +
+          An interface for view elements that can emit click events
IHandPanel + +
+          The view for a player's hand that displays his stones
IPlayerPanel + +
+          The player panel that contains a player's board and other user interfaces
IStoneCollectionPanel + +
+          The view of the collection that shows the stones a player has selected
IStonePanel + +
+          An interface for view elements that can emit click events for clicks on stones
ITablePanel + +
+          The view of the table, where the stone sets lie
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.view used by jrummikub.view.impl
IClickable + +
+          An interface for view elements that can emit click events
IHandPanel + +
+          The view for a player's hand that displays his stones
IPlayerPanel + +
+          The player panel that contains a player's board and other user interfaces
IStoneCollectionPanel + +
+          The view of the collection that shows the stones a player has selected
IStonePanel + +
+          An interface for view elements that can emit click events for clicks on stones
ITablePanel + +
+          The view of the table, where the stone sets lie
IView + +
+          The top-level view interface
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/overview-frame.html b/doc/overview-frame.html new file mode 100644 index 0000000..189791f --- /dev/null +++ b/doc/overview-frame.html @@ -0,0 +1,52 @@ + + + + + + +Overview List + + + + + + + + + + + + + + + +
+
+ + + + + +
All Classes +

+ +Packages +
+jrummikub +
+jrummikub.control +
+jrummikub.model +
+jrummikub.util +
+jrummikub.view +
+jrummikub.view.impl +
+

+ +

+  + + diff --git a/doc/overview-summary.html b/doc/overview-summary.html new file mode 100644 index 0000000..2ec3c31 --- /dev/null +++ b/doc/overview-summary.html @@ -0,0 +1,171 @@ + + + + + + +Overview + + + + + + + + + + + + +


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages
jrummikub 
jrummikub.control 
jrummikub.model 
jrummikub.util 
jrummikub.view 
jrummikub.view.impl 
+ +


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/overview-tree.html b/doc/overview-tree.html new file mode 100644 index 0000000..26307f5 --- /dev/null +++ b/doc/overview-tree.html @@ -0,0 +1,227 @@ + + + + + + +Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
jrummikub, jrummikub.control, jrummikub.model, jrummikub.util, jrummikub.view, jrummikub.view.impl
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/package-list b/doc/package-list new file mode 100644 index 0000000..eeca318 --- /dev/null +++ b/doc/package-list @@ -0,0 +1,6 @@ +jrummikub +jrummikub.control +jrummikub.model +jrummikub.util +jrummikub.view +jrummikub.view.impl diff --git a/doc/resources/inherit.gif b/doc/resources/inherit.gif new file mode 100644 index 0000000..c814867 Binary files /dev/null and b/doc/resources/inherit.gif differ diff --git a/doc/serialized-form.html b/doc/serialized-form.html new file mode 100644 index 0000000..5f87f65 --- /dev/null +++ b/doc/serialized-form.html @@ -0,0 +1,206 @@ + + + + + + +Serialized Form + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package jrummikub.view.impl
+ +

+ + + + + +
+Class jrummikub.view.impl.View extends javax.swing.JFrame implements Serializable
+ +

+ + + + + +
+Serialized Fields
+ +

+table

+
+TablePanel table
+
+
+
+
+
+

+playerPanel

+
+PlayerPanel playerPanel
+
+
+
+
+
+

+startTurnPanel

+
+StartTurnPanel startTurnPanel
+
+
+
+
+
+

+winPanel

+
+WinPanel winPanel
+
+
+
+
+ +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/stylesheet.css b/doc/stylesheet.css new file mode 100644 index 0000000..6ea9e51 --- /dev/null +++ b/doc/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + -- cgit v1.2.3