borland Packages Class Hierarchy dx.dataset Package
java.lang.Object +----java.util.EventObject +----com.borland.jb.util.DispatchableEvent +----com.borland.dx.dataset.AccessEvent
Variables Constructors Properties Methods
Implements Serializable
The AccessEvent
is the internal event generated when a DataSet
is opened,
closed, or restructured. The AccessEvent
class may be useful for component writers; see the com.borland.dbswing source code for usage examples. Not for general usage.
The AccessListener
class
responds to the AccessEvent
class.
public static final int CLOSE = 2Event type. Returned from
getID().
public static final int COLUMN_ADD = 3Reason for an OPEN event. Structural change where a
Column
was
added to the DataSet
.
public static final int COLUMN_CHANGE = 5Reason for an OPEN event. Structural change where a
Column
was
changed in the DataSet
.
public static final int COLUMN_DROP = 4Reason for an OPEN event. Structural change where a
Column
was
dropped from the DataSet
.
public static final int COLUMN_MOVE = 6Reason for an OPEN event. Structural change where a
Column
was
moved in the DataSet
.
public static final int DATA_CHANGE = 2Reason for an OPEN event. Indicates that data has changed, but no structural changes were made. This is used when a
DataSet's
sort
property is
changed or a DataSet.empty()
is called. It is also used when DataSet.enableDataSetEvents(true)
is called.
public static final int OPEN = 1Event type. Returned from
getID().
public static final int PROPERTY_CHANGE = 9Will get pertinent information when a following OPEN event occurs. Reason for CLOSE event. This is called when a non-structural property change like Column Font or Color is changed. Also used when
DataSet.enableDataSetEvents(false)
is called. Note that this event will not be sent to a DataSetView
that is listening to
its associated StorageDataSet
. In practice, this event only makes
its way to visual components that listen to Access events.
public static final int STRUCTURE_CHANGE = 8Reason for CLOSE event. Indicates that
DataSet
was closed and it is expected
to be reopened in a short time period. Usually called to perform a sort order
change or structural property change.
public static final int UNKNOWN = 7Reason for a CLOSE event. Indicates that
DataSet
was closed and it is not
known whether it will be opened again. Calling DataSet.close()
will cause this event.
public static final int UNSPECIFIED = 1Reason for an OPEN event. Unknown
DataSet.open()
will cause this. Returned from getReason()
.
public AccessEvent(Object source, AccessEvent event)Creates an internal event from the given source for the specified event.
source
event
DataSet
.
public AccessEvent(Object source, int id)Creates an internal event from the given source with the specified event type.
source
id
public AccessEvent(Object source, int id, int reason)Creates an internal event from the given source with the specified event type and reason.
source
id
reason
public AccessEvent(Object source, int id, int reason, Column dropColumn)Creates an internal event from the given source with the specified event type and reason. The internal event drops the specified column.
source
id
reason
dropColumn
public AccessEvent(Object source, int id, int reason, Column oldColumn, Column newColumn)Creates an internal event from the given source with the specified event type and reason. The internal event restructures the table.
source
id
reason
oldColumn
newColumn
oldColumn
with.
public AccessEvent(Object source, int id, int reason, int oldOrdinal, int newOrdinal)Creates an internal event from the given source with the specified event type and reason. The internal event restructures the table.
source
id
reason
oldOrdinal
newOrdinal
oldOrdinal
with.
public Column getDropColumn()Read-only property that returns information about which
Column
was dropped
from a COLUMN_DROP
operation.
public final int getID()The event type. Valid return values for this method are defined as variables in this class.
public Column getNewColumn()Read-only property that returns information on a new
Column
from a
COLUMN_CHANGE
operation.
public int getNewOrdinal()Read-only property that returns the new ordinal position when a
Column
is moved.
public Column getOldColumn()Read-only property that returns the old
Column
from a COLUMN_CHANGE
operation.
public int getOldOrdinal()Read-only property that returns the previous ordinal position when a
Column
is moved.
public final int getReason()Read-only property that returns the reason for the event. Valid values are defined in the variables section of this class.
public void dispatch(EventListener listener)This method is used internally by other
com.borland
classes. You should never use this method directly.