com.portal.app.cc

Class PPaymentPage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.portal.pfc.ui.ImagePanel

com.portal.bas.comp.PIACustomizablePanel

com.portal.app.cc.comp.PMaintenancePage

com.portal.app.cc.PPaymentPage

All Implemented Interfaces:

PAccountViewPage, PCCPage, HierarchyChangeListener, PaymentChangeListener, ServiceChangeListener, PSpreadSheetListener, PAppComponent, PClientComponent, PCollectDataListener, PComponent, PComponentAttribute, PViewDataChangeListener, ActionListener, ContainerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ListSelectionListener

public class PPaymentPage
extends PMaintenancePage
implements PSpreadSheetListener, PaymentChangeListener, ServiceChangeListener, HierarchyChangeListener, ActionListener, ListSelectionListener

This page displays the payments that have been applied to an account. It also has a section that diplays the payment type, billing cycle and next billing cycle. There is another section for tax setup.

Author:

pashok

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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 JMenuItem[]	actionItems
static int	CMB_HIERARCHY_TYPE
static int	CMB_PAYMENT_TYPE
static String	PAID_STRING_FRM_PROPERTYFILE

Fields inherited from class com.portal.app.cc.comp.PMaintenancePage

mNeedsRefresh, mPagesCurrentCurrency

Fields inherited from class com.portal.bas.comp.PIACustomizablePanel

isTracking, mIAList, mImpl, unregList

Fields inherited from class com.portal.pfc.ui.ImagePanel

IMAGE_CENTERED, IMAGE_SCALE_TO_HEIGHT, IMAGE_SCALE_TO_WIDTH, IMAGE_SCALED, IMAGE_TILED, mImageIcon, mScaledImage

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
PPaymentPage() Creates a new payment screen

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) put your documentation comment here
protected void	addAdditionalActions(PAddOnAction[] actions) Called to add actions to the payment display component.
void	addNotify() Overridden to register for payment change events
String	constructFormatString(String sFormatString, int[] iDiallowedList) Constructs a format string that excludes exemption types that are present in the exemption table.
protected void	disableBillingCycleAndTaxSetupLink() This method can be used in the extended customized page if the Bill and Tax link needs to be disabled.
void	dumpFlist(PModelHandle pm)
protected void	enableBillingCycleAndTaxSetupLink() This method can be used in the extended customized page if the Bill and Tax link needs to be enabled.
void	enteringPage() This method will be called right after a page is made visible via a drilldown.
static String	getCardType(String cardNumber, int cardTyp) To identify the type of card
String	getControllerClassName() Retrieves the class name of this component's controller, in this case, null.
Vector	getPayMethods() gets the payment methods for the current account
boolean	hasUnsavedChanges() Determines if the user has made changes to the data on this page and not committed them to Portal yet. This implementation defaults to calling isDirty() in the base class.
void	hierarchyChange(HierarchyChangeEvent e) listen to nge event
void	initializeActionsMenu()
void	paymentChange(PaymentChangeEvent pe) Called when the payment info changes
void	primaryToSecondary(int from, int to) Changes the display from primary to the secondary currency.
void	recycle() Used to make this page available for reuse.
void	refresh() put your documentation comment here
void	refreshPayments() Refreshes the payment combobox when a new payment method is added
void	removeNotify() Overridden to unregister for payment change events
void	resetUnsavedChanges() This method is responsible for undo'ing the changes made to the page and resetting back to the original.
void	revertToPrimary(int primary) Changes the display to the primary currency.
void	save() This is the hook for an encapsulating container to indicate this panel should save itself, if necessary.
void	selectionChanged(PSpreadSheetEvent pe) put your documentation comment here
void	serviceChange(ServiceChangeEvent e) Event handler for ServiceChangeEvent.
static String	setCreditCardPerm(String ccNumber) This method is used to mask the credit card number.
static String	setDebitCardPerm(String ddNumber) This method is used to mask the debit card account number.
void	setModelHandle(PModelHandle pm) Updates the page with new data
void	valueChanged(ListSelectionEvent e)

