com.portal.bas

Class PFieldControllerBean

java.lang.Object

com.portal.bas.PControllerImpl

com.portal.bas.PFieldControllerBean

All Implemented Interfaces:

PControllerBean, PFieldBean, Serializable, Remote, Unreferenced

Direct Known Subclasses:

PIAFieldBean, PIASpecSpreadSheetBeanImpl, PIASpreadSheetBeanImpl

public abstract class PFieldControllerBean
extends PControllerImpl
implements PFieldBean

PFieldControllerBean is the default controller for field components. It extends the base component functionality in PControllerImpl by adding features that are specified in PFieldBean. As of Release 6.1, PFieldControllerBean replaces PFieldController.

Version:

%version: 7 % %date_modified: Mon Nov 05 11:18:42 2001 %

Author:

larrylf

See Also:

Serialized Form

Field Summary

Fields inherited from class com.portal.bas.PControllerImpl

mFList, mRemoteListeners, UPDATE_CLIENT, UPDATE_MODEL_CHANGE, UPDATE_NEW_MODEL, UPDATE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
PFieldControllerBean() Creates an instance of PFieldControllerBean.

Method Summary

Modifier and Type	Method and Description
String	getAssociatedClass() Gets the associated class, if any, for this field.
String	getDisplayFieldDescription() Gets the data field description used by the component.
protected PFieldSpecification	getDisplaySpec() Gets the field specification used to define the fields accessed by this control.
Object	getField() Gets the value of the field referred to in the displayFieldDescription
protected PDataFieldSpecification	getFieldSpec() Gets the field specification used to define the fields accessed by this control.
String	getModelFieldDescription() Gets the data field description used by the component.
void	releaseSpecifications()
void	revertToPrimary(int primary) Reverts converted currency data back to the primary representation
void	setAssociatedClass(String name) Sets the associated class, if any, for this field.
void	setDisplayFieldDescription(String fieldDisp) Sets the description of the field of the data model that is most important to this component.
void	setField(Object value) Sets the value of the field referred to in the modelFieldDescription.
void	setModelFieldDescription(String fieldDesc) Sets the description of the field of the data model that is most important to this component.
Object	togglePrimaryToSecondary(int prim, int sec) Causes the widget to use the BEIDManager to convert its data.

Methods inherited from class com.portal.bas.PControllerImpl

addRemoteListener, closeSecContext, createClientException, distributeEventToListeners, fireModelChangeEvent, getAppController, getArrayRange, getContext, getField, getField, getField, getFieldWithRestriction, getFieldWithRestriction, getFieldWithRestriction, getModel, getRemoteListenerHandle, getSecContext, handleDistributeToListener, isLight, register, releaseContext, releaseRemoteListener, removeRemoteListener, setField, setField, setModel, unreferenced, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.portal.bas.PControllerBean

getSelectionDataFor

Constructor Detail

PFieldControllerBean

public PFieldControllerBean()
                     throws RemoteException

Creates an instance of PFieldControllerBean.

Throws:

RemoteException - thrown for errors

Method Detail

setModelFieldDescription

public void setModelFieldDescription(String fieldDesc)
                              throws RemoteException

Sets the description of the field of the data model that is most important to this component.

Specified by:

setModelFieldDescription in interface PFieldBean

Parameters:

fieldDesc - a String that describes the field(s) used by this component

Throws:

RemoteException - thrown for errors

getModelFieldDescription

public String getModelFieldDescription()
                                throws RemoteException

Gets the data field description used by the component.

Specified by:

getModelFieldDescription in interface PFieldBean

Returns:

A String description of the fields used by this component.

Throws:

RemoteException - thrown for errors

setDisplayFieldDescription

public void setDisplayFieldDescription(String fieldDisp)
                                throws RemoteException

Sets the description of the field of the data model that is most important to this component.

Specified by:

setDisplayFieldDescription in interface PFieldBean

Parameters:

fieldDisp - a String description of the fields used by this component

Throws:

RemoteException - thrown for errors

getDisplayFieldDescription

public String getDisplayFieldDescription()
                                  throws RemoteException

Gets the data field description used by the component.

Specified by:

getDisplayFieldDescription in interface PFieldBean

Returns:

A String description of the fields used by this component.

Throws:

RemoteException - thrown for errors

releaseSpecifications

public void releaseSpecifications()
                           throws RemoteException

Throws:

RemoteException

setAssociatedClass

public void setAssociatedClass(String name)
                        throws RemoteException

Sets the associated class, if any, for this field.

Specified by:

setAssociatedClass in interface PFieldBean

Parameters:

name - the class name to associate with this field

Throws:

RemoteException - thrown for errors

getAssociatedClass

public String getAssociatedClass()
                          throws RemoteException

Gets the associated class, if any, for this field.

Specified by:

getAssociatedClass in interface PFieldBean

Returns:

The class name or null.

Throws:

RemoteException - thrown for errors

setField

public void setField(Object value)
              throws RemoteException

Sets the value of the field referred to in the modelFieldDescription.

Specified by:

setField in interface PFieldBean

Parameters:

value - the field's value

Throws:

RemoteException - thrown for errors

getField

public Object getField()
                throws RemoteException

Gets the value of the field referred to in the displayFieldDescription

Specified by:

getField in interface PFieldBean

Returns:

The field's value.

Throws:

RemoteException - thrown for errors

togglePrimaryToSecondary

public Object togglePrimaryToSecondary(int prim,
                                       int sec)
                                throws RemoteException

Causes the widget to use the BEIDManager to convert its data.

Specified by:

togglePrimaryToSecondary in interface PFieldBean

Parameters:

from - assumed to be the current currency ID used to display the data

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

prim -

sec -

Returns:

The converted value.

Throws:

RemoteException - thrown for errors

Since:

Release 6.2

revertToPrimary

public void revertToPrimary(int primary)
                     throws RemoteException

Reverts converted currency data back to the primary representation

Specified by:

revertToPrimary in interface PFieldBean

Parameters:

primary - The primary currency ID

Throws:

RemoteException

getFieldSpec

protected PDataFieldSpecification getFieldSpec()

Gets the field specification used to define the fields accessed by this control. Use this method to retrieve the modelFieldDescription set in the client.

Returns:

A field specification object.

getDisplaySpec

protected PFieldSpecification getDisplaySpec()

Gets the field specification used to define the fields accessed by this control. Use this method to retrieve the displayFieldDescription set in the client.

Returns:

A field specification object.