com.portal.bas

Interface PLightComponent

All Known Implementing Classes:

PAcctTreeBeanImpl, PChangeStatusPage.PIAChangeStatusTextAreaField, PDefaultChoiceStringEnum, PDeviceComboBox, PIABigIntegerField, PIABinaryStringField, PIABooleanEnumField, PIABooleanEnumRadioField, PIACanonField, PIACanonFieldBeanImpl, PIAConstant, PIACurrencyField, PIADateField, PIADefaultChoiceEnumField, PIADigitsTextField, PIAEnumField, PIAFieldBean, PIAGroupTreeBeanImpl, PIAIntegerField, PIAList, PIAListBeanImpl, PIANumberField, PIAObjectField, PIAObjectFieldBeanImpl, PIAPasswordField, PIAPaymentField, PIAPaymentFieldBeanImpl, PIAPaymentOnFileField, PIAPaymentOnFileFieldBeanImpl, PIAPercentField, PIAReadOnlyField, PIASpinnerField, PIAStringEnum, PIATextAreaField, PIATextField, PLightComponentHelper, PMSExchangeOrgNameField, PNavigationButton

public interface PLightComponent

PLightComponent is an interface that defines lightweight component behavior. Lightweight components don't get their model set directly. Instead, they must be placed in a container that can handle them. The container's controller must update a lightweight component's controller, gathering its updated data in a caching model handle. The container's client then distributes the data to the lightweight component's client. This provides for more efficient data transfer when many small bits of data are needed, for example, field components.

Version:

%version: 3 % %date_modified: Thu Apr 12 15:10:13 2001 %

Author:

larrylf

Method Summary

Modifier and Type	Method and Description
String	getDataDescriptor() Returns a string guaranteed to be unique among the lightweight components that can be used to describe the data, and acts as a key for it.
Object	getLightData() Gets the lightweight data object itself.
void	setLightData(Object field) Sets the lightweight data object.

Method Detail

getDataDescriptor

String getDataDescriptor()

Returns a string guaranteed to be unique among the lightweight components that can be used to describe the data, and acts as a key for it. For field components, this can be the model description.

Returns:

A String data description.

getLightData

Object getLightData()

Gets the lightweight data object itself. Lightweight components are allowed only one data item. This is likely to be a duplicate of another method of the component, and can be delegated to it.

Returns:

An Object that represents a component's display data.

setLightData

void setLightData(Object field)

Sets the lightweight data object. This is usually called by framework support as part of the lightweight component implementation.

Parameters:

field - the lightweight component's display data