Skip navigation links

com.essbase.eas.ui.frame
Class CFrameDesktopPane

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JLayeredPane
javax.swing.JDesktopPane
com.essbase.eas.ui.frame.CFrameDesktopPane

All Implemented Interfaces:

CDesktopPane, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.InternalFrameListener, javax.swing.event.MenuListener

Direct Known Subclasses:

ConsoleDesktopPane

public class CFrameDesktopPane

extends javax.swing.JDesktopPane

implements javax.swing.event.InternalFrameListener, java.awt.event.ActionListener, javax.swing.event.MenuListener, CDesktopPane

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDesktopPane.AccessibleJDesktopPane

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

javax.swing.JLayeredPane.AccessibleJLayeredPane

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

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

javax.swing.AbstractAction	action
protected java.awt.Component	allItem
protected static int	ARRANGE_CASCADE
protected static int	ARRANGE_HORZ_TILED
protected static int	ARRANGE_ICONS
protected static int	ARRANGE_VERT_TILED
protected java.awt.Component[]	arrangeItems
protected static int	CLOSEALL_WINDOWS
protected CInternalFrame	m_activeFrame
protected CMenu	menu reference to the application's window menu.
protected java.awt.Component[]	numberedItems
protected java.awt.Component	separator
protected static int	WINDOWS_ALL
protected static int	WINDOWS_FIRST
protected static int	WINDOWS_LAST

Fields inherited from class javax.swing.JDesktopPane

LIVE_DRAG_MODE, OUTLINE_DRAG_MODE

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

CFrameDesktopPane()

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
boolean	activatefirstWindowForClass(java.lang.String className)
boolean	activateWindow(java.awt.Component component)
java.awt.Component	addFrame(CInternalFrame f) override of the Container.add() method.
void	allAction(CMenuDynamicHandler item)
void	arrangeAction(CMenuDynamicHandler item) arranges all of the iconized frames starting, positioning them in the lower left hand corner, moving to the right, and then up the desktop window.
void	cascadeAction(CMenuDynamicHandler item) cascades all non-iconified frame windows.
void	closeActiveWindow()
boolean	closeAll(boolean isExiting)
void	closeAllAction(CMenuDynamicHandler item)
void	dispose()
boolean	doesFrameExistFor(java.lang.Class c, java.lang.Object obj, boolean activate) looks for a frame of particular type and specific object.
void	emailActiveWindow()
void	ensureFrameActive(javax.swing.JInternalFrame f) ensures a particular frame is active and "normal"
protected void	focusNextFrame()
CInternalFrame	getActiveFrame()
CToolBar	getActiveToolbar()
protected CInternalFrame	getFrame(javax.swing.event.InternalFrameEvent e)
javax.swing.JInternalFrame	getFrameExistFor(java.lang.Class c, java.lang.Object obj, boolean activate) looks for a frame of particular type and specific object.
javax.swing.JInternalFrame[]	getFramesOfClass(java.lang.Class c) returns an array of internal frames that are of a specific class type.
boolean	hasModifiedFrames()
void	internalFrameActivated(javax.swing.event.InternalFrameEvent e)
void	internalFrameClosed(javax.swing.event.InternalFrameEvent e)
void	internalFrameClosing(javax.swing.event.InternalFrameEvent e)
void	internalFrameDeactivated(javax.swing.event.InternalFrameEvent e) implementation of the InternalFrameListener internalFrameDeactivated() method.
void	internalFrameDeiconified(javax.swing.event.InternalFrameEvent e) implementation of the InternalFrameListener internalFrameDeiconified() method.
void	internalFrameIconified(javax.swing.event.InternalFrameEvent e) implementation of the InternalFrameListener internalFrameIconified method.
void	internalFrameOpened(javax.swing.event.InternalFrameEvent e)
boolean	isActiveWindowClosable()
boolean	isActiveWindowEmailable()
boolean	isActiveWindowModified()
boolean	isActiveWindowPreviewable()
boolean	isActiveWindowPrintable()
boolean	isActiveWindowSaveable()
void	menuCanceled(javax.swing.event.MenuEvent e)
void	menuDeselected(javax.swing.event.MenuEvent e)
void	menuSelected(javax.swing.event.MenuEvent e)
void	numberedAction(CMenuDynamicHandler item)
protected void	populateMenu()
void	printActiveWindow()
void	printPriviewActiveWindow()
protected void	restoreFrame(javax.swing.JInternalFrame frame)
void	saveActiveWindow()
void	saveAsActiveWindow()
void	setWindowMenu(CMenu windowMenu)
void	tileAction(CMenuDynamicHandler item) arranges all non-iconified frame windows in tiling them.
void	tileVerticalAction(CMenuDynamicHandler item)
protected void	updateMenus(CInternalFrame frame)

