com.portal.bas.comp

Class PIABooleanEnumField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

javax.swing.JCheckBox

com.portal.bas.comp.PIABooleanEnumField

All Implemented Interfaces:

PAppComponent, PAppFieldComponent, PClientComponent, PCollectDataListener, PComponent, PComponentAttribute, PFieldBean, PLightComponent, PViewDataChangeListener, ItemListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, Remote, EventListener, Accessible, SwingConstants

public class PIABooleanEnumField
extends JCheckBox
implements PAppFieldComponent, PLightComponent, PComponentAttribute, PCollectDataListener, ItemListener, Serializable

PIABooleanEnumField creates an Portal-aware checkbox component.

Version:

%version: 16 % %date_modified: Tue Dec 18 19:22:34 2001 %

Author:

larrylf

See Also:

Serialized Form

Nested Class Summary

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

JCheckBox.AccessibleJCheckBox

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

JToggleButton.AccessibleJToggleButton, JToggleButton.ToggleButtonModel

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

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

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.JCheckBox

BORDER_PAINTED_FLAT_CHANGED_PROPERTY

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PIABooleanEnumField() Creates a checkbox component that is Portal-aware

Method Summary

Modifier and Type	Method and Description
void	clear() Resets the state of this checkbox to false.
void	collectData(PCollectDataEvent event) Overrides PCollectDataListener.
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.
int	getFalseValue() Get the Enumeration value used for false; defaults to 0.
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.
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 for this object.
String	getResourceName() Returns the base resource name used to look up a resource.
Vector	getTools() Gets the list of actions supported by this component.
int	getTrueValue() Get the Enumeration value used for true; defaults to 1.
boolean	isCurrencyDisplay() Determines whether the component currently displays currency data.
boolean	isDirty() Determines if this component is currently in a DIRTY state.
boolean	isError() Determines if this component is currently in an ERROR state.
boolean	isInputTracking() Determines if inputTracking is enabled.
boolean	isLight() Determines if this component defers PModelHandle knowledge to its parent container.
boolean	isRequired() Determines if this component is a required field in its current context.
void	itemStateChanged(ItemEvent e) The method invoked when the component's state is changed.
void	resetToDefault() Resets the component value to the original value established by calling setDefault().
void	revertToPrimary(int primary) Causes the widget to display its data in the primary currency
void	setAssociatedClass(String name) Sets the associated class, if any, for this field.
void	setClean() Resets the component to the CLEAN state.
void	setCurrencyDisplay(boolean b) Determines whether this component currently displays currency data.
void	setDefault() Establishes the current value (or element count, depending on the given component) as the default value.
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	setError(boolean b) Marks this component as containing erroneous data in the current context, or unmarks the ERROR state, depending on the parameter.
void	setFalseValue(int falseVal) Set the Enumeration value used for false; defaults to 0.
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	setInputTracking(boolean b) If the inputTracking property is enabled, any changes made by the user to the component are tracked and the component is marked DIRTY.
void	setLightData(Object field) Sets the lightweight data object.
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	setRequired(boolean b) Marks this component as required in its current context.
void	setResourceName(String name) Sets the base resource name used to look up resources.
void	setTrueValue(int trueVal) Sets the Enumeration value used for true; defaults to 1.
Object	togglePrimaryToSecondary(int primary, int secondary) Does nothing.
void	unregister() Used to disassociate this component from its delegate (controller)
void	viewDataChange(PViewDataChangeEvent event) Overrides PViewDataChangeListener.

Methods inherited from class javax.swing.JCheckBox

getAccessibleContext, getUIClassID, isBorderPaintedFlat, paramString, setBorderPaintedFlat, updateUI

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, 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, 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, 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

PIABooleanEnumField

public PIABooleanEnumField()

Creates a checkbox component that is Portal-aware

Method Detail

unregister

public void unregister()
                throws RemoteException

Used to disassociate this component from its delegate (controller)

Specified by:

unregister in interface PClientComponent

Throws:

RemoteException

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 if this component defers PModelHandle knowledge to its parent container. If so, the parent container passes the PModelHandle to this component on the server side (by way of the controller), which saves a client/server round trip for data exchange.

If specific processing is required, when PModelHandle is called, subclass this component and override this method. Otherwise, setModelHandle() is not called.

Specified by:

isLight in interface PComponent

Returns:

True if the component defers knowledge, 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 value "com.portal.bas.comp.PIAFieldBean", the default controller for most instances of PFieldComponent.

Throws:

RemoteException - thrown for errors

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.

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

setLightData

public void setLightData(Object field)

Sets the lightweight data object.

Specified by:

setLightData in interface PLightComponent

Parameters:

field - the lightweight component's display data

getLightData

public Object getLightData()

Gets the lightweight data object.

Specified by:

getLightData in interface PLightComponent

Returns:

