org.formaria.swing.app
Class DockableFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.formaria.swing.docking.DockingPanel
                      org.formaria.swing.app.DockableFrame

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, ContentHolder

public class DockableFrame
extends DockingPanel
implements ContentHolder

A wrapper for a docking components. Represents a target window see http://www.javalobby.org/java/forums/t52990.html and https://flexdock.dev.java.net/

Copyright: Copyright (c) Formaria Ltd., 2008
License: see license.txt

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.formaria.swing.docking.DockingPanel

DockingPanel.DockableProxy

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

javax.swing.JPanel.AccessibleJPanel

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

Fields inherited from class org.formaria.swing.docking.DockingPanel

activeHeader, CLOSED, contentPane, defSize, headerPanel, listeners, MAXIMIZED, MINIMIZED, PREVIEW_CLOSED, PREVIEW_OPENED, RESTORED, splitPane, USE_REMOVE_STRATEGY

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

DockableFrame()
Creates a new instance of DockableFrame

Method Summary

java.awt.Component	add(java.awt.Component comp)
void	add(java.lang.Object comp, java.lang.Object constraint) Add a page to the container.
Dockable	findDockable(java.lang.Object c) Find the dockable containing the reference object
java.awt.Container	getActiveContent() Get the content of the active tab
java.lang.Object	getChildComponent(int i) Get a child component
DockingApp	getDockingApp()
java.awt.Dimension	getPreferredSize() Get the preferred size of the component.
boolean	isParentOf(java.awt.Component c) Is this component the parent of the child c
void	remove(java.lang.Object c) Remove a child component
void	setActivatePage(java.lang.Object ps) Find and activate/show the page referenced
void	setContent(java.lang.String pageName) Set the content for the component
void	setNextAttributes(java.lang.Object attribs) Set the attributes for the next component being added
void	setup(java.lang.String name, int preferredWidth, int preferredHeight, java.util.Hashtable params) Setup the container
void	zoomDockable(java.lang.Object c) Zoom in in a panel or dockable

Methods inherited from class org.formaria.swing.docking.DockingPanel

addDockable, addDockingPanelListener, dock, fireDockingPanelListeners, getConstraint, getContentPane, getTitle, removeDockable, removeDockable, removeDockingPanelListener, restoreContent, setActivateHeader, setBorderColor, setConstraint, setTitle

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, getRegisteredKeyStrokes, getRootPane, 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, 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, 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, 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

Methods inherited from interface org.formaria.aria.ContentHolder

doLayout, getName

Constructor Detail

DockableFrame

public DockableFrame()

Creates a new instance of DockableFrame

Method Detail

setContent

public void setContent(java.lang.String pageName)

Set the content for the component

Specified by:

setContent in interface ContentHolder

Parameters:

pageName - the new contents

setNextAttributes

public void setNextAttributes(java.lang.Object attribs)

Set the attributes for the next component being added

Specified by:

setNextAttributes in interface ContentHolder

Parameters:

attribs - a table of attributes

setup

public void setup(java.lang.String name,
                  int preferredWidth,
                  int preferredHeight,
                  java.util.Hashtable params)

Setup the container

Specified by:

setup in interface ContentHolder

Parameters:

name - set the container name

preferredWidth - the desired width

preferredHeight - the desired height

params - extra parameters for the target

• icon - the name of the icon file for the icon displayed in the docked panel's header
• title - the title of the docked panel
• sidebar - the id of the sidebar to which this panel docks
• constraint - the name of the region into which this component is docked, the region is managed by teh multisplitlayout
• minimized - true if the panel is initially minimized
• maximized - true if the panel is initially maximized
• canClose - false to prvent closing the dialog
• canDock - false to prevent docking
• canZoom - false to prevent maximization
• canMinimize - false to prevent minimization
• hasDockingTitle - true if a title is to be shown on the sidebar when the component is minimized, otherwise just the icon is shown if one is present
• clearState - true if the panel should clear the minimized/maximized state when a page is shown. If false the frame will maximize if an page is shown in the content area, and similarly for the minimized state. By default this value is true

getPreferredSize

public java.awt.Dimension getPreferredSize()

Description copied from class: DockingPanel

Get the preferred size of the component. The

Overrides:

getPreferredSize in class DockingPanel

Returns:

the size of the panel or 0x0 if the panel is docked

getChildComponent

public java.lang.Object getChildComponent(int i)

Get a child component

Specified by:

getChildComponent in interface ContentHolder

Parameters:

i - the index of the child within the container

Returns:

the child component

remove

public void remove(java.lang.Object c)

Remove a child component

Specified by:

remove in interface ContentHolder

Parameters:

c - the child component

add

public java.awt.Component add(java.awt.Component comp)

Overrides:

add in class java.awt.Container

add

public void add(java.lang.Object comp,
                java.lang.Object constraint)

Add a page to the container. Typically this method is called by the ApplicationContext during a showPage call. The method uses a hashtable of attributes passed to the PageManager as part of the showPage call. These attributes include:

• title - the title of the new page as displayed on the associated tab
• sidebar - the name of the sidebar into which this page docks
• icon - the file name of the icon displayed for this new page
• canMinimize - a flag controlling the minimization/docking of the page, true to show a minimize/dock icon and to allow minimization to the sidebar
• canClose - a flag controlling the closing of the page, true to allow the page to be closed
• canDock - a flag to control docking of the page, if false a minimized page will not be able to dock back into the application frame
• canDrag - a flag to control dragging of the pages, if false a page cannot be dragged from one target area to another
• hasDockingTitle - true to display a title when docked to the sidebar
• replace - true to replace the existing content of the target area
• state - the initial state of the new page (minimized|maximized)

Specified by:

add in interface ContentHolder

Parameters:

comp - the new page

constraint - the layout constraint for the new page

findDockable

public Dockable findDockable(java.lang.Object c)

Find the dockable containing the reference object

Parameters:

c - the docked component, header or panel.

zoomDockable

public void zoomDockable(java.lang.Object c)

Zoom in in a panel or dockable

Parameters:

c - the docked component, header or panel.

getDockingApp

public DockingApp getDockingApp()

isParentOf

public boolean isParentOf(java.awt.Component c)

Is this component the parent of the child c

Parameters:

c - the child to test

Returns:

true if this container is a parent of the component, otherwise false if the component belongs to some other heirarchy or does not participate in the hierarchy (if it isn't attached to a container)

setActivatePage

public void setActivatePage(java.lang.Object ps)

Find and activate/show the page referenced

Parameters:

ps - the page to activate

getActiveContent

public java.awt.Container getActiveContent()

Get the content of the active tab

Returns:

the active content