diff options
Diffstat (limited to 'src/jrummikub/view/ISettingsPanel.java')
-rw-r--r-- | src/jrummikub/view/ISettingsPanel.java | 92 |
1 files changed, 91 insertions, 1 deletions
diff --git a/src/jrummikub/view/ISettingsPanel.java b/src/jrummikub/view/ISettingsPanel.java index 17830e5..e2d5eff 100644 --- a/src/jrummikub/view/ISettingsPanel.java +++ b/src/jrummikub/view/ISettingsPanel.java @@ -11,14 +11,65 @@ import jrummikub.util.IEvent2; * The panel for the game setup */ public interface ISettingsPanel { + /** + * The list of player colors + */ + public final static Color[] PLAYER_COLORS = { new Color(1.0f, 0, 0), // red + new Color(0, 1.0f, 0), // lime + new Color(1.0f, 1.0f, 0), // yellow + new Color(0, 0, 1.0f), // blue + new Color(1.0f, 0, 1.0f), // fuchsia + new Color(0, 1.0f, 1.0f), // aqua + new Color(0.5f, 0, 0), // maroon + new Color(0, 0.5f, 0), // green + new Color(0.5f, 0.5f, 0), // olive + new Color(0, 0, 0.5f), // navy + new Color(0.5f, 0, 0.5f), // purple + new Color(0, 0.5f, 0.5f), // teal + new Color(0, 0, 0), // black + new Color(0.5f, 0.5f, 0.5f), // gray + new Color(0.75f, 0.75f, 0.75f), // silver + new Color(1.0f, 1.0f, 1.0f), // white + }; + + /** + * The add player event is emitted when the user wants to add a player to the + * player list + * + * @return the event + */ public IEvent getAddPlayerEvent(); + /** + * The remove player event is emitted when the user wants to remove a player + * remove the player list + * + * @return the event + */ public IEvent1<Integer> getRemovePlayerEvent(); + /** + * The change player color event is emitted when the user wants change a + * player's color + * + * @return the event + */ public IEvent2<Integer, Color> getChangePlayerColorEvent(); + /** + * The change player color event is emitted when the user wants change a + * player's name + * + * @return the event + */ public IEvent2<Integer, String> getChangePlayerNameEvent(); + /** + * The change initial meld threshold event is emitted when the user wants + * change the initial meld threshold + * + * @return the event + */ public IEvent1<Integer> getChangeInitialMeldThresholdEvent(); /** @@ -28,17 +79,56 @@ public interface ISettingsPanel { */ public IEvent getStartGameEvent(); + /** + * Sets an error to display + * + * @param error + * the kind of error + */ public void setError(SettingsError error); + /** + * Enables or disables the start game button + * + * @param enable + * specifies if the button is to be enabled or disabled + */ public void enableStartGameButton(boolean enable); + /** + * Enables or disables the add player button + * + * @param enable + * specifies if the button is to be enabled or disabled + */ public void enableAddPlayerButton(boolean enable); + /** + * Enables or disables the remove player buttons + * + * @param enable + * specifies if the buttons are to be enabled or disabled + */ + public void enableRemovePlayerButtons(boolean enable); + /** + * Sets the game settings to display + * + * @param gameSettings + * the settings + */ public void setGameSettings(GameSettings gameSettings); + /** + * Specifies the different kinds of settings errors that can be displayed + */ public enum SettingsError { - NO_ERROR, DUPLICATE_PLAYER_NAME, NO_PLAYER_NAME + /** Everything is ok */ + NO_ERROR, + /** A player name is used twice */ + DUPLICATE_PLAYER_NAME, + /** A player has an empty name */ + NO_PLAYER_NAME } }
\ No newline at end of file |