com.portal.app.cc.comp

Class PIAPaymentField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JComboBox

com.portal.bas.comp.PIAEnumField

com.portal.bas.comp.PIADefaultChoiceEnumField

com.portal.app.cc.comp.PIAPaymentField

All Implemented Interfaces:

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

public class PIAPaymentField
extends PIADefaultChoiceEnumField

A combobox component containing knowledge of the payment types supported by a given Portal server. This component will query Customer Center for the list of its supported payment types, and match these against a query of Portal. All matching items are displayed in the list.
Specifically, this component will read a property like "maintenance.options" where "maintenance" is specified using the setContextTag() api. It will then query Portal for the list of supported opcodes. These 2 lists are compared and those that occur in both lists are displayed in the menu.

Version:

%version: 8 % %date_modified: Thu Jun 13 09:51:10 2002 %

Author:

kapono

See Also:

Serialized Form

Nested Class Summary

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

JComboBox.AccessibleJComboBox, JComboBox.KeySelectionManager

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

Modifier and Type	Field and Description
protected String	payMethodFormat List of available methods of payment as a message format string
protected String	payMethodFormatSubordinate List of available methods of payment as a message format string

Fields inherited from class javax.swing.JComboBox

actionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminder

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
PIAPaymentField()

Method Summary

Modifier and Type	Method and Description
void	addNotify() Overridden to build up the list of supported payment options
void	alwaysResetToDefault(boolean b) By default, addNotify() resets the widget values to the default.
String	getContextTag() Returns the context tag
String	getControllerClassName() Identifies the controller class for this component
boolean	getSupportSubordinate()
boolean	isAlwaysResetToDefault() Returns the reset to default state of this widget
void	selectDefault()
void	setContextTag(String tag) Identifies the property tag which should be queried when determing the Customer Center supported payment types.
void	setLightData(Object obj) Sets the lightweight data object.
void	setSupportSubordinate(boolean b) In certain situations, Subordinate should not be a payment option a CSR can select when changing payment types.

Methods inherited from class com.portal.bas.comp.PIADefaultChoiceEnumField

collectData, getDefaultString, getDisplayName, getSelectedValue, setDefaultString, setSelectedEnumValue, setUserDefault

Methods inherited from class com.portal.bas.comp.PIAEnumField

clear, findDefaultIfPresent, formatData, getAssociatedClass, getDataDescriptor, getDisplayFieldDescription, getDisplayFieldFormat, getField, getHelpID, getLightData, getModelFieldDescription, getModelHandle, getRemoteComponent, getResourceName, getTools, isCurrencyDisplay, isDirty, isError, isInputTracking, isLight, isRequired, resetToDefault, revertToPrimary, setAssociatedClass, setClean, setCurrencyDisplay, setDefault, setDisplayFieldDescription, setDisplayFieldFormat, setError, setField, setHelpID, setInputTracking, setModelFieldDescription, setModelHandle, setRequired, setResourceName, togglePrimaryToSecondary, unregister, viewDataChange

Methods inherited from class javax.swing.JComboBox

actionPerformed, actionPropertyChanged, addActionListener, addItem, addItemListener, addPopupMenuListener, configureEditor, configurePropertiesFromAction, contentsChanged, createActionPropertyChangeListener, createDefaultKeySelectionManager, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getModel, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedItem, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyBinding, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setSelectedItem, setUI, showPopup, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, 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, 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, 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, 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

Field Detail

payMethodFormat

protected String payMethodFormat

List of available methods of payment as a message format string

payMethodFormatSubordinate

protected String payMethodFormatSubordinate

List of available methods of payment as a message format string

Constructor Detail

PIAPaymentField

public PIAPaymentField()

Method Detail

getControllerClassName

public String getControllerClassName()
                              throws RemoteException

Identifies the controller class for this component

Specified by:

getControllerClassName in interface PComponent

Overrides:

getControllerClassName in class PIAEnumField

Returns:

The controller's class name

Throws:

RemoteException - thrown for errors

setContextTag

public void setContextTag(String tag)

Identifies the property tag which should be queried when determing the Customer Center supported payment types. As of the 6.1 release, there are definitions for "maintenance", "consumerpayment", and "businesspayment". The 2 properties that will be read are:
tag.options
tag.default
where tag is the 'tag' parameter

Parameters:

tag - The property tag to read from the property file

getContextTag

public String getContextTag()

Returns the context tag

Returns:

the context tag

alwaysResetToDefault

public void alwaysResetToDefault(boolean b)

By default, addNotify() resets the widget values to the default. Pass false to this method if you do not want this behavior for some reason.

Parameters:

b - If true (default), addNotify() will reset the widget values to default.

isAlwaysResetToDefault

public boolean isAlwaysResetToDefault()

Returns the reset to default state of this widget

Returns:

true if the widget values are reset in addNotify(); false otherwise

setSupportSubordinate

public void setSupportSubordinate(boolean b)

In certain situations, Subordinate should not be a payment option a CSR can select when changing payment types. However, it is a valid payment type for existing accounts and when creating subordinate accounts. By indicating the need for Subordinate support, this component will take this into account when building the list of payment options.

Parameters:

b - true if this components needs to handle the Subordinate payment type

getSupportSubordinate

public boolean getSupportSubordinate()

Returns:

true if this component supports Subordinate as a payment type

setLightData

public void setLightData(Object obj)

Description copied from class: PIAEnumField

Sets the lightweight data object.

Specified by:

setLightData in interface PLightComponent

Overrides:

setLightData in class PIAEnumField

Parameters:

obj - the lightweight component's display data

addNotify

public void addNotify()

Overridden to build up the list of supported payment options

Overrides:

addNotify in class PIAEnumField

selectDefault

public void selectDefault()