Skip navigation links

com.essbase.eas.essbase.ui.outline
Class OutlineFrame

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JInternalFrame
com.essbase.eas.client.intf.CInternalFrame
com.essbase.eas.essbase.ui.windows.EInternalFrame
com.essbase.eas.essbase.ui.outline.OutlineFrame

All Implemented Interfaces:

SaveAsRequestor, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

EditorFrame, ViewerFrame

public abstract class OutlineFrame

extends EInternalFrame

extends the EInternalFrame class to handle outlines. Serves as a base class for the outline editor and outline viewer classes.

Since:

6.5.1

Version:

7.0.0

Author:

Hank Cox

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JInternalFrame.AccessibleJInternalFrame, javax.swing.JInternalFrame.JDesktopIcon

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

protected ButtonPanel	buttons
protected CloseButton	closeBtn
protected HelpButton	helpBtn
protected Representation	representation

Fields inherited from class com.essbase.eas.essbase.ui.windows.EInternalFrame

bundle

Fields inherited from class com.essbase.eas.client.intf.CInternalFrame

BOUNDS, bSaveBounds, cursor, dialogResult, disposed, frameIcon, helpAction, IS_TOOLBARSTATE_CHANGED, m_iCursor, m_toolbar, propertySupport, savedBounds

Fields inherited from class javax.swing.JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

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 javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

protected	OutlineFrame(java.lang.String titleKey, java.lang.String helpKey, Database db, Identifier ident, boolean editor)
protected	OutlineFrame(java.lang.String titleKey, java.lang.String helpKey, java.io.File f, Identifier ident, boolean editor)

Method Summary

void	addFrameListener(OutlineFrameListener l)
void	dispose()
Representation	getRepresentation() returns the outline representation object for this frame.
protected abstract java.lang.String	getTitleKey() abstract virtual function used by derived classes to provide a title key.
protected boolean	isPrintAll()
protected boolean	isPrintOutlineOnly()
boolean	isThisYou(java.lang.Object obj) implementation of the CInternalFrame.isThisYou() method.
static OutlineFrame	locateFrameAncestor(java.awt.Component start) walks up a container chain looking for an instance of a ViewerFrame object.
void	printPriviewWindow()
void	printWindow()
void	removeFrameListener(OutlineFrameListener l)
protected void	setRepresentation(Representation value) sets the outline representation object for this frame.
void	sourceDisconnecting() called by an ESourceAdapter when the source object is disconnecting.
void	sourceRenamed() called by an ESourceAdapter when the source object has been renamed.
protected void	updateTitle(java.lang.String titleKey) used to update the title of this frame when necessary.

Methods inherited from class com.essbase.eas.essbase.ui.windows.EInternalFrame

frameClosed, getBundleClass, getUserObject, objectAdded, objectModified, objectRemoved, saveAsObject, setUserObject, sourceConnected, sourceDisconnected, sourceRemoved

Methods inherited from class com.essbase.eas.client.intf.CInternalFrame

addPropertyChangeListener, addPropertyChangeListener, addToDesktop, emailWindow, fireStateChanged, frameActivated, frameClosing, frameDeactivated, frameDeiconified, frameIconified, frameOpened, getFrameMenus, getObjectsToEmail, getPrintMenuText, getPrintTip, getSaveAsMenuText, getSaveMenuText, getSaveTip, getToolbar, initExtraComponents, initSaveAsDialogComponents, isEmailable, isExiting, isModified, isPreviewable, isPrintable, isSaveable, jbInit, processEvent, removePropertyChangeListener, saveAsWindow, saveBounds, saveOnClosing, saveWindow, setCursor, setExiting, setFocusComponent, setReadBounds, setSaveBounds, setTitle, startPrinting, toString

Methods inherited from class javax.swing.JInternalFrame

addImpl, addInternalFrameListener, createRootPane, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setUI, show, toBack, toFront, 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

representation

protected Representation representation

closeBtn

protected CloseButton closeBtn

helpBtn

protected HelpButton helpBtn

buttons

protected ButtonPanel buttons

Constructor Detail

OutlineFrame

protected OutlineFrame(java.lang.String titleKey,
                       java.lang.String helpKey,
                       Database db,
                       Identifier ident,
                       boolean editor)

OutlineFrame

protected OutlineFrame(java.lang.String titleKey,
                       java.lang.String helpKey,
                       java.io.File f,
                       Identifier ident,
                       boolean editor)

Method Detail

getTitleKey

protected abstract java.lang.String getTitleKey()

abstract virtual function used by derived classes to provide a title key.

updateTitle

protected void updateTitle(java.lang.String titleKey)

used to update the title of this frame when necessary.

Parameters:

titleKey - - key for the resource bundle string.

isThisYou

public boolean isThisYou(java.lang.Object obj)

implementation of the CInternalFrame.isThisYou() method. Checks to see if the object is the same as the database object.

Overrides:

isThisYou in class EInternalFrame

sourceRenamed

public void sourceRenamed()

called by an ESourceAdapter when the source object has been renamed. Derived classes should override this method in order properly handle this event.

Overrides:

sourceRenamed in class EInternalFrame

addFrameListener

public void addFrameListener(OutlineFrameListener l)

removeFrameListener

public void removeFrameListener(OutlineFrameListener l)

locateFrameAncestor

public static OutlineFrame locateFrameAncestor(java.awt.Component start)

walks up a container chain looking for an instance of a ViewerFrame object. Returns this object if one is found; returns NULL if one isn't found.

getRepresentation

public Representation getRepresentation()

returns the outline representation object for this frame.

setRepresentation

protected void setRepresentation(Representation value)

sets the outline representation object for this frame.

printPriviewWindow

public void printPriviewWindow()

Overrides:

printPriviewWindow in class CInternalFrame

printWindow

public void printWindow()

Overrides:

printWindow in class CInternalFrame

isPrintAll

protected boolean isPrintAll()

sourceDisconnecting

public void sourceDisconnecting()

Description copied from class: EInternalFrame

called by an ESourceAdapter when the source object is disconnecting. Derived classes should override this method in order properly handle this event.

Overrides:

sourceDisconnecting in class EInternalFrame

dispose

public void dispose()

Overrides:

dispose in class EInternalFrame

isPrintOutlineOnly

protected boolean isPrintOutlineOnly()

Skip navigation links