Package com.portal.app.cc.comp

Class PAccountView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTabbedPane

com.portal.bas.comp.PIATabbedPane

com.portal.app.cc.comp.PAccountView

All Implemented Interfaces:

PAccountViewContext, PClientComponent, PComponent, PContextChangedListener, PViewComponent, PViewDataChangeListener, ImageObserver, MenuContainer, PropertyChangeListener, VetoableChangeListener, Serializable, EventListener, Accessible, ChangeListener, SwingConstants

public class PAccountView
extends PIATabbedPane
implements PAccountViewContext, PContextChangedListener, PropertyChangeListener, VetoableChangeListener

Contains the various screens displayed for each account in the system.

Version:

%version: 23 % %date_modified: Wed May 08 11:24:33 2002 %

Author:

kapono

See Also:

• Serialized Form

Nested Class Summary

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

JTabbedPane.AccessibleJTabbedPane, JTabbedPane.ModelListener

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 com.portal.bas.comp.PIATabbedPane

isTracking, MENU_ICONS, MENU_ITEMS, MENU_TIPS, mImpl, mLastTab, mMenu, mMenuIcon, mMouse, MODEL_TYPE, mPopup, SELECTED_INDEX, TO_FRONT_PRIORITY

Fields inherited from class javax.swing.JTabbedPane

changeEvent, changeListener, model, SCROLL_TAB_LAYOUT, tabPlacement, WRAP_TAB_LAYOUT

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

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

Constructor Summary

Constructors

Constructor	Description
PAccountView()	Constructs a tabbed pane containing components described in the "custinfo.panel" property.

Method Summary

Modifier and Type	Method	Description
void	addNotify()	Sends out a property change event indicating the currently selected tab.
void	addToView(PAccountViewPage sp)	Adds a page to this account view as a tab.
void	appletStart(PContextChangedEvent event)	Handles a context change event associated with starting an applet.
void	appletStop(PContextChangedEvent event)	Handles a context change event associated with stopping an applet.
Dimension	getMinimumSize()
PPageTracker	getPageTracker()	Retrieves the class that manages the navigation stack (back button)
PRefreshManager	getRefreshManager()	Retrieves the class through which pages register for Refresh notification.
Vector	getTools()	Returns the set of tools to use for all panels in this panel.
PPageTemplate	getVisibleTemplate()	Retrieves the encompassing template for the currently visible top-level page.
boolean	isPartOfView(PAccountViewPage sp)	Determines if this page is a visible tab.
boolean	okToExit(PContextChangedEvent event)	Handles a user's exit from this tabbed pane and attempts to save any changes made.
void	propertyChange(PropertyChangeEvent evt)	Looks for notification of property changes on the active tab.
void	recycle()	Prepares this component for reuse.
void	refreshModelHandle(PModelHandle data)	Refreshes the view with this account's data.
void	removeFromView(PAccountViewPage sp)	Locates the tab containing this top-level page and removes that tab.
void	setModelHandle(PModelHandle data)	Verifies that each tab is valid for this context.
void	setSelectedIndex(int idx)
void	sizeChanged(PContextChangedEvent event)	Handles a user's resizing of this tabbed pane.
void	switchToPage(String tag, PAccountViewPage page)	This method searches through the set of drill downs previously added to the current top-level page looking for the given page.
boolean	switchToPage(String tag, PAccountViewPage page, String parentName)	This method allows you to simulate drilling down from a different parent.
PAccountViewPage	switchToPage(String tag, Class pageClass)	This method searches through the set of drill downs previously added to the current top-level page looking for the given class type.
PAccountViewPage	switchToPage(String tag, Class pageClass, String parentName)	This method allows you to simulate drilling down from a different parent.
void	switchToPreviousPage(int idx, Enumeration tags, PAccountViewPage page)	Assumes the current tab's position; will either move up one level in the breadcrumb trail (back) or forward if the specified tag/page does not represent the page one level up (back).
void	toTop(PContextChangedEvent event)	Handles a context change event, where this tabbed pane is moved to the top.
void	vetoableChange(PropertyChangeEvent evt)	Attempts to save changed properties before a tab switch occurs.
void	wasOnTop(PContextChangedEvent event)	Handles a context change event, where this tabbed pane is moved from the top.

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

addTab, addTab, addTab, firePropertyChange, fireVetoableChange, getAllTools, getControllerClassName, getModelHandle, getRemoteComponent, getResourceName, insertTab, isLight, setResourceName, stateChanged, unregister, viewDataChange

Methods inherited from class javax.swing.JTabbedPane