Methods inherited from class com.portal.app.cc.comp.PMaintenancePage

dataNeedsRefresh, getDisplayedCurrency, getLabel, isValidContext

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

clear, collectData, componentAdded, componentRemoved, containsError, getBackgroundImageSource, getBundle, getModelHandle, getRemoteComponent, getResourceName, getTools, isClean, isCurrencyDisplay, isDirty, isError, isInputTracking, isLight, isRequired, processError, resetToDefault, setBackgroundImageMode, setBackgroundImageSource, setClean, setCurrencyDisplay, setDefault, setError, setInputTracking, setRequired, setResourceName, togglePrimaryToSecondary, unregister, viewDataChange

Methods inherited from class com.portal.pfc.ui.ImagePanel

getBackgroundImageIcon, getBackgroundImageMode, imageUpdate, paintComponent, setBackgroundImageIcon

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, 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, setEnabled, 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, 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

actionItems

protected JMenuItem[] actionItems

PAID_STRING_FRM_PROPERTYFILE

public static String PAID_STRING_FRM_PROPERTYFILE

CMB_PAYMENT_TYPE

public static final int CMB_PAYMENT_TYPE

See Also:

Constant Field Values

CMB_HIERARCHY_TYPE

public static final int CMB_HIERARCHY_TYPE

See Also:

Constant Field Values

Constructor Detail

PPaymentPage

public PPaymentPage()

Creates a new payment screen

Method Detail

addNotify

public void addNotify()

Overridden to register for payment change events

Overrides:

addNotify in class JComponent

refresh

public void refresh()

put your documentation comment here

Specified by:

refresh in interface PAccountViewPage

Overrides:

refresh in class PMaintenancePage

removeNotify

public void removeNotify()

Overridden to unregister for payment change events

Overrides:

removeNotify in class JComponent

paymentChange

public void paymentChange(PaymentChangeEvent pe)

Called when the payment info changes

Specified by:

paymentChange in interface PaymentChangeListener

Parameters:

pe - the payment change event

getControllerClassName

public String getControllerClassName()
                              throws RemoteException

Description copied from class: PIACustomizablePanel

Retrieves the class name of this component's controller, in this case, null.

Specified by:

getControllerClassName in interface PComponent

Overrides:

getControllerClassName in class PIACustomizablePanel

Returns:

the controller for this class

Throws:

RemoteException

dumpFlist

public void dumpFlist(PModelHandle pm)
               throws RemoteException

Throws:

RemoteException

setModelHandle

public void setModelHandle(PModelHandle pm)
                    throws RemoteException

Updates the page with new data

Specified by:

setModelHandle in interface PComponent

Overrides:

setModelHandle in class PIACustomizablePanel

Parameters:

pm - the model handle

Throws:

RemoteException - thrown for errors

initializeActionsMenu

public void initializeActionsMenu()

getPayMethods

public Vector getPayMethods()

gets the payment methods for the current account

Returns:

Vector

getCardType

public static String getCardType(String cardNumber,
                                 int cardTyp)

To identify the type of card

Parameters:

cardNumber -

Returns:

setCreditCardPerm

public static String setCreditCardPerm(String ccNumber)

This method is used to mask the credit card number.

setDebitCardPerm

public static String setDebitCardPerm(String ddNumber)

This method is used to mask the debit card account number.

save

public void save()
          throws PSaveException

Description copied from class: PMaintenancePage

This is the hook for an encapsulating container to indicate this panel should save itself, if necessary. If the page wishes to signal a save failure it should throw a PSaveException. This is a no-op in this class.

Subclasses should override this

Specified by:

save in interface PAccountViewPage

Overrides:

save in class PMaintenancePage

Throws:

PSaveException

resetUnsavedChanges

public void resetUnsavedChanges()

This method is responsible for undo'ing the changes made to the page and resetting back to the original.

Specified by:

resetUnsavedChanges in interface PAccountViewPage

Overrides:

resetUnsavedChanges in class PMaintenancePage

hasUnsavedChanges

public boolean hasUnsavedChanges()

Description copied from class: PMaintenancePage

