Skip to end of metadata
Go to start of metadata

Description

DockingFrames is an open source Java Swing docking framework that allows you to work with dockable frames.

Installation

The current version of griffon-docking-frame-plugin is 0.4
To install just issue the following command

Usage of the original version as below:

A full demo is available on peron's GitHub.

With 0.4 full support of the commons-library is available

The following nodes will become available on a View script upon installing this plugin.
For all nodes, the id attribute is used as uid where appropriate.
If a node is a child of dockingArea, contentArea, gridArea and workingArea the attribute constraints will be used as an id for a dynamically created dockable.

Node (Type)

Property

Type

Default

Required

Bindable

Notes

dockingControl (CControl)

groupBehaviour

String or CGroupBehavior

 

(error)

 

 

 

language

Locale

 

(error)

 

 

 

maximizeArea

String

 

(error)

 

id of the area

 

missingPerspectiveStrategy

MissingPerspectiveStrategy

 

(error)

 

 

 

missingStrategy

MissingCDockableStrategy

 

(error)

 

 

 

preferenceModel

PreferenceModel

 

(error)

 

 

 

revertToBasicModes

boolean

 

(error)

 

 

 

theme

String

 

(error)

 

basic, bubble, eclipse, flat, smooth

dockingArea (CContentArea)

all as javax.swing.JPanel

 

 

 

 

 

 

control

CControlAccess

 

(error)

 

 

 

minimumAreaSize

List or Dimension

 

(error)

 

 

 

perspective

String

'default'

(error)

 

name of the perspective

contentArea (CContentArea)

all as javax.swing.JPanel

 

 

 

 

 

 

control

CControlAccess

 

(error)

 

 

 

minimumAreaSize

List or Dimension

 

(error)

 

 

 

perspective

String

'default'

(error)

 

name of the perspective

minimizeArea (CMinimizeArea)

all as javax.swing.JPanel

 

 

 

 

 

 

control

CControlAccess

 

(error)

 

 

 

direction

String

 

(error)

 

auto, north, south, east, west

gridArea (CGridArea)

 

 

 

 

 

 

 

control

CControlAccess

 

(error)

 

 

 

focusComponent

Component

 

(error)

 

 

 

maximizingArea

boolean

 

(error)

 

 

 

minimizedHold

boolean

 

(error)

 

 

 

minimizedHoldSwitchable

boolean

 

(error)

 

 

 

minimizedSize

List or Dimension

 

(error)

 

 

 

resizeLocked

boolean

 

(error)

 

 

 

resizeLockedHorizontally

boolean

 

(error)

 

 

 

resizeLockedVertically

boolean

 

(error)

 

 

 

singleTabShown

boolean

 

(error)

 

 

 

titleIcon

Icon

 

(error)

 

 

 

titleShown

boolean

 

(error)

 

 

 

titleText

String

 

(error)

 

 

 

visible

boolean

 

(error)

 

 

 

workingArea

CStation

 

(error)

 

 

workingArea (CWorkingArea)

 

 

 

 

 

 

 

control

CControlAccess

 

(error)

 

 

 

focusComponent

Component

 

(error)

 

 

 

maximizingArea

boolean

 

(error)

 

 

 

minimizedHold

boolean

 

(error)

 

 

 

minimizedHoldSwitchable

boolean

 

(error)

 

 

 

minimizedSize

List or Dimension

 

(error)

 

 

 

resizeLocked

boolean

 

(error)

 

 

 

resizeLockedHorizontally

boolean

 

(error)

 

 

 

resizeLockedVertically

boolean

 

(error)

 

 

 

singleTabShown

boolean

 

(error)

 

 

 

titleIcon

Icon

 

(error)

 

 

 

titleShown

boolean

 

(error)

 

 

 

titleText

String

 

(error)

 

 

 

visible

boolean

 

(error)

 

 

 

workingArea

CStation

 

(error)

 

 

dockable (DefaultSingleCDockable)

 

 

 

 

 

 

 

closeable

boolean

 

(error)

 

 

 

control

CControlAccess

 

(error)

 

 

 

externalizable

boolean

 

(error)

 

 

 

focusComponent

Component

 

(error)

 

 

 

layout

LayoutManager

 

(error)

 

 

 

maximizable

boolean

 

(error)

 

 

 

minimizable

boolean

 

(error)

 

 

 

minimizedHold

boolean

 

