com.portal.bas

Class PCollectDataEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

com.portal.bas.PCollectDataEvent

All Implemented Interfaces:

Serializable

public class PCollectDataEvent
extends AWTEvent

PCollectDataEvent sends a marshal data event to collect changed data from various controls. This data can then be used, for example, to commit changes and perform a search.

Version:

7

Author:

Larry Lynch-Freshner

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	FOR_DIRTY Collects data from fields that have the "dirty" attribute set.
static int	FOR_OTHER Collects data for a purpose that doesn't fit into another category.
static int	FOR_SEARCHING Collects data for searches.
static int	FOR_STORING Collects data specifically for storage.
static int	FOR_UNKNOWN Collects data for an unspecified reason.
static int	FOR_VALIDATION Collects data specifically for validation.

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PCollectDataEvent(Object src, int why, boolean forceCollectAll, PModelHandle model) Constructs an instance of PCollectDataEvent given the source, and a model to collect data.
PCollectDataEvent(Object src, int why, PModelHandle model) Constructs an instance of PCollectDataEvent given the source, a reason to collect the data, and a model in which to collect data.

Method Summary

Modifier and Type	Method and Description
boolean	forceResponse() Forces a response from a control.
Object	getInvalidComponent() Checks for an invalid component and, if found, retrieves it.
PModelHandle	getModel() Gets the model in which to collect the changed data.
int	getReason() Gets the reason code for data collection.
void	setInvalidComponent(Object src) Called when the component this event was sent to has invalid data.

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, paramString, setSource, toString

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

FOR_UNKNOWN

public static final int FOR_UNKNOWN

Collects data for an unspecified reason.

See Also:

Constant Field Values

FOR_SEARCHING

public static final int FOR_SEARCHING

Collects data for searches.

See Also:

Constant Field Values

FOR_STORING

public static final int FOR_STORING

Collects data specifically for storage.

See Also:

Constant Field Values

FOR_VALIDATION

public static final int FOR_VALIDATION

Collects data specifically for validation.

See Also:

Constant Field Values

FOR_OTHER

public static final int FOR_OTHER

Collects data for a purpose that doesn't fit into another category.

See Also:

Constant Field Values

FOR_DIRTY

public static final int FOR_DIRTY

Collects data from fields that have the "dirty" attribute set.

See Also:

Constant Field Values

Constructor Detail

PCollectDataEvent

public PCollectDataEvent(Object src,
                         int why,
                         PModelHandle model)

Constructs an instance of PCollectDataEvent given the source, a reason to collect the data, and a model in which to collect data.

Parameters:

src - the event sender

why - the reason for data collection

model - the model to collect data

PCollectDataEvent

public PCollectDataEvent(Object src,
                         int why,
                         boolean forceCollectAll,
                         PModelHandle model)

Constructs an instance of PCollectDataEvent given the source, and a model to collect data.

Parameters:

src - the event sender

why - the reason for data collection

forceCollectAll - true if all controls should respond with their data, even if they have no data, or have not changed

model - the model to collect data

Method Detail

getModel

public PModelHandle getModel()

Gets the model in which to collect the changed data.

Returns:

The model used to collect changed data.

getReason

public int getReason()

Gets the reason code for data collection.

Returns:

The collection reason code.

setInvalidComponent

public void setInvalidComponent(Object src)

Called when the component this event was sent to has invalid data. The caller should stop data collection and handle the error.

Parameters:

src - the component that has the invalid data

getInvalidComponent

public Object getInvalidComponent()

Checks for an invalid component and, if found, retrieves it. Returns null if data collection was valid.

Returns:

An invalid source component, or null.

forceResponse

public boolean forceResponse()

Forces a response from a control. Many controls ignore this event if no change has been made or they contain no data. If this property is true, the controls should always respond to this event.

Returns:

True if a control should always respond with its data; false otherwise.