add, add, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, fireStateChanged, getAccessibleContext, getBackgroundAt, getBoundsAt, getChangeListeners, getComponentAt, getDisabledIconAt, getDisplayedMnemonicIndexAt, getForegroundAt, getIconAt, getMnemonicAt, getModel, getSelectedComponent, getSelectedIndex, getTabComponentAt, getTabCount, getTabLayoutPolicy, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, getUI, getUIClassID, indexAtLocation, indexOfComponent, indexOfTab, indexOfTab, indexOfTabComponent, insertTab, isEnabledAt, paramString, remove, remove, removeAll, removeChangeListener, removeTabAt, setBackgroundAt, setComponentAt, setDisabledIconAt, setDisplayedMnemonicIndexAt, setEnabledAt, setForegroundAt, setIconAt, setMnemonicAt, setModel, setSelectedComponent, setTabComponentAt, setTabLayoutPolicy, setTabPlacement, setTitleAt, setToolTipTextAt, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, 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, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, 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, 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

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, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 Details

PAccountView

public PAccountView()

Constructs a tabbed pane containing components described in the "custinfo.panel" property. Components are dynamically instantiated, placed in a scrolled window, and then added as a tab to the tabbed pane.

Method Details

getMinimumSize

public Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent

setModelHandle

public void setModelHandle(PModelHandle data)
                    throws RemoteException

Verifies that each tab is valid for this context. If the tab is not valid for this context, removes it from the view and moves up the next tab in the stack to become the current tab.

Specified by:

setModelHandle in interface PComponent

Overrides:

setModelHandle in class PIATabbedPane

Parameters:

data - the model handle for the account data to display

Throws:

RemoteException

refreshModelHandle

public void refreshModelHandle(PModelHandle data)
                        throws RemoteException

Refreshes the view with this account's data.

Parameters:

data - the model handle for the new account data to display

Throws:

RemoteException

getTools

public Vector getTools()

Returns the set of tools to use for all panels in this panel. Individual panels, or even the currently-selected panel, are not queried for their tools. It is currently assumed that they will be queried as they are selected or become active.

Specified by:

getTools in interface PClientComponent

Overrides:

getTools in class PIATabbedPane

Returns:

The global toolkit for the account info panel.

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Looks for notification of property changes on the active tab. Passes the current PModelHandle to update if there is a change.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

e - the property change event

vetoableChange

public void vetoableChange(PropertyChangeEvent evt)
                    throws PropertyVetoException

Attempts to save changed properties before a tab switch occurs.

Specified by:

vetoableChange in interface VetoableChangeListener

Parameters:

evt - a PropertyChangeEvent object describing the event source and the property that was changed

Throws:

PropertyVetoException - thrown if the recipient wants to roll back the property change

addNotify

public void addNotify()

Sends out a property change event indicating the currently selected tab.

Overrides:

addNotify in class JComponent

recycle

public void recycle()

Prepares this component for reuse. Cleans up each tab and makes the first tab visible.

okToExit

public boolean okToExit(PContextChangedEvent event)

Handles a user's exit from this tabbed pane and attempts to save any changes made.

Specified by:

okToExit in interface PContextChangedListener

Parameters:

event - the context change event to handle

toTop

public void toTop(PContextChangedEvent event)

Handles a context change event, where this tabbed pane is moved to the top.

Specified by:

toTop in interface PContextChangedListener

Parameters:

event - the context change event to handle

wasOnTop

public void wasOnTop(PContextChangedEvent event)

Handles a context change event, where this tabbed pane is moved from the top.

Specified by:

wasOnTop in interface PContextChangedListener

Parameters:

event - the context change event to handle

appletStart

public void appletStart(PContextChangedEvent event)

Handles a context change event associated with starting an applet.

Specified by:

appletStart in interface PContextChangedListener

Parameters:

event - the context change event to handle

appletStop

public void appletStop(PContextChangedEvent event)

Handles a context change event associated with stopping an applet.

Specified by:

appletStop in interface PContextChangedListener

Parameters:

event - the context change event to handle

sizeChanged

public void sizeChanged(PContextChangedEvent event)

Handles a user's resizing of this tabbed pane.

Specified by:

sizeChanged in interface PContextChangedListener

Parameters:

event - the context change event to handle

switchToPage

public void switchToPage(String tag,
 PAccountViewPage page)

Description copied from interface: PAccountViewContext

This method searches through the set of drill downs previously added to the current top-level page looking for the given page. If the given page is found, it is made visible and the breadcrumb trail is updated accordingly. If it is not found then the page is added as a new drill down.

If the 'tag' parameter is null, getLabel() is called on 'page' to determine the appropriate breadcrumb tag. Otherwise 'tag' is used in the breadcrumb trail to name the current drill down

Specified by:

switchToPage in interface PAccountViewContext

Parameters:

tag -

page -

switchToPage

public boolean switchToPage(String tag,
 PAccountViewPage page,
 String parentName)

Description copied from interface: PAccountViewContext

This method allows you to simulate drilling down from a different parent. In most cases, you want to drill down from the current page directly. However, there are cases when you need to drill down into an entirely different data area. For instance, you may be on the summary screen and need to drill down into detailed billing data.