The lightweight component's Integer display value.

getDataDescriptor

public String getDataDescriptor()

Gets the data field description used by the component.

Specified by:

getDataDescriptor in interface PLightComponent

Returns:

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

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

resetToDefault

public void resetToDefault()

Resets the component value to the original value established by calling setDefault(). If no default value exists, the component data is cleared.

Specified by:

resetToDefault in interface PComponentAttribute

clear

public void clear()

Resets the state of this checkbox to false.

Specified by:

clear in interface PComponentAttribute

isRequired

public boolean isRequired()

Determines if this component is a required field in its current context. This provides a visual indicator only; there is no mechanism to enforce that required fields be filled in.

Specified by:

isRequired in interface PComponentAttribute

Returns:

True if this field is marked REQUIRED; false otherwise.

setRequired

public void setRequired(boolean b)

Marks this component as required in its current context. This is currently a visual indicator only; there is no mechanism to enforce that required fields be filled in.

Specified by:

setRequired in interface PComponentAttribute

Parameters:

b - if true, puts the component in REQUIRED state

isError

public boolean isError()

Determines if this component is currently in an ERROR state.

Specified by:

isError in interface PComponentAttribute

Returns:

True if this component is in an ERROR state; false otherwise.

setError

public void setError(boolean b)

Marks this component as containing erroneous data in the current context, or unmarks the ERROR state, depending on the parameter.

Specified by:

setError in interface PComponentAttribute

Parameters:

b - if true, puts the component in ERROR state; if false, removes the ERROR state

setInputTracking

public void setInputTracking(boolean b)

If the inputTracking property is enabled, any changes made by the user to the component are tracked and the component is marked DIRTY. If the user modifies the data and returns it to its default or original state, the component is marked CLEAN or not DIRTY.

Specified by:

setInputTracking in interface PComponentAttribute

Parameters:

b - the state of the inputTracking property

isInputTracking

public boolean isInputTracking()

Determines if inputTracking is enabled.

Specified by:

isInputTracking in interface PComponentAttribute

Returns:

True if inputTracking is enabled; false otherwise.

setClean

public void setClean()

Resets the component to the CLEAN state. If the component was in a DIRTY or ERROR state, this method removes those attributes. A required component is still marked REQUIRED after a call to this method.

Specified by:

setClean in interface PComponentAttribute

isDirty

public boolean isDirty()

Determines if this component is currently in a DIRTY state.

Specified by:

isDirty in interface PComponentAttribute

Returns:

True if the user has modified the data represented by this component, false otherwise. It also returns false if inputTracking is not enabled.

setDefault

public void setDefault()

Establishes the current value (or element count, depending on the given component) as the default value. Any modifications made after this method is called will result in a DIRTY component.

Specified by:

setDefault in interface PComponentAttribute

setCurrencyDisplay

public void setCurrencyDisplay(boolean b)

Determines whether this component currently displays currency data. Widgets that display currency data are capable of automatically toggling their data between a primary and secondary Portal currency type.

Specified by:

setCurrencyDisplay in interface PComponentAttribute

Parameters:

b - if true, indicates that the component currently displays currency data

Since:

Release 6.2

isCurrencyDisplay

public boolean isCurrencyDisplay()

Determines whether the component currently displays currency data.

Specified by:

isCurrencyDisplay in interface PComponentAttribute

Returns:

True if the component currently displays currency data; false otherwise.

Since:

Release 6.2

togglePrimaryToSecondary

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

Does nothing.

Specified by:

togglePrimaryToSecondary in interface PComponentAttribute

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

Causes the widget to display its data in the primary currency

Specified by:

revertToPrimary in interface PComponentAttribute

Specified by:

revertToPrimary in interface PFieldBean

Parameters:

primary - The primary currency ID for an account

Throws:

RemoteException

setTrueValue

public void setTrueValue(int trueVal)

Sets the Enumeration value used for true; defaults to 1.

Parameters:

trueVal - the value to use for true

getTrueValue

public int getTrueValue()

Get the Enumeration value used for true; defaults to 1.

Returns:

An integer value to use for true.

setFalseValue

public void setFalseValue(int falseVal)

Set the Enumeration value used for false; defaults to 0.

Parameters:

falseVal - the value to use for false

getFalseValue

public int getFalseValue()

Get the Enumeration value used for false; defaults to 0.

Returns:

An integer value to use for false.

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

collectData

public void collectData(PCollectDataEvent event)

Overrides PCollectDataListener. Causes the controller to save changes to the data model. Done by BAS prior to committing changes to Portal.

Specified by:

collectData in interface PCollectDataListener

Parameters:

event - the data collection event

itemStateChanged

public void itemStateChanged(ItemEvent e)

The method invoked when the component's state is changed.

Specified by:

itemStateChanged in interface ItemListener

Parameters:

e - the event that contains the change