com.portal.bas.comp

Class PIAFieldComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.portal.bas.comp.PIAFieldComponent

All Implemented Interfaces:

PAppComponent, PAppFieldComponent, PClientComponent, PComponent, PFieldBean, PViewDataChangeListener, ImageObserver, MenuContainer, Serializable, Remote, EventListener

public class PIAFieldComponent
extends JComponent
implements PAppFieldComponent, Serializable

PIAFieldComponent is a Swing-compatible, Portal-aware field component boilerplate code.

Version:

3

Author:

Larry Lynch-Freshner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
PIAFieldComponent() Constructs a PIAFieldComponent and registers it with the BAS server.

Method Summary

Modifier and Type	Method and Description
String	getAssociatedClass() Gets the associated class, if any, for this field.
String	getControllerClassName() Retrieves the class name of this component's controller.
String	getDataDescriptor() Gets the data field description used by the component.
String	getDisplayFieldDescription() Gets the data field description used by this component.
String	getDisplayFieldFormat() Gets the display field format used by this component.
Object	getField() Gets the value of the field referred to in the displayFieldDescription.
String	getHelpID() Gets the current help ID for this component.
Object	getLightData() Gets the lightweight data object; in this implementation, an empty value.
String	getModelFieldDescription() Gets the data field description used by this component.
PModelHandle	getModelHandle() Retrieves the PModelHandle for this component.
Remote	getRemoteComponent() Gets a reference to the remote component (controller) for this object.
String	getResourceName() Returns the base resource name used to look up a resource.
Vector	getTools() Gets a list of actions supported by this component.
boolean	isLight() Determines whether this is a lightweight component.
void	revertToPrimary(int primary) Implement PFieldBean.revertToPrimary.
void	setAssociatedClass(String name) Sets the associated class, if any, for this field.
void	setDisplayFieldDescription(String fieldDisp) Sets the description of the field(s) in the data model for this component to display.
void	setDisplayFieldFormat(String fieldForm) Sets the java.text.MessageFormat used to display data in this component.
void	setField(Object field) Sets the value of the field referred to in the modelFieldDescription.
void	setHelpID(String id) Sets the help ID for this component.
void	setLightData(Object field) Sets the lightweight data object; in this implementation, an empty value.
void	setModelFieldDescription(String fieldDesc) Sets the description of the field in the data model that this component is interested in.
void	setModelHandle(PModelHandle data) Establishes the PModelHandle for this component.
void	setResourceName(String name) Sets the base resource name used to look up resources.
Object	togglePrimaryToSecondary(int primary, int secondary) Implement PFieldBean.togglePrimaryToSecondary.
void	unregister() Implement PClientComponent.unregister().
void	viewDataChange(PViewDataChangeEvent event) Overrides PViewDataChangeListener.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

PIAFieldComponent

public PIAFieldComponent()

Constructs a PIAFieldComponent and registers it with the BAS server.

Method Detail

setModelHandle

public void setModelHandle(PModelHandle data)
                    throws RemoteException

Establishes the PModelHandle for this component.

Specified by:

setModelHandle in interface PComponent

Parameters:

data - the new PModelHandle from which to extract 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, or null if this is a lightweight 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:

True if the component is lightweight; false otherwise.

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 controller's class name.

Throws:

RemoteException - thrown for errors

getTools

public Vector getTools()

Gets a list of actions supported by this component. When subclassed, the overriding class should call its super class version, then add its actions to the returned list. This preserves 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 (controller) for this object.

Specified by:

getRemoteComponent in interface PAppComponent

Returns:

A Remote object, which is the remote controller for this View class.

setModelFieldDescription

public void setModelFieldDescription(String fieldDesc)
                              throws RemoteException

Sets the description of the field in the data model that this component is interested in.

Specified by:

setModelFieldDescription in interface PFieldBean

Parameters:

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

Throws:

RemoteException - thrown for errors

getModelFieldDescription

public String getModelFieldDescription()
                                throws RemoteException