Methods inherited from class javax.swing.JDesktopPane

addImpl, getAccessibleContext, getAllFrames, getAllFramesInLayer, getDesktopManager, getDragMode, getSelectedFrame, getUI, getUIClassID, paramString, remove, removeAll, selectFrame, setComponentZOrder, setDesktopManager, setDragMode, setSelectedFrame, setUI, updateUI

Methods inherited from class javax.swing.JLayeredPane

getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, putLayer, setLayer, setLayer, setPosition

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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

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, removeContainerListener, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ARRANGE_HORZ_TILED

protected static final int ARRANGE_HORZ_TILED

See Also:

Constant Field Values

ARRANGE_VERT_TILED

protected static final int ARRANGE_VERT_TILED

See Also:

Constant Field Values

ARRANGE_CASCADE

protected static final int ARRANGE_CASCADE

See Also:

Constant Field Values

ARRANGE_ICONS

protected static final int ARRANGE_ICONS

See Also:

Constant Field Values

CLOSEALL_WINDOWS

protected static final int CLOSEALL_WINDOWS

See Also:

Constant Field Values

WINDOWS_FIRST

protected static final int WINDOWS_FIRST

See Also:

Constant Field Values

WINDOWS_LAST

protected static final int WINDOWS_LAST

See Also:

Constant Field Values

WINDOWS_ALL

protected static final int WINDOWS_ALL

See Also:

Constant Field Values

m_activeFrame

protected CInternalFrame m_activeFrame

menu

protected CMenu menu

reference to the application's window menu. This should be set before any child window's are created. The desktop pane then controls and is responsible for maintaining this menu

arrangeItems

protected java.awt.Component[] arrangeItems

numberedItems

protected java.awt.Component[] numberedItems

separator

protected java.awt.Component separator

allItem

protected java.awt.Component allItem

action

public javax.swing.AbstractAction action

Constructor Detail

CFrameDesktopPane

public CFrameDesktopPane()

Method Detail

addFrame

public java.awt.Component addFrame(CInternalFrame f)

override of the Container.add() method. If the component being added is a JInternalFrame, it sets the position and size of the added component.

Specified by:

addFrame in interface CDesktopPane

internalFrameOpened

public void internalFrameOpened(javax.swing.event.InternalFrameEvent e)

Specified by:

internalFrameOpened in interface javax.swing.event.InternalFrameListener

internalFrameClosing

public void internalFrameClosing(javax.swing.event.InternalFrameEvent e)

Specified by:

internalFrameClosing in interface javax.swing.event.InternalFrameListener

internalFrameClosed

public void internalFrameClosed(javax.swing.event.InternalFrameEvent e)

Specified by:

internalFrameClosed in interface javax.swing.event.InternalFrameListener

internalFrameIconified

public void internalFrameIconified(javax.swing.event.InternalFrameEvent e)

implementation of the InternalFrameListener internalFrameIconified method.

Specified by:

internalFrameIconified in interface javax.swing.event.InternalFrameListener

internalFrameDeiconified

public void internalFrameDeiconified(javax.swing.event.InternalFrameEvent e)

implementation of the InternalFrameListener internalFrameDeiconified() method. Note: this is an empty method.

Specified by:

internalFrameDeiconified in interface javax.swing.event.InternalFrameListener

internalFrameActivated

public void internalFrameActivated(javax.swing.event.InternalFrameEvent e)

Specified by:

internalFrameActivated in interface javax.swing.event.InternalFrameListener

internalFrameDeactivated

public void internalFrameDeactivated(javax.swing.event.InternalFrameEvent e)

implementation of the InternalFrameListener internalFrameDeactivated() method. Note: this is an empty method.

Specified by:

internalFrameDeactivated in interface javax.swing.event.InternalFrameListener

updateMenus

protected void updateMenus(CInternalFrame frame)

setWindowMenu

public void setWindowMenu(CMenu windowMenu)

populateMenu

protected void populateMenu()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

menuSelected

public void menuSelected(javax.swing.event.MenuEvent e)

Specified by:

menuSelected in interface javax.swing.event.MenuListener

menuDeselected

