A B C D E F G H I J K L M N O P Q R S T U V W Y

G

GameOverCommand - class ks.protocol.GameOverCommand.

Class to represent the ending of a table at a client.

GameOverCommand() - Constructor for class ks.protocol.GameOverCommand

Default Constructor for GameOverCommand.

GameResult - class ks.domain.GameResult.

Class to represent the result of a solitaire competition.

GameResult(String, int, Enumeration, Date) - Constructor for class ks.domain.GameResult

Game result consists of the type of game, number of players, plus stats results.

GameStat - class ks.domain.GameStat.

Statistic of the result of an individual's performance on a game.

GameStat(Status, boolean, boolean) - Constructor for class ks.domain.GameStat

GameStat constructor.

gameOver(Table, Status) - Method in interface ks.client.interfaces.ITableRequests

Contact the server with our latest status information.

generateGame(String) - Method in interface ks.client.interfaces.IGameCreator

Given a game Type, this generates a Solitaire object for it.

generateWindow(String, Table, Solitaire) - Method in interface ks.client.interfaces.IGameCreator

Generate the Game Window returned via interface of accessible methods.

get() - Method in class ks.common.model.Stack

Remove top card from the pile and return it to the callee (or return null if empty).

getAccessType() - Method in class ks.domain.Table

Get Access permissions for this table.

getAccessType() - Method in class ks.protocol.CreateCommand

Return access type of table.

getAction() - Method in class ks.common.message.ClientMessage

Get the action.

getAction() - Method in class ks.protocol.PlugInManagerCommand

Get the action.

getAction() - Method in class ks.protocol.TableManagerCommand

getAction() - Method in class ks.protocol.UserManagerCommand

Get the action.

getAction() - Method in class ks.protocol.UserManagerMessage

Get the action.

getActiveDraggingObject() - Method in class ks.common.view.Container

Returns the object being dragged.

getAgent() - Method in class ks.common.network.SimpleClientConnection

Return agent responsible for communication to server.

getAgent() - Method in class ks.common.network.SimpleServerConnection

getArg(String) - Method in class ks.common.ArgumentList

Return the value of the named argument.

getArg() - Method in class ks.common.ArgumentList

Return the value of the default single argument.

getArgMulti(String) - Method in class ks.common.ArgumentList

Return the values of the named Multi argument as an Iterator.

getArgMulti() - Method in class ks.common.ArgumentList

Return the values of the default Multi argument as an Iterator.

getBackgroundImage() - Method in class ks.common.view.Container

Return the background RectangleHierarchy representing the non-widget areas in container.

getBest() - Method in class ks.domain.Match

Return winner of table.

getBestScore() - Method in class ks.domain.Status

Returns best score of the current hand (current score plus best so far).

getBounds() - Method in class ks.common.view.RectangleHierarchy

Return bounds of this node.

getBounds() - Method in class ks.common.view.Widget

Return the bounds of the Widget as a newly instantiated rectangle.

getCardImage(int, int) - Method in class ks.common.view.CardImages

Extracts the card resource based upon the name.

getCardImage(Card) - Method in class ks.common.view.CardImages

Get the card image given a Card Object.

getCardImages() - Method in class ks.common.games.Solitaire

Return the specific card images to use when calculating the dimensions within the View.

getCardImages() - Method in class ks.common.view.Container

Return the card images associated with this container.

getCardImages() - Method in class ks.common.view.Widget

Return the Cards of this widget.

getCardReverse() - Method in class ks.common.view.CardImages

Get the reverse image for a card.

getCardViewForTopCard(MouseEvent) - Method in class ks.common.view.ColumnView

If the MouseEvent falls on the top card of this Column, remove the top card from the Model and return a CardView widget to manage the card as it is dragged on the screen.

getCardViewForTopCard(MouseEvent) - Method in class ks.common.view.PileView

If the MouseEvent falls on the top card of this Column, remove the top card from the Model and return a CardView widget to manage the card as it is dragged on the screen.

getCardViewForTopCard(MouseEvent) - Method in class ks.common.view.RowView

If the MouseEvent falls on the top card of this Column, remove the top card from the Model and return a CardView widget to manage the card as it is dragged on the screen.

getChatString() - Method in class ks.protocol.ChatCommand

Get string to be chatted

getChildren() - Method in class ks.common.view.RectangleHierarchy

Return all children of the given node in array (or null if there are no children).