(error)

 

 

 

minimizedHoldSwitchable

boolean

 

(error)

 

 

 

minimizedSize

List or Dimension

 

(error)

 

 

 

resizeLocked

boolean

 

(error)

 

 

 

resizeLockedHorizontally

boolean

 

(error)

 

 

 

resizeLockedVertically

boolean

 

(error)

 

 

 

singleTabShown

boolean

 

(error)

 

 

 

stackable

boolean

 

(error)

 

 

 

titleIcon

Icon

 

(error)

 

 

 

titleShown

boolean

 

(error)

 

 

 

titleText

String

 

(error)

 

 

 

titleToolTip

String

 

(error)

 

 

 

visible

boolean

 

(error)

 

 

 

workingArea

CStation

 

(error)

 

 

dockableFactory (SingleCDockableFactory)

filter

bibliothek.util.Filter or String or String[] or Collection<String>

(error)

 

 

 

 

data

Map

 

(error)

 

a map containing uid-SingleCDockable-pairs or uid-Closure-pairs creating a SingleCDockable

mvcGroupFactory (SingleCDockableFactory)

filter

bibliothek.util.Filter or String or String[] or Collection<String>

(error)

 

 

dynamically creating SingleCDockables from mvcGroups reffered by their mvcName

multiFactory (MultipleCDockable)

value

MultipleCDockable

(tick)

 

 

Just a wrapper around a given MultipleCDockable as value

placeholder (SingleCDockablePerspective)

 

 

(error)

 

 

 

multiPlaceholder (MultipleCDockablePerspective)

factory

String

(tick)

 

 

factory id

 

layout

MultipleCDockableLayout

(tick)

 

 

 

rootMenuPiece (RootMenuPiece)

all as javax.swing.JMenu

 

(error)

 

 

 

 

disableWhenEmpty

boolean

(error)

 

 

 

subMenuPiece (RootMenuPiece)

all as javax.swing.JMenu

 

(error)

 

 

 

 

disableWhenEmpty

boolean

(error)

 

 

 

nodeMenuPiece (NodeMenuPiece)

 

 

 

 

 

 

separatingMenuPiece (SeparatingMenuPiece)

 

 

 

 

 

 

 

bottomSeparator

boolean

(error)

 

 

 

 

emptySeparator

boolean

(error)

 

 

 

 

topSeparator

boolean

(error)

 

 

 

menuPiece (MenuPiece)

value

MenuPiece

(tick)

 

 

 

dockableListMenuPiece (SingleCDockableListMenuPiece)

control

CControlAccess

 

(error)

 

 

themeMenuPiece (CThemeMenuPiece)

control

CControlAccess

 

(error)

 

 

 

themes

ThemeMap

(error)

 

 

 

 

transferTheme

boolean

(error)

 

 

 

preferenceMenuPiece (CPreferenceMenuPiece)

control

CControlAccess

 

(error)

 

 

 

model

PreferenceModel

(error)

 

 

 

lookAndFeelMenuPiece (CLookAndFeelMenuPiece)

control

CControlAccess

 

(error)

 

 

layoutMenuPiece (CLayoutChoiceMenuPiece)

control

CControlAccess

 

(error)

 

 

 

submenu

boolean

(error)

 

 

List of layouts as submenu

dockingAction (CAction) value

CAction

(tick)

 

 

 

blankAction (CBlank)

 

 

 

 

 

 

buttonAction (CButton)

accelerator

String or KeyStroke

 

 

 

 

 

disabledIcon

Icon

(error)

 

 

 

 

dropDownSelectable

boolean

(error)

 

 

 

 

dropDownTriggerableNotSelected

boolean

(error)

 

 

 

 

dropDownTriggerableSelected

boolean

(error)

 

 

 

 

enabled

boolean

(error)

 

 

 

 

icon

Icon

(error)

 

 

 

 

text

String

(error)

 

 

 

 

tooltip

String

(error)

 

 

 

 

closure

Closure

(error)

 

 

triggered when clicked

 

listener

ActionListener

(error)

 

 

 

checkBoxAction (CCheckBox)

accelerator

String or KeyStroke

 

 

 

 

 

disabledIcon

Icon

(error)

 

 

 

 

dropDownSelectable

boolean

(error)

 

 

 

 

dropDownTriggerableNotSelected

boolean

(error)

 

 

 

 