public void menuDeselected(javax.swing.event.MenuEvent e)

Specified by:

menuDeselected in interface javax.swing.event.MenuListener

menuCanceled

public void menuCanceled(javax.swing.event.MenuEvent e)

Specified by:

menuCanceled in interface javax.swing.event.MenuListener

tileAction

public void tileAction(CMenuDynamicHandler item)

arranges all non-iconified frame windows in tiling them. If there are fewer than 4 windows, we arrange them to fit the width of the window and split the height evenly. If there are more than 3 windows, we start splitting each row into columns.

tileVerticalAction

public void tileVerticalAction(CMenuDynamicHandler item)

cascadeAction

public void cascadeAction(CMenuDynamicHandler item)

cascades all non-iconified frame windows.

closeAllAction

public void closeAllAction(CMenuDynamicHandler item)

arrangeAction

public void arrangeAction(CMenuDynamicHandler item)

arranges all of the iconized frames starting, positioning them in the lower left hand corner, moving to the right, and then up the desktop window.

numberedAction

public void numberedAction(CMenuDynamicHandler item)

allAction

public void allAction(CMenuDynamicHandler item)

activatefirstWindowForClass

public boolean activatefirstWindowForClass(java.lang.String className)

Specified by:

activatefirstWindowForClass in interface CDesktopPane

activateWindow

public boolean activateWindow(java.awt.Component component)

Specified by:

activateWindow in interface CDesktopPane

isActiveWindowClosable

public boolean isActiveWindowClosable()

Specified by:

isActiveWindowClosable in interface CDesktopPane

isActiveWindowPreviewable

public boolean isActiveWindowPreviewable()

Specified by:

isActiveWindowPreviewable in interface CDesktopPane

isActiveWindowPrintable

public boolean isActiveWindowPrintable()

Specified by:

isActiveWindowPrintable in interface CDesktopPane

isActiveWindowSaveable

public boolean isActiveWindowSaveable()

Specified by:

isActiveWindowSaveable in interface CDesktopPane

isActiveWindowModified

public boolean isActiveWindowModified()

Specified by:

isActiveWindowModified in interface CDesktopPane

isActiveWindowEmailable

public boolean isActiveWindowEmailable()

Specified by:

isActiveWindowEmailable in interface CDesktopPane

closeActiveWindow

public void closeActiveWindow()

Specified by:

closeActiveWindow in interface CDesktopPane

saveActiveWindow

public void saveActiveWindow()

saveAsActiveWindow

public void saveAsActiveWindow()

printPriviewActiveWindow

public void printPriviewActiveWindow()

printActiveWindow

public void printActiveWindow()

Specified by:

printActiveWindow in interface CDesktopPane

emailActiveWindow

public void emailActiveWindow()

Specified by:

emailActiveWindow in interface CDesktopPane

hasModifiedFrames

public boolean hasModifiedFrames()

closeAll

public boolean closeAll(boolean isExiting)

getFramesOfClass

public javax.swing.JInternalFrame[] getFramesOfClass(java.lang.Class c)

returns an array of internal frames that are of a specific class type.

Specified by:

getFramesOfClass in interface CDesktopPane

ensureFrameActive

public void ensureFrameActive(javax.swing.JInternalFrame f)

ensures a particular frame is active and "normal"

Specified by:

ensureFrameActive in interface CDesktopPane

doesFrameExistFor

public boolean doesFrameExistFor(java.lang.Class c,
                                 java.lang.Object obj,
                                 boolean activate)

looks for a frame of particular type and specific object. If found, optionally activates it and returns true/false based on frams's existance.

Specified by:

doesFrameExistFor in interface CDesktopPane

getFrameExistFor

public javax.swing.JInternalFrame getFrameExistFor(java.lang.Class c,
                                                   java.lang.Object obj,
                                                   boolean activate)

looks for a frame of particular type and specific object. If found, optionally activates it and returns the frame object.

Specified by:

getFrameExistFor in interface CDesktopPane

getFrame

protected CInternalFrame getFrame(javax.swing.event.InternalFrameEvent e)

getActiveToolbar

public CToolBar getActiveToolbar()

restoreFrame

protected void restoreFrame(javax.swing.JInternalFrame frame)
                     throws java.beans.PropertyVetoException

Throws:

java.beans.PropertyVetoException

focusNextFrame

protected void focusNextFrame()

getActiveFrame

public CInternalFrame getActiveFrame()

dispose

public void dispose()

Skip navigation links