getColor() - Method in class ks.common.view.IntegerView

Get the color used within this IntegerView

getColor() - Method in class ks.common.view.StringView

Get the color used within this StringView

getColumnView(MouseEvent) - Method in class ks.common.view.BuildablePileView

If the MouseEvent falls on a faceup card for this BuildablePileView, remove the Column and return a ColumnView widget to manage the Column as it is dragged on the screen.

getColumnView(MouseEvent) - Method in class ks.common.view.ColumnView

If the MouseEvent falls on a non-top card of this Column, construct a column of these cards and return a CardView widget to manage the column as it is dragged on the screen.

getContainer() - Method in class ks.common.games.Solitaire

Returns the Container of the game.

getContainer() - Method in class ks.common.view.Widget

Return the container for this Widget.

getCount() - Method in class ks.domain.Table

Return the player index to next be added (0 through numPlayers-1).

getCurrentScore() - Method in class ks.domain.Status

Returns score of the current hand (across multiple games).

getCurrentUser() - Method in class ks.common.view.Container

Return the current user for this container.

getDeck(Component, String) - Static method in class ks.common.view.CardImagesLoader

Return CardImages object for this deck (whether in cache or freshly loaded).

getDeck(Component, String, ICardImagesStatus) - Static method in class ks.common.view.CardImagesLoader

Return CardImages object for this deck (whether in cache or freshly loaded) using given ICardImageStatus observer.

getDeckType() - Method in class ks.common.games.Solitaire

Standard Configuration.getValue(deckTypeVariable) contains deck type.

getDirection() - Method in class ks.common.view.RowView

Gets the direction of the row (either LEFT or RIGHT)

getDragSource() - Method in class ks.common.view.Container

Gets the source widget from which a drag originated.

getDraggingAnchor() - Method in class ks.common.view.Container

Return the offset within the dragging Widget for where the mouse was initially clicked.

getElement(String) - Method in class ks.common.model.Model

Return Model Element with the given name from set.

getEntry(String, String) - Method in interface ks.client.interfaces.IGameManager

Get the entry for the given plugin name and directory.

getFont() - Method in class ks.common.view.IntegerView

Get the font used within this IntegerView

getFont() - Method in class ks.common.view.StringView

Get the font used within this StringView

getFontSize() - Method in class ks.common.view.IntegerView

Return size of font being used.

getFontSize() - Method in class ks.common.view.StringView

Return size of font being used.

getFromUser() - Method in class ks.common.message.Message

Return the user for this message.

getGameIncrement() - Method in class ks.domain.Table

Return the game increment for this table.

getGameIncrement() - Method in class ks.protocol.CreateCommand

Return Game Increment (of seed)

getGameInterface() - Method in class ks.common.view.Container

Expose entity to whom container speaks.

getGameLength() - Method in class ks.domain.Table

Return the gameLength for this table.

getGameLength() - Method in class ks.protocol.CreateCommand

Return length of game in seconds

getGameResult() - Method in class ks.domain.Match

Get GameResult (return null if not ready yet).

getGameStats() - Method in class ks.domain.GameResult

Return Enumeration of GameStat objects.

getGameTime() - Method in class ks.domain.GameResult

Returns the name of the game played.

getGameType() - Method in class ks.domain.GameResult

Returns the name of the game played.

getHeight() - Method in class ks.common.view.CardImages

Return the individual height (in pixels) of each card.

getHeight() - Method in class ks.common.view.Widget

Return the height of the widget.

getImage() - Method in class ks.common.view.Widget

Return the image of this Widget (used for drawing the Widget on screen).

getIncrement() - Method in class ks.common.games.Solitaire

Returns the increment to be used to generate the next deck for this game.

getJustification() - Method in class ks.common.view.RowView

Gets the justification of the row (either flush LEFT or flush RIGHT)

getKey(String, String) - Method in interface ks.server.interfaces.IServerPluginManager

Return the certificate key calculated for the given Plugin.

getLastDrag() - Method in class ks.common.view.Container

Returns the last Drag point, or null if no drag is in process.

getLastUpdateTime() - Method in class ks.domain.Match

Get time last Match was updated.

getListener() - Method in class ks.common.model.Element

Returns listener for the model.

getManifest(String) - Method in interface ks.common.interfaces.ILoader

Gets the Manifest for the Jar file associated with the given key.

getMessage() - Method in class ks.protocol.ShoutCommand

