com.portal.app.cc.comp

Class PMaintenancePage

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

All Implemented Interfaces:

PAccountViewPage, PCCPage, PAppComponent, PClientComponent, PCollectDataListener, PComponent, PComponentAttribute, PViewDataChangeListener, ContainerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

ListOfBalanceMonitorsPanel, ListOfMonitorMembersPanel, PAcctHierarchyPage, PAcctNoHierarchyPage, PARActionDetailAppliedToPage, PARActionDetailPage, PARAllActionsPage, PARBalancePage, PARDisputesPage, PARItemDetailsPage, PARUnappliedPage, PBillDetailsPage, PBillingCycleAndTaxSetupPage, PBillsEntryPanel, PBillUnitHierarchyPage, PChangeStatusPage, PContactPage, PDeferredActionPage, PDeviceHistoryBasePage, PExistingProductsPanel, PGroupMembersPage, PHierarchyLabelPage, PHierarchyMoveOptionsPage, PHierarchyMovePage, PHierarchyRemoveAcctPage, PHomePage, PIACAProfilePanel, PMandateStatusPage, PPaymentPage, PPaymentSetup, PPPVPage, PProductDetailsPanel, PPromotionPage, PSelfRegistrationPage, PServiceDealProductHistoryPanel, PServicePage, PSharingPage, PSponsorGroup, PSponsorGroupMembers, PSponsorship, PSubscriberPrefsPage, PSummaryPage, PTechDetails, PTelcoPromotionPage

public class PMaintenancePage
extends PIACustomizablePanel
implements PAccountViewPage

Base implementation of the PAccountViewPage interface. This is mostly a convenience class that provides some default behavior for Customer Center pages. Note that many of the methods in this implementation should be defined abstract, but that means subclasses would have to add special entries to a JBuilder config file in order to appear editable in that tool. As a result, the methods are left unfortunately non-abstract though they should (must) be overridden. These methods are called out below.

Version:

%version: 17 % %date_modified: Wed Oct 17 14:41:08 2001 %

Author:

kapono

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 boolean	mNeedsRefresh
protected int	mPagesCurrentCurrency Provides a hook to the currency currently used to display data in this panel.

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

Method Summary

Modifier and Type	Method and Description
void	dataNeedsRefresh() Called to indicate this page needs to be refreshed.
void	enteringPage() This method will be called right after a page is made visible via a drilldown.
int	getDisplayedCurrency() Retrieves the internal currency id this panel is using to display data.
String	getLabel() Retrieves the localizable tag that can be displayed in a breadcrumb trail to represent this component. This implementation returns an empty string by default. This is a no-op in this class.
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.
boolean	isValidContext(PAccountViewContext ctx) Used to determine if the page is valid given the account object.
void	primaryToSecondary(int from, int to) Called by the Customer Center framework to indicate that any currency data displayed in this page must be converted to a different currency.
void	recycle() Used to make this page available for reuse.
void	refresh() Called when the page should be immediately refreshed - typically as a result of the Reset action being invoked by the user.
void	resetUnsavedChanges() This method is responsible for undo'ing the changes made to the page and resetting back to the original. This implementation defaults to calling resetToDefault in the base class.
void	revertToPrimary(int primary) Causes previously toggled data to be reverted back to the primary currency.
void	save() This is the hook for an encapsulating container to indicate this panel should save itself, if necessary.

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

clear, collectData, componentAdded, componentRemoved, containsError, getBackgroundImageSource, getBundle, getControllerClassName, getModelHandle, getRemoteComponent, getResourceName, getTools, isClean, isCurrencyDisplay, isDirty, isError, isInputTracking, isLight, isRequired, processError, resetToDefault, setBackgroundImageMode, setBackgroundImageSource, setClean, setCurrencyDisplay, setDefault, setError, setInputTracking, setModelHandle, 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, 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, paintBorder, paintChildren, paintImmediately, paintImmediately, 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

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

mPagesCurrentCurrency

protected int mPagesCurrentCurrency

Provides a hook to the currency currently used to display data in this panel.

mNeedsRefresh

protected boolean mNeedsRefresh

Constructor Detail

PMaintenancePage

public PMaintenancePage()

Method Detail

enteringPage

public void enteringPage()

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

save

public void save()
          throws PSaveException

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

Throws:

PSaveException

hasUnsavedChanges

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

Specified by:

hasUnsavedChanges in interface PAccountViewPage

Returns:

true if this page contains unsaved changes; false otherwise

resetUnsavedChanges

public void resetUnsavedChanges()

This method is responsible for undo'ing the changes made to the page and resetting back to the original.
This implementation defaults to calling resetToDefault in the base class.

Specified by:

resetUnsavedChanges in interface PAccountViewPage

getDisplayedCurrency

public int getDisplayedCurrency()

Retrieves the internal currency id this panel is using to display data. The currency manager looks at this to determine if the page needs to convert to a different currency for display purposes when the CSR changes the global currency.

Specified by:

getDisplayedCurrency in interface PAccountViewPage

Returns:

The currency this page is using to display data

primaryToSecondary

public void primaryToSecondary(int from,
                               int to)

Called by the Customer Center framework to indicate that any currency data displayed in this page must be converted to a different currency. The specific currencies will be passed in as Portal integer representations (i.e. 840 == US Dollar, etc.). These values can be passed directly to the BEID manager for conversion.
This default implementation stores off the 'to' currency.

Specified by:

primaryToSecondary in interface PAccountViewPage

Parameters:

from - The currency currently displayed

to - The currency to convert to and display

revertToPrimary

public void revertToPrimary(int primary)

Description copied from class: PIACustomizablePanel

Causes previously toggled data to be reverted back to the primary currency.

Specified by:

revertToPrimary in interface PAccountViewPage

Specified by:

revertToPrimary in interface PComponentAttribute

Overrides:

revertToPrimary in class PIACustomizablePanel

Parameters:

primary - The primary currency

getLabel

public String getLabel()

Retrieves the localizable tag that can be displayed in a breadcrumb trail to represent this component.
This implementation returns an empty string by default.
This is a no-op in this class. Subclasses should override this

Specified by:

getLabel in interface PCCPage

Returns:

The tag that will be displayed in the breadcrumb trail to reference this component.

recycle

public void recycle()

Used to make this page available for reuse.

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

Specified by:

recycle in interface PCCPage

isValidContext

public boolean isValidContext(PAccountViewContext ctx)

Used to determine if the page is valid given the account object. Certain pages may display data that is not appropriate for a particular account (i.e. a page displays service-specific data that an account may not contain).

Specified by:

isValidContext in interface PAccountViewPage

Parameters:

ctx - The current account view's context

Returns:

true by default

refresh

public void refresh()

Called when the page should be immediately refreshed - typically as a result of the Reset action being invoked by the user.

Specified by:

refresh in interface PAccountViewPage

dataNeedsRefresh

public void dataNeedsRefresh()

Called to indicate this page needs to be refreshed. The default implementation will call its refresh method if the page is showing; otherwise it simply sets a flag that is referenced in the enteringPage() method. If the flag is set when enteringPage() is is called, the page is refreshed at that time.

Specified by:

dataNeedsRefresh in interface PAccountViewPage