dropDownTriggerableSelected

boolean

(error)

 

 

 

 

enabled

boolean

(error)

 

 

 

 

icon

Icon

(error)

 

 

 

 

text

String

(error)

 

 

 

 

tooltip

String

(error)

 

 

 

 

closure

Closure

(error)

 

 

triggered when changed

dropDownButtonAction (CCheckBox)

accelerator

String or KeyStroke

 

 

 

 

 

disabledIcon

Icon

(error)

 

 

 

 

dropDownSelectable

boolean

(error)

 

 

 

 

dropDownTriggerableNotSelected

boolean

(error)

 

 

 

 

dropDownTriggerableSelected

boolean

(error)

 

 

 

 

enabled

boolean

(error)

 

 

 

 

icon

Icon

(error)

 

 

 

 

text

String

(error)

 

 

 

 

tooltip

String

(error)

 

 

 

menuAction (CMenu)

accelerator

String or KeyStroke

 

 

 

 

 

disabledIcon

Icon

(error)

 

 

 

 

dropDownSelectable

boolean

(error)

 

 

 

 

dropDownTriggerableNotSelected

boolean

(error)

 

 

 

 

dropDownTriggerableSelected

boolean

(error)

 

 

 

 

enabled

boolean

(error)

 

 

 

 

icon

Icon

(error)

 

 

 

 

text

String

(error)

 

 

 

 

tooltip

String

(error)

 

 

 

popupAction (CPanelPopup)

accelerator

String or KeyStroke

 

 

 

 

 

disabledIcon

Icon

(error)

 

 

 

 

dropDownSelectable

boolean

(error)

 

 

 

 

dropDownTriggerableNotSelected

boolean

(error)

 

 

 

 

dropDownTriggerableSelected

boolean

(error)

 

 

 

 

enabled

boolean

(error)

 

 

 

 

icon

Icon

(error)

 

 

 

 

text

String

(error)

 

 

 

 

tooltip

String

(error)

 

 

 

 

buttonBehavior

String or ButtonBehavior

(error)

 

 

 

 

closeOnFocusLost

boolean

(error)

 

 

 

 

content

JComponent

(error)

 

 

 

 

menuBehavior

String or MenuBehavior

(error)

 

 

 

radioButtonAction (CRadioButton)

accelerator

String or KeyStroke

 

 

 

 

 

disabledIcon

Icon

(error)

 

 

 

 

dropDownSelectable

boolean

(error)

 

 

 

 

dropDownTriggerableNotSelected

boolean

(error)

 

 

 

 

dropDownTriggerableSelected

boolean

(error)

 

 

 

 

enabled

boolean

(error)

 

 

 

 

icon

Icon

(error)

 

 

 

 

text

String

(error)

 

 

 

 

tooltip

String

(error)

 

 

 

 

closure

Closure

(error)

 

 

triggered when changed

 

group

String or CRadioGroup

(error)

 

 

 

separatorAction (CSeparator)

type

String

 

 

 

'', 'menu' or 'title'

systemAction (CAction)

name

String

 

 

 

minimize, maximize, normalize, externalize, unexternalize, unmaximize_externalized, close, hold

 

replacement

CAction

(error)

 

 

 

The nodes that are children of dockingArea, contentArea, gridArea and workingArea the following properties are valid:

Property

Type

Default

Required

Bindable

Notes

dock

Collection or CContentArea or CGridArea

0.0, 0.0, 1.0, 1.0

(error)

 

Collection in a form of x, y, w, h

dockMinimized

String or CMinimizedArea

 

(error)

 

north, south, east, west

dockExternalized

Collection

 

(error)

 

in a form of []

dockState

String or ExtendedMode

 

(error)

 

minimized, maximized, normalized, externalized

The nodes that are children of dropDownButtonAction the following properties are valid:

Property

Type

Default

Required

Bindable

Notes

selection

boolean

 

(error)

 

 

Example

History

Version

Date

Notes

0.4

08-01-11

DockingFrame Version 1.1.1p4a with commons-support

0.3

02-24-11

Release sync with Griffon 0.9.2

0.2

07-23-10

Release sync with Griffon 0.9

0.1

05-31-10

Initial release

The Docking Frames Plugin was originally created by the Hackergarten programming group, at the Canoo Engineering AG world headquarters in Basel Switzerland.
Enhanced for commons-support by Alexander Klein.

  • No labels