From f55c00c15278eb7d2387b9fa865cad02d48d167e Mon Sep 17 00:00:00 2001 From: Andrew Auclair Date: Fri, 22 Dec 2023 18:47:36 -0500 Subject: [PATCH] More documentation. --- Writerside/topics/Dockable-Interface.md | 40 ++++++++++++++++++------- 1 file changed, 29 insertions(+), 11 deletions(-) diff --git a/Writerside/topics/Dockable-Interface.md b/Writerside/topics/Dockable-Interface.md index de8739cb..c85d271b 100644 --- a/Writerside/topics/Dockable-Interface.md +++ b/Writerside/topics/Dockable-Interface.md @@ -37,15 +37,20 @@ if it wishes to change the default. -### getTabTooltip + +

Used by the framework to get the text to display as a tooltip on JTabbedPane tabs.

+

Default value is null

+

Used by the framework to get the icon for the dockable to use in a `JTabbedPane` tab.

Default value is null

-### isFloatingAllowed - + +

Used by the framework to decided whether the dockable component is allowed to be opened in its own window

+

Default value is true

+
Allows the application to specify whether a dockable can be dragged out of its current window and floated on its own as a new window. @@ -54,11 +59,15 @@ Allows the application to specify whether a dockable can be dragged out of its c

Default value is false

+ +

+

Default value is DockableStyle.BOTH

+
-### getStyle - -### getPinningStyle - + +

+

Default value is DockableStyle.BOTH

+
to be renamed @@ -77,12 +86,21 @@ to be renamed

Default value is false

-### getHasMoreOptions - -### getTabPosition + +boolean getHasMoreOptions() +

+
-### addMoreOptions + +int getTabPosition() +

+

Default value is SwingConstants.BOTTOM

+
+ +void addMoreOptions(JPopupMenu menu) +

+
### createHeaderUI ### updateProperties