com.portal.bas.comp

Class PIAComponentCollection

java.lang.Object

com.portal.bas.comp.PIAComponentCollection

All Implemented Interfaces:

PAppComponent, PClientComponent, PCollectDataListener, PComponent, PViewDataChangeListener, Serializable, EventListener

public class PIAComponentCollection
extends Object
implements PAppComponent, PCollectDataListener, Serializable

PIAComponentCollection is a PAppComponent delegate that provides the View for Portal-aware GUI components.

Version:

%version: 11 % %date_modified: Tue Dec 18 19:37:13 2001 %

Author:

larrylf

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected PIACollectionBean	mColl
protected Map	mComponents
protected PCollectingModelHandle	mData
protected LinkedList	mHeavyList
protected LinkedList	mLightList
protected PClientServices	mServices

Constructor Summary

Constructors

Constructor and Description
PIAComponentCollection() The default constructor does not create the controller for this component collection.
PIAComponentCollection(String classname) Calls createController to construct the controller for this collection.

Method Summary

Modifier and Type	Method and Description
void	addChild(Object key, PLightComponentHelper c)
void	addChild(PClientComponent c)
void	addChild(PLightComponentHelper c)
protected void	addChildInt(PAppComponent c)
protected void	addChildInt(PViewComponent c)
void	collectData(PCollectDataEvent event) Overrides PCollectDataListener.
void	createController(String classname) Creates the controller for this collection.
PLightComponentHelper	getChild(Object key)
PCollectingModelHandle	getCollectedData()
PControllerBean	getController()
String	getControllerClassName() Retrieves the class name of this component's controller.
PModelHandle	getModelHandle() Retrieves the PModelHandle for this component.
Remote	getRemoteComponent() Gets a reference to the remote component for this object.
String	getResourceName() Returns the base resource name used to look up a resource.
PClientServices	getServices() If an application uses multiple services (WebKit) then this method retrieves the client service associated with this component else it will return the one instance of client service for applications that use one client service (Customer Center).
Vector	getTools() Gets the list of actions supported by this component.
boolean	isLight() Determines whether this is a lightweight component.
Iterator	iterator()
Iterator	keyIterator()
void	removeChild(PClientComponent c)
void	removeChild(PLightComponentHelper c)
protected void	removeChildInt(PAppComponent c)
protected void	removeChildInt(PViewComponent c)
void	revertToPrimary(int primary)
void	setModelHandle(PModelHandle data) Establishes the PModelHandle for this collection of components.
void	setResourceName(String name) Sets the base resource name used to look up resources.
void	setServices(PClientServices pCS) Sets the client service instance for this component for an application uses which uses multiple services (WebKit)
PModelHandle[]	startMultipleModelDataCollection(int why)
PModelHandle	startSingleModelDataCollection(int why, PModelHandle model)
Object	togglePrimaryToSecondary(int primary, int secondary) Walks the component hierarchy to toggle the currency for any component that displays currency data.
void	unregister() Causes the component's remote component (Controller) to be disassociated from the component);
void	viewDataChange(PViewDataChangeEvent evt) Overrides PViewDataChangeListener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mColl

protected transient PIACollectionBean mColl

mData

protected transient PCollectingModelHandle mData

mHeavyList

protected transient LinkedList mHeavyList

mLightList

protected transient LinkedList mLightList

mComponents

protected transient Map mComponents

mServices

protected transient PClientServices mServices

Constructor Detail

PIAComponentCollection

public PIAComponentCollection()

The default constructor does not create the controller for this component collection.

To create the controller, call createController( String classname ).

See Also:

createController(String classname), PIAComponentCollection(String classname)

PIAComponentCollection

public PIAComponentCollection(String classname)

Calls createController to construct the controller for this collection.

Parameters:

classname - the class name of the controller to be created

See Also:

createController( String classname )

Method Detail

unregister

public void unregister()
                throws RemoteException

Description copied from interface: PClientComponent

Causes the component's remote component (Controller) to be disassociated from the component);

Specified by:

unregister in interface PClientComponent

Throws:

RemoteException

setServices

public void setServices(PClientServices pCS)

Sets the client service instance for this component for an application uses which uses multiple services (WebKit)

Parameters:

service - the client services instance

createController

public void createController(String classname)

Creates the controller for this collection.

Parameters:

classname - the class name of the controller to be created. If it's null, getControllerClassName is used to instantiate the controller.

See Also:

getControllerClassName(), PIAComponentCollection(String classname)

setModelHandle

public void setModelHandle(PModelHandle data)
                    throws RemoteException

Establishes the PModelHandle for this collection of components.

Specified by:

setModelHandle in interface PComponent

Parameters:

data - the new PModelHandle from which to extract the information

Throws:

RemoteException - thrown for errors

getModelHandle