Gets the data field description used by this component.

Specified by:

getModelFieldDescription in interface PFieldBean

Returns:

A String description of the field used by this component.

Throws:

RemoteException - thrown for errors

setDisplayFieldDescription

public void setDisplayFieldDescription(String fieldDisp)
                                throws RemoteException

Sets the description of the field(s) in the data model for this component to display.

Specified by:

setDisplayFieldDescription in interface PFieldBean

Parameters:

fieldDisp - a String that describes the field displayed by this component

Throws:

RemoteException - thrown for errors

getDisplayFieldDescription

public String getDisplayFieldDescription()
                                  throws RemoteException

Gets the data field description used by this component.

Specified by:

getDisplayFieldDescription in interface PFieldBean

Returns:

A String description of the field used by this component.

Throws:

RemoteException - thrown for errors

setDisplayFieldFormat

public void setDisplayFieldFormat(String fieldForm)
                           throws RemoteException

Sets the java.text.MessageFormat used to display data in this component. This is typically (but not necessarily) directly tied to the displayFieldDescription. For this specific widget, the format might be similar to the following:

"{0,choice,0#First Label|1#2nd Label|2#Third Label}"

Specified by:

setDisplayFieldFormat in interface PAppFieldComponent

Parameters:

fieldForm - the format used to display the data

Throws:

RemoteException - thrown for errors

getDisplayFieldFormat

public String getDisplayFieldFormat()
                             throws RemoteException

Gets the display field format used by this component.

Specified by:

getDisplayFieldFormat in interface PAppFieldComponent

Returns:

A String representation of the display field format.

Throws:

RemoteException - thrown for errors

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 - a String with the class name

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:

A String with the associated class name.

Throws:

RemoteException - thrown for errors

setField

public void setField(Object field)
              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

setHelpID

public void setHelpID(String id)

Sets the help ID for this component.

Specified by:

setHelpID in interface PAppFieldComponent

Parameters:

id - the new help ID to set

getHelpID

public String getHelpID()

Gets the current help ID for this component.

Specified by:

getHelpID in interface PAppFieldComponent

Returns:

A String with the current help ID.

viewDataChange

public void viewDataChange(PViewDataChangeEvent event)
                    throws RemoteException

Overrides PViewDataChangeListener. This method is no longer called by the controller itself. To ensure backward compatibility, it is called after the model is set, by any operation that causes a change in the display data. Client code should call the appropriate get() methods on the controller to get the data, because the PViewDataChangeEvent parameter is no longer used.

Specified by:

viewDataChange in interface PViewDataChangeListener

Parameters:

event - the PViewDataChangeEvent event that describes the change. No longer used. By default, the value passed in is always set to null.

Throws:

RemoteException - thrown for errors

getDataDescriptor

public String getDataDescriptor()

Gets the data field description used by the component.

Returns:

A String description of the fields used by this component or null if there is none.

Throws:

RemoteException - thrown for errors

setLightData

public void setLightData(Object field)

Sets the lightweight data object; in this implementation, an empty value.

Parameters:

field - the lightweight component's display data

getLightData

public Object getLightData()

Gets the lightweight data object; in this implementation, an empty value.

Returns:

An empty display value.

togglePrimaryToSecondary

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

Implement PFieldBean.togglePrimaryToSecondary. This implementation simply returns null.

Specified by:

togglePrimaryToSecondary in interface PFieldBean

Parameters:

primary - the primary currency ID

secondary - the secondary currency ID

Returns:

The converted value.

Throws:

RemoteException

revertToPrimary

public void revertToPrimary(int primary)
                     throws RemoteException

Implement PFieldBean.revertToPrimary. This implementation does nothing.

Specified by:

revertToPrimary in interface PFieldBean

Parameters:

primary - the primary currency ID

Throws:

RemoteException

unregister

public void unregister()
                throws RemoteException

Implement PClientComponent.unregister(). This implementation does nothing.

Specified by:

unregister in interface PClientComponent

Throws:

RemoteException