Determines if the user has made changes to the data on this page and not committed them to Portal yet.
This implementation defaults to calling isDirty() in the base class.

Specified by:

hasUnsavedChanges in interface PAccountViewPage

Overrides:

hasUnsavedChanges in class PMaintenancePage

Returns:

true if this page contains unsaved changes; false otherwise

serviceChange

public void serviceChange(ServiceChangeEvent e)

Event handler for ServiceChangeEvent.

Specified by:

serviceChange in interface ServiceChangeListener

Parameters:

e - a StatusChangeEvent

selectionChanged

public void selectionChanged(PSpreadSheetEvent pe)

put your documentation comment here

Specified by:

selectionChanged in interface PSpreadSheetListener

Parameters:

pe -

addAdditionalActions

protected void addAdditionalActions(PAddOnAction[] actions)

Called to add actions to the payment display component. This results in a new Action dropdown (if this is the first time the method is called). The existing export action is appended to the menu followed by the user specified PAddOnAction instances. Your subclass should look like the following:

 public class MyPaymentPage extends PPaymentPage {
        public MyPaymentPage() {
                PAddOnAction[] actions = new PAddOnAction[1];
                actions[0] = new MyPaymentAction_A();
                addAdditionalActions(actions);
        }
 }

 class MyPaymentAction_A extends PAddOnAction {
        public MyPaymentAction_A() {
        }

        public String getMenuLabel() {
                return "Payment Action A";
        }
 }
 

Parameters:

actions - The array of PAddOnAction instances to append

constructFormatString

public String constructFormatString(String sFormatString,
                                    int[] iDiallowedList)

Constructs a format string that excludes exemption types that are present in the exemption table.

primaryToSecondary

public void primaryToSecondary(int from,
                               int to)

Changes the display from primary to the secondary currency.

Specified by:

primaryToSecondary in interface PAccountViewPage

Overrides:

primaryToSecondary in class PMaintenancePage

Parameters:

from - The currency currently displayed

to - The currency to convert to and display

revertToPrimary

public void revertToPrimary(int primary)

Changes the display to the primary currency.

Specified by:

revertToPrimary in interface PAccountViewPage

Specified by:

revertToPrimary in interface PComponentAttribute

Overrides:

revertToPrimary in class PMaintenancePage

Parameters:

primary - The primary currency

actionPerformed

public void actionPerformed(ActionEvent e)

put your documentation comment here

Specified by:

actionPerformed in interface ActionListener

Parameters:

e -

hierarchyChange

public void hierarchyChange(HierarchyChangeEvent e)

listen to nge event

Specified by:

hierarchyChange in interface HierarchyChangeListener

Parameters:

e - a HierarchyChangeEvent encapsulating the event information

refreshPayments

public void refreshPayments()

Refreshes the payment combobox when a new payment method is added

recycle

public void recycle()

Description copied from class: PMaintenancePage

Used to make this page available for reuse.

Subclasses should override this, but also call super.recycle()

Specified by:

recycle in interface PCCPage

Overrides:

recycle in class PMaintenancePage

disableBillingCycleAndTaxSetupLink

protected void disableBillingCycleAndTaxSetupLink()

This method can be used in the extended customized page if the Bill and Tax link needs to be disabled.

enableBillingCycleAndTaxSetupLink

protected void enableBillingCycleAndTaxSetupLink()

This method can be used in the extended customized page if the Bill and Tax link needs to be enabled.

valueChanged

public void valueChanged(ListSelectionEvent e)

Specified by:

valueChanged in interface ListSelectionListener

enteringPage

public void enteringPage()

Description copied from class: PMaintenancePage

This method will be called right after a page is made visible via a drilldown. The default implementation inspects the currency being used to display data for the client at large and compares it to the currency used by the panel. If they differ primaryToSecondary() is called.
This implementation also looks at the internal refresh flag to determine if a subclass has indicated the page is out of date. If it is, this method invokes the setModelHandle() method with the current PModelHandle.

Subclasses that override this method should call super.enteringPage()

Specified by:

enteringPage in interface PCCPage

Overrides:

enteringPage in class PMaintenancePage