This method will atempt to locate the named parent and add the PAccountViewPage as a drill down to it. It will not be added if it was previously added as a drill down - in that case it is simply made visible. If for some reason the parent is not found this method returns false and does not modify the display
If the 'tag' parameter is null, getLabel() is called on 'page' to determine the appropriate breadcrumb tag. Otherwise 'tag' is used in the breadcrumb trail to indicate the current page.

Specified by:

switchToPage in interface PAccountViewContext

Parameters:

tag -

page -

parentName -

Returns:

true if the parent was found and the page successfully displayed as a drill down; false otherwise

switchToPage

public PAccountViewPage switchToPage(String tag,
 Class pageClass)

Description copied from interface: PAccountViewContext

This method searches through the set of drill downs previously added to the current top-level page looking for the given class type. If the given type is found, it is made visible and the breadcrumb trail is updated accordingly. Otherwise the Class is instantiated, added as a drill down, and that instance returned to the caller. This means you can call this API over and over and only one instance of the page will be created and added to the view.

If the 'tag' parameter is null, getLabel() is used to determine the appropriate breadcrumb tag. Otherwise 'tag' is used in the breadcrumb trail to name the current drill down

Specified by:

switchToPage in interface PAccountViewContext

Parameters:

tag -

pageClass -

Returns:

The new visible page, or null if the switch fails.

switchToPage

public PAccountViewPage switchToPage(String tag,
 Class pageClass,
 String parentName)

Description copied from interface: PAccountViewContext

This method allows you to simulate drilling down from a different parent. In most cases, you want to drill down from the current page directly. However, there are cases when you need to drill down into an entirely different data area. For instance, you may be on the General summary screen and need to drill down into detailed billing data.

This method will atempt to locate the named parent and locate an existing drill down of the given Class type. If the Class type exists, that instance is made the current drill down and returned to the caller. Otherwise the Class is instantiated and added as a drill down. This means you can call this method over and over and only one instance of the page will be created and added to the view. If for some reason the parent is not found this method returns false and does not modify the display.
If the 'tag' parameter is null, getLabel() is used to determine the appropriate breadcrumb tag. Otherwise 'tag' is used in the breadcrumb trail to indicate the current page.

Specified by:

switchToPage in interface PAccountViewContext

Parameters:

tag -

pageClass -

parentName -

Returns:

The new visible page, or null if the switch fails.

switchToPreviousPage

public void switchToPreviousPage(int idx,
 Enumeration tags,
 PAccountViewPage page)

Assumes the current tab's position; will either move up one level in the breadcrumb trail (back) or forward if the specified tag/page does not represent the page one level up (back).

Specified by:

switchToPreviousPage in interface PAccountViewContext

Parameters:

idx -

tags -

page -

getVisibleTemplate

public PPageTemplate getVisibleTemplate()

Description copied from interface: PAccountViewContext

Retrieves the encompassing template for the currently visible top-level page.

Specified by:

getVisibleTemplate in interface PAccountViewContext

Returns:

The currently visible template.

getPageTracker

public PPageTracker getPageTracker()

Description copied from interface: PAccountViewContext

Retrieves the class that manages the navigation stack (back button)

Specified by:

getPageTracker in interface PAccountViewContext

Returns:

The stack storing the pages; used for the back button.

getRefreshManager

public PRefreshManager getRefreshManager()

Description copied from interface: PAccountViewContext

Retrieves the class through which pages register for Refresh notification. Note that each active account view contains its own refresh manager instance, so an entity (Action) sitting outside the view (i.e. in a toolbar) will need to register each time an account is opened. At the same time, be sure not to register multiple times for the same view.

Specified by:

getRefreshManager in interface PAccountViewContext

Returns:

The data refresh manager instance.

addToView

public void addToView(PAccountViewPage sp)

Adds a page to this account view as a tab. The page being added must have been defined in the configuration file specification for this view or it will be ignored.

This is typically used in conjunction with a page that may or may not be valid for a given account context. A page that may have been omitted from the view by returning false in its isValidContext() method should use this method to add itself back.

Specified by:

addToView in interface PAccountViewContext

Parameters:

sp - the page to add as a tab

removeFromView

public void removeFromView(PAccountViewPage sp)

Locates the tab containing this top-level page and removes that tab.

This is typically used in conjunction with a page that may or may not be valid for a given account context. If your page suddenly goes out of context due to some event in the account, use this method to remove the tab associated with this page. Note that the specified page must be the top-level page on a tab.

Specified by:

removeFromView in interface PAccountViewContext

Parameters:

sp - the top-level page to remove from the view

isPartOfView

public boolean isPartOfView(PAccountViewPage sp)

Determines if this page is a visible tab.

Specified by:

isPartOfView in interface PAccountViewContext

Parameters:

sp - the page in question

Returns:

True if this page is currently a visible tab; false otherwise.

setSelectedIndex

public void setSelectedIndex(int idx)

Overrides:

setSelectedIndex in class JTabbedPane