Return string concatenation of shout arguments.

getMessage() - Method in class ks.protocol.TellCommand

Return string concatenation of shout arguments.

getModelElement(String) - Method in class ks.common.games.Solitaire

Returns the Model Element maintained by this Solitaire Variation with desired name.

getModelElement() - Method in class ks.common.view.Widget

Return the Model Element associated with this Widget.

getModelElements() - Method in class ks.common.games.Solitaire

Returns all Model Element maintained by this Solitaire variation.

getModelElements() - Method in class ks.common.view.Container

Return the Model elements associated with the container's game as an Enumeration.

getModerator() - Method in class ks.domain.Table

Get moderator for the table.

getMouseManager() - Method in class ks.common.view.Widget

Return the MouseManager associated with this Widget.

getMoveType() - Method in class ks.common.model.Move

Return the move type.

getMoves() - Method in class ks.common.games.Solitaire

Return all moves made so far within this game.

getName() - Method in class ks.common.games.Solitaire

Every Solitaire variation must return its name.

getName() - Method in class ks.common.model.Card

Return a string reflective of this Card.

getName() - Method in class ks.common.model.Element

Returns the name of this model element.

getName() - Method in class ks.common.view.CardImages

Return Name for this deck class.

getName() - Method in class ks.common.view.Widget

Return the name of this widget.

getName() - Method in class ks.domain.Table

Return the name of this table.

getNewHands() - Method in class ks.domain.Status

Return number of times user requested a new hand.

getNothingBeingDragged() - Static method in class ks.common.view.Container

Returns a 'sentinel' object that represents the fact that nothing is being dragged.

getNumCardsLeft() - Method in class ks.domain.Status

Returns the number of cards left.

getNumFaceDown() - Method in class ks.common.model.BuildablePile

Return the number of cards in this BuildablePile that are face down.

getNumFaceUp() - Method in class ks.common.model.BuildablePile

Return the number of cards in this BuildablePile that are face up.

getNumHandsWon() - Method in class ks.protocol.GameOverCommand

Return number of hands won.

getNumLeft() - Method in class ks.common.games.Solitaire

Return the Element representing the number of cards left.

getNumLosses() - Method in class ks.domain.Status

Returns the number of times the player has lost on this table.

getNumPlayers() - Method in class ks.domain.GameResult

Return number of players.

getNumPlayers() - Method in class ks.domain.Table

Return the number of players on this table.

getNumPlayers() - Method in class ks.protocol.CreateCommand

Return number of players for game.

getNumResetHands() - Method in class ks.domain.Status

Returns the number of times the user has chosen to reset the deck.

getNumSelectedCards() - Method in class ks.common.model.Stack

Returns the number of Cards that are selected from the stack.

getNumUndoRequests() - Method in class ks.domain.Status

Returns number of times user requested an undo.

getNumWins() - Method in class ks.domain.Status

Returns number of times user has won during this table.

getOverallScore() - Method in class ks.protocol.GameOverCommand

Return overall score.

getOverlap() - Method in class ks.common.view.CardImages

Overlap is roughly 23% of the cardHeight.

getPassword() - Method in class ks.protocol.ProtocolCommand

getPreferredSize() - Method in class ks.common.games.Solitaire

Returns the preferred size needed for this solitaire game to function.

getProtocolVersion() - Method in class ks.protocol.ProtocolCommand

getQuery() - Method in class ks.common.command.HelpCommand

getRank() - Method in class ks.common.model.Card

Return the rank for this card.

getReason() - Method in class ks.common.command.ErrorCommand

Return reason for error.

getRowView(MouseEvent) - Method in class ks.common.view.RowView

If the MouseEvent falls within this row, return a Column of cards from the Model and return a RowView widget to manage these cards as they are dragged on the screen.

getScope() - Method in class ks.common.message.Message

Return the scope for this message.

getScope() - Method in class ks.protocol.OutputCommand

Get the scope.

getScore() - Method in class ks.common.games.Solitaire

Return the model Element representing the score for a solitaire game.

getScore() - Method in class ks.domain.GameStat

Returns User's score at end of game (int)

getScore() - Method in class ks.domain.Status

Returns score of table (in current hand).

getScoreValue() - Method in class ks.common.games.Solitaire

Return the score for a solitaire game as an int.

getSeed() - Method in class ks.common.games.Solitaire

Return the random seed used to shuffle the deck.

getSeed() - Method in class ks.domain.Table