public PModelHandle getModelHandle()
                            throws RemoteException

Retrieves the PModelHandle for this component.

Specified by:

getModelHandle in interface PComponent

Returns:

The PModelHandle associated with this component.

Throws:

RemoteException - thrown for errors

isLight

public boolean isLight()
                throws RemoteException

Determines whether this is a lightweight component. Lightweight components do not have their own model. Instead, they use the model of their container. This means that getModelHandle always returns null, setModelHandle is ignored, and no property change events are generated.

Specified by:

isLight in interface PComponent

Returns:

False, by default.

Throws:

RemoteException - thrown for errors

getControllerClassName

public String getControllerClassName()
                              throws RemoteException

Retrieves the class name of this component's controller.

Specified by:

getControllerClassName in interface PComponent

Returns:

A String with the value "com.portal.bas.comp.PIAComponentCollectionBean".

Throws:

RemoteException - thrown for errors

getServices

public PClientServices getServices()
                            throws RemoteException

If an application uses multiple services (WebKit) then this method retrieves the client service associated with this component else it will return the one instance of client service for applications that use one client service (Customer Center).

Returns:

PClientService for this component

Throws:

RemoteException

getTools

public Vector getTools()

Gets the list of actions supported by this component. When subclassed, the overriding class should call its superclass method first, then add its actions to the returned list. This preserves the actions supplied by base classes. The default, supplied here, includes help for this component.

Specified by:

getTools in interface PClientComponent

Returns:

A Vector that contains Action objects

setResourceName

public void setResourceName(String name)

Sets the base resource name used to look up resources. The resource name consists of this base, followed by a dot, followed by the local name (label).

Specified by:

setResourceName in interface PClientComponent

Parameters:

name - the new base resource name

getResourceName

public String getResourceName()

Returns the base resource name used to look up a resource.

Specified by:

getResourceName in interface PClientComponent

Returns:

A String with the resource name.

getRemoteComponent

public Remote getRemoteComponent()

Gets a reference to the remote component for this object. The remote component is used to interface with this component's controller.

Specified by:

getRemoteComponent in interface PAppComponent

Returns:

A Remote component.

viewDataChange

public void viewDataChange(PViewDataChangeEvent evt)

Overrides PViewDataChangeListener. Called by the controller to update the field data. This event is passed along to all descendants.

Specified by:

viewDataChange in interface PViewDataChangeListener

Parameters:

event - the PViewDataChange event that describes the change

Throws:

RemoteException - thrown for errors

addChild

public void addChild(Object key,
                     PLightComponentHelper c)
              throws RemoteException

Throws:

RemoteException

getChild

public PLightComponentHelper getChild(Object key)

addChild

public void addChild(PLightComponentHelper c)
              throws RemoteException

Throws:

RemoteException

removeChild

public void removeChild(PLightComponentHelper c)
                 throws RemoteException

Throws:

RemoteException

addChild

public void addChild(PClientComponent c)
              throws RemoteException

Throws:

RemoteException

removeChild

public void removeChild(PClientComponent c)
                 throws RemoteException

Throws:

RemoteException

addChildInt

protected void addChildInt(PViewComponent c)
                    throws RemoteException

Throws:

RemoteException

addChildInt

protected void addChildInt(PAppComponent c)
                    throws RemoteException

Throws:

RemoteException

removeChildInt

protected void removeChildInt(PViewComponent c)
                       throws RemoteException

Throws:

RemoteException

removeChildInt

protected void removeChildInt(PAppComponent c)
                       throws RemoteException

Throws:

RemoteException

getCollectedData

public PCollectingModelHandle getCollectedData()

getController

public PControllerBean getController()

startSingleModelDataCollection

public PModelHandle startSingleModelDataCollection(int why,
                                                   PModelHandle model)
                                            throws RemoteException

Throws:

RemoteException

startMultipleModelDataCollection

public PModelHandle[] startMultipleModelDataCollection(int why)
                                                throws RemoteException

Throws:

RemoteException

collectData

public void collectData(PCollectDataEvent event)

Overrides PCollectDataListener. Forwarded to all contained GUI components that are also PCollectDataListeners.

Specified by:

collectData in interface PCollectDataListener

Parameters:

event - the PCollectDataEvent data event

togglePrimaryToSecondary

public Object togglePrimaryToSecondary(int primary,
                                       int secondary)
                                throws RemoteException

Walks the component hierarchy to toggle the currency for any component that displays currency data.

Parameters:

primary - the current currency ID used to display the data

secondary - the new currency ID to use to display the data

Throws:

RemoteException - thrown for errors

Since:

Release 6.2

revertToPrimary

public void revertToPrimary(int primary)
                     throws RemoteException

Throws:

RemoteException

keyIterator

public Iterator keyIterator()

iterator

public Iterator iterator()