com.iisc.jwc.jsheet
Class BookEvent

java.lang.Object
  java.util.EventObject
      com.iisc.jwc.jsheet.BookEvent

All Implemented Interfaces:

java.io.Serializable

public class BookEvent

extends java.util.EventObject

implements java.io.Serializable

The BookEvent contains information about the events in a book.

See Also:

Serialized Form

Field Summary

static int	ACTIVE_SHEET_CHANGED Active sheet changed event type.
static int	BOOK_CLOSED Book closed event type.
static int	BOOK_SAVED Book saved event type.
static int	CLIENT_JOINED Client joined book event type.
static int	CLIENT_LEFT Client left book event type.
static int	SHEET_INSERTED Sheet inserted event type.
static int	SHEET_MOVED Sheet moved event type.
static int	SHEET_NAME_CHANGED Sheet name changed event type.
static int	SHEET_REMOVED Sheet removed event type.

Constructor Summary

BookEvent(java.lang.Object source, int id)
Constructs a BookEvent.

BookEvent(java.lang.Object source, int id, short sheetIdx)
Constructs a BookEvent.

BookEvent(java.lang.Object source, int id, short from, short to, short nameID)
Constructs a BookEvent.

BookEvent(java.lang.Object source, int id, java.lang.String name)
Constructs a BookEvent.

BookEvent(java.lang.Object source, int id, java.lang.String name, short sheetIdx)
Constructs a BookEvent.

BookEvent(java.lang.Object source, int id, java.lang.String name, short sheetIdx, short nameID)
Constructs a BookEvent.

Method Summary

short	getFrom() Returns the index from where the sheet was moved.
int	getID() Returns the ID for this object.
java.lang.String	getName() Returns the name of the sheet.
short	getNameID() Returns the name ID of this sheet.
short	getSheetIndex() Returns the sheet index of the book.
short	getTo() Returns the index from where the sheet was moved.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ACTIVE_SHEET_CHANGED

public static final int ACTIVE_SHEET_CHANGED

Active sheet changed event type.

See Also:

Constant Field Values

BOOK_CLOSED

public static final int BOOK_CLOSED

Book closed event type.

See Also:

Constant Field Values

BOOK_SAVED

public static final int BOOK_SAVED

Book saved event type.

See Also:

Constant Field Values

CLIENT_JOINED

public static final int CLIENT_JOINED

Client joined book event type.

See Also:

Constant Field Values

CLIENT_LEFT

public static final int CLIENT_LEFT

Client left book event type.

See Also:

Constant Field Values

SHEET_INSERTED

public static final int SHEET_INSERTED

Sheet inserted event type.

See Also:

Constant Field Values

SHEET_MOVED

public static final int SHEET_MOVED

Sheet moved event type.

See Also:

Constant Field Values

SHEET_NAME_CHANGED

public static final int SHEET_NAME_CHANGED

Sheet name changed event type.

See Also:

Constant Field Values

SHEET_REMOVED

public static final int SHEET_REMOVED

Sheet removed event type.

See Also:

Constant Field Values

Constructor Detail

BookEvent

public BookEvent(java.lang.Object source,
                 int id)

Constructs a BookEvent.

Parameters:

source - the object where the event originated.

id - the event type.

BookEvent

public BookEvent(java.lang.Object source,
                 int id,
                 short sheetIdx)

Constructs a BookEvent.

Parameters:

source - the object where the event originated.

id - the event type.

sheetIdx - the sheet index.

BookEvent

public BookEvent(java.lang.Object source,
                 int id,
                 short from,
                 short to,
                 short nameID)

Constructs a BookEvent.

Parameters:

source - the object where the event originated.

id - the event type.

from - index where the sheet was moved from.

to - index where the sheet was moved to.

nameID - unique id for the sheet.

BookEvent

public BookEvent(java.lang.Object source,
                 int id,
                 java.lang.String name)

Constructs a BookEvent.

Parameters:

source - the object where the event originated.

id - the event type.

name - the name of the sheet.

BookEvent

public BookEvent(java.lang.Object source,
                 int id,
                 java.lang.String name,
                 short sheetIdx)

Constructs a BookEvent.

Parameters:

source - the object where the event originated.

id - the event type.

sheetIdx - the sheet index.

name - the name of the sheet.

BookEvent

public BookEvent(java.lang.Object source,
                 int id,
                 java.lang.String name,
                 short sheetIdx,
                 short nameID)

Constructs a BookEvent.

Parameters:

source - the object where the event originated.

id - the event type.

sheetIdx - the sheet index.

nameID - unique id for the sheet.

Method Detail

getFrom

public short getFrom()

Returns the index from where the sheet was moved.

Returns:

the index from where the sheet was moved.

getID

public int getID()

Returns the ID for this object.

Returns:

the ID for this object.

getName

public java.lang.String getName()

Returns the name of the sheet.

Returns:

the name of the sheet.

getNameID

public short getNameID()

Returns the name ID of this sheet.

Returns:

the name ID of this sheet.

getSheetIndex

public short getSheetIndex()

Returns the sheet index of the book.

Returns:

the sheet index of the book.

getTo

public short getTo()

Returns the index from where the sheet was moved.

Returns:

the index from where the sheet was moved.

toString

public java.lang.String toString()

Returns a string representation of this object.

Returns:

a string representation of this object.