JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.table
Class JCSelectEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.klg.jclass.table.JCSelectEvent
All Implemented Interfaces:
Serializable

public class JCSelectEvent
extends EventObject

The event posted as a user selects cells or cells are selected programmatically.

See Also:
Serialized Form

Field Summary
protected  int action
           
static int ADD
           
static int AFTER_SELECTION
           
static int BEFORE_SELECTION
           
protected  boolean cancelled
           
static int DESELECT
           
static int END
           
protected  int end_column
           
protected  int end_row
           
static int EXTEND
           
static int SELECT
           
static int SELECTION
           
protected  int start_column
           
protected  int start_row
           
protected  int type
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
JCSelectEvent(Object source, int type, int start_row, int start_column, int end_row, int end_column, int action)
           
 
Method Summary
 int getAction()
          Returns the type of action where valid values are: SELECT, ADD, EXTEND, DESELECT, and END.
 String getActionString()
          Returns a String representation of the action.
 int getEndColumn()
          Returns the end column of the selected or deselected cell range.
 int getEndRow()
          Returns the end row of the selected or deselected cell range.
 int getStartColumn()
          Returns the start column of the selected or deselected cell range.
 int getStartRow()
          Returns the start row of the selected or deselected cell range.
 int getType()
          Returns the type of event.
 boolean isCancelled()
          Returns true if any listener has rejected the selection.
 void setCancelled(boolean value)
          Sets whether the selection (or unselection) should be cancelled.
 String toString()
          Returns a String representation of the event.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BEFORE_SELECTION

public static final int BEFORE_SELECTION
See Also:
Constant Field Values

SELECTION

public static final int SELECTION
See Also:
Constant Field Values

AFTER_SELECTION

public static final int AFTER_SELECTION
See Also:
Constant Field Values

SELECT

public static final int SELECT
See Also:
Constant Field Values

EXTEND

public static final int EXTEND
See Also:
Constant Field Values

ADD

public static final int ADD
See Also:
Constant Field Values

END

public static final int END
See Also:
Constant Field Values

DESELECT

public static final int DESELECT
See Also:
Constant Field Values

type

protected int type

start_row

protected int start_row

start_column

protected int start_column

end_row

protected int end_row

end_column

protected int end_column

action

protected int action

cancelled

protected boolean cancelled
Constructor Detail

JCSelectEvent

public JCSelectEvent(Object source,
                     int type,
                     int start_row,
                     int start_column,
                     int end_row,
                     int end_column,
                     int action)
Method Detail

getType

public int getType()
Returns the type of event. Valid types are EVENT_BEGIN or EVENT_END.

Returns:
type of event; one of EVENT_BEGIN or EVENT_END

getStartRow

public int getStartRow()
Returns the start row of the selected or deselected cell range.

Returns:
start row of the selected or deselected cell range

getStartColumn

public int getStartColumn()
Returns the start column of the selected or deselected cell range.

Returns:
start column of the selected or deselected cell range

getEndRow

public int getEndRow()
Returns the end row of the selected or deselected cell range.

Returns:
end row of the selected or deselected cell range

getEndColumn

public int getEndColumn()
Returns the end column of the selected or deselected cell range.

Returns:
end column of the selected or deselected cell range

isCancelled

public boolean isCancelled()
Returns true if any listener has rejected the selection.

Returns:
true if any listener has rejected the selection

setCancelled

public void setCancelled(boolean value)
Sets whether the selection (or unselection) should be cancelled. Default is false.

Parameters:
value -

getAction

public int getAction()
Returns the type of action where valid values are: SELECT, ADD, EXTEND, DESELECT, and END.

Returns:
type of action; one of SELECT, ADD, EXTEND, DESELECT, or END

getActionString

public String getActionString()
Returns a String representation of the action.

Returns:
String representation of the action

toString

public String toString()
Returns a String representation of the event.

Overrides:
toString in class EventObject
Returns:
String representation of the event

Copyright © 2004 Quest Software Inc..
All rights reserved.