Return the seed to be used for this table.

getSeed() - Method in class ks.protocol.CreateCommand

Return seed for game.

getSelected() - Method in class ks.common.model.Stack

Return Stack of the selected cards.

getStatus() - Method in class ks.common.view.Container

Return the current status of the game being played.

getSuit() - Method in class ks.common.model.Card

Return the suit for this card.

getSuitName(int) - Static method in class ks.common.model.Card

Static method for converting a specific suit identifier into its String representation.

getTable(String, String) - Method in interface ks.client.interfaces.IClientInterface2

Return GameWindow from our hashtable by name/type.

getTableName() - Method in interface ks.client.interfaces.IGameInterface

Knows info about table.

getTableName() - Method in class ks.protocol.ChatCommand

Get string to be chatted.

getTableName() - Method in class ks.protocol.CreateCommand

Return name of table.

getTableName() - Method in class ks.protocol.GameOverCommand

Return name of table.

getTableName() - Method in class ks.protocol.JoinCommand

Return name of table.

getTableName() - Method in class ks.protocol.LeaveTableCommand

Return name of table.

getTableName() - Method in class ks.protocol.RejoinCommand

Return name of table.

getTableType() - Method in interface ks.client.interfaces.IGameInterface

Knows info about table.

getTableType() - Method in class ks.protocol.ChatCommand

Get table type.

getTableType() - Method in class ks.protocol.CreateCommand

Return type of table.

getTableType() - Method in class ks.protocol.GameOverCommand

Return type of table.

getTableType() - Method in class ks.protocol.JoinCommand

Return type of table.

getTableType() - Method in class ks.protocol.LeaveTableCommand

Return type of table.

getTableType() - Method in class ks.protocol.RejoinCommand

Return type of table.

getTableType() - Method in class ks.protocol.TablesCommand

Return type of table.

getTableTypes() - Method in interface ks.server.interfaces.IReadonlyTableManager

Return Enumeration of all TableTypes (String objects) currently active in the system.

getTables(String) - Method in interface ks.server.interfaces.IReadonlyTableManager

Return Enumeration of all active TableNames (String objects) for the given game type.

getTargetUser() - Method in class ks.common.message.Message

Return the user to whom this message is intended.

getType() - Method in class ks.domain.Table

Return the solitaire type of this table.

getUndoAdapter() - Method in class ks.common.controller.MouseManager

Returns the Undo Adapter already in place.

getUser() - Method in class ks.common.message.Message

Return the user for this message.

getUser() - Method in class ks.domain.GameStat

Returns a username string for the user who this GameStat object is for

getUser() - Method in class ks.domain.Status

Returns the user associated with this Status.

getUser() - Method in class ks.protocol.FingerCommand

Return the target user for this Finger query.

getUser() - Method in class ks.protocol.GameOverCommand

Return user for whom stats are gathered.

getUser() - Method in class ks.protocol.LogoutCommand

Return the target user for this Logout

getUser() - Method in class ks.protocol.TellCommand

Return user

getUsers() - Method in class ks.protocol.BulkLoginMessage

Determine users within the message.

getValue() - Method in class ks.common.model.MutableInteger

Retrieve value.

getValue() - Method in class ks.common.model.MutableString

Retrieve value.

getVersion() - Method in class ks.common.games.Solitaire

Every Solitaire variation may support a version.

getVisitor() - Method in class ks.common.view.Container

Return visitor being used to draw background skin.

getWho() - Method in class ks.protocol.ProtocolCommand

getWidget(MouseEvent) - Method in class ks.common.view.Container

Return the widget (or null if none exist) that includes given mouse location.

getWidgets() - Method in class ks.common.games.Solitaire

Returns Enumeration of all Widgets maintained by this Solitaire variation.

getWidgets() - Method in class ks.common.view.Container

Return the View Widgets in the container as an Enumeration.

getWidth() - Method in class ks.common.view.CardImages

Return the width of each card.

getWidth() - Method in class ks.common.view.Widget

Return the width of the widget.

getX() - Method in class ks.common.view.Widget

Return the x coordinate for the Widget's location.

getXY() - Method in class ks.common.view.Widget

Return the (x,y) coordinates of top-left corner of Widget as a Point.

getY() - Method in class ks.common.view.Widget

Return the y coordinate for the Widget's location.

globalScope - Static variable in class ks.domain.Protocol

Possible Scope Values.