<questionid="arch-what"> Whatisthisprojectgoodfor? <hint> Pleaseprovideherefewlinesdescribingthetheproject, whatproblemitshouldsolve,providelinkstodocumentation, specifications,etc. </hint> </question>
-->
<answer id="arch-what">
Window System API is used to display and control application GUI: Main window,
frames, components.
</answer>
<usecase id="windowsystem-settings-for-topcomponent" name="How to create a '.settings' file for a TopComponent?" >
Either write it by hand (not that hard if you copy other file and
tweak it to match your TC), or start the IDE, instantiate the TC
somehow (You have a "Window->Show My TC", right? ),
copy the file that gets created in $userdir/config/Windows2Local/Component
and cleanup the serialdata section - replace it with proper "<instance class='..." /> tag.
</usecase>
<usecase id="windowsystem-groups" name="How to make a TopComponentGroup?" >
<p></p>
<b>Q:</b> I'm trying to make a TopComponentGroup. I've just read https://netbeans.apache.org/projects/ui/ws/ws_spec#s39
I want to make a group that uses the first invocation strategy.
That is, I want the group to open/close when I activate a certain subclass of TopComponent.
Say, for example, I have a FooTopComponent, and when it's active,
I want to open a FooPropertySheetComponent, docked in a mode on the right-hand side.
I know I have to:
<ol>
<li>declare the group in the layer file (Windows2/Groups)</li>
<li>have code for opening the group</li>
<li>have code for closing the group</li>
</ol>
I think I do #2 in FooTopComponent.componentActivated() and #3 in
FooTopComponent.componentDeactivated(). Is that right?
<p></p>
<b>A:</b>Yes it is correct way. You can check
<a href="http://source.apidesign.org/hg/netbeans/misc/file/tip/platform/samples/window-system-groups">simple test module</a>.
First you must get TopComponentGroup instance using find method then call TopComponentGroup.open()/close().
Here is the code in your componentDeactivated method:
<pre>
protected void componentDeactivated ()
{
// close window group containing propsheet, but only if we're
// selecting a different kind of TC in the same mode
boolean closeGroup = true;
Mode curMode = WindowManager.getDefault().findMode(this);
TopComponent selected = curMode.getSelectedTopComponent();
if (selected != null && selected instanceof FooTopComponent)
closeGroup = false;
if (closeGroup)
{
TopComponentGroup group = WindowManager.getDefault().findTopComponentGroup(TC_GROUP);
if (group != null)
{
group.close();
}
}
}
</pre>
</usecase>
</answer>
<!-- <questionid="perf-spi"when="init"> Howtheperformanceofthepluggedincodewillbeenforced? <hint> Ifyouallowforeigncodetobepluggedintoyourownmodule,how doyouenforce,thatitwillbehavecorrectlyandfastandwillnot negativelyinfluencetheperformanceofyourownmodule? </hint> </question>
-->
<answer id="perf-spi">
There cannot be enforced the performance quality of <code>TopComponent</code> implementation, just could be provided performance
test which could indicate some specific <code>TopComponent</code> instance doesn't fullfil certain performance criteria.
</answer>
<questionid="compat-standards"> Doesthemoduleimplementsordefinesanystandards?Isthe implementationexactoritdeviatessomehow? </question>
-->
<answer id="compat-standards">
It follows JLF standard for the custom UI components provided by core implementation.
</answer>
<!-- Question: compat-version
<questionid="compat-version"> Doesyourmoduleproperlycoexistswithearlierandfuture versions?Canyoucorrectlyreadsettings?Willfuture versionsbeabletoreadsettings? <hint> Veryhelpfulforreadingsettingsistostoreversionnumber there,sofutureversionscandecidewhetherhowtoread/convert thesettingsandolderversionscanignorethenewones. </hint> </question>
-->
<answer id="compat-version">
Yes. Module stores its own versioned settings as XML files. In addition
components are stored in settings file format of core/settings module.
For description of current (version2.0) configuration data folders see
<api group="layer" category="devel" name="NewConfigurationData"type="export"url="https://netbeans.apache.org/projects/platform/core/windowsystem/changes#s342" >
new configuration data</api> here
For description of old (version < 2.0) configuration data folders and how they are imported
to new desktop layout see
<api group="layer" category="deprecated" name="OldConfigurationData"type="export"url="https://netbeans.apache.org/projects/platform/core/windowsystem/changes#s346" >
old configuration data </api>
</answer>
<!-- Question: dep-jre
<questionid="dep-jre"> WhichversionofJREyouneed(1.2,1.3,1.4,etc.)? <hint> Itisexpectedthatifyourmodulerunson1.xthatitwillrun on1.x+1ifno,statethatplease.Alsodescribeherecaseswhere yourundifferentcodeondifferentversionsofJREandwhy. </hint> </question>
-->
<answer id="dep-jre">
It runs on JRE 1.4.
</answer>
<!-- Question: dep-jrejdk
<questionid="dep-jrejdk"> DoyourequireJDKorisJREenough? </question>
-->
<answer id="dep-jrejdk">
JRE is enough.
</answer>
<questionid="dep-non-nb"> Whatothernon-NetBeansprojectsthisonedependson? <hint> Somenon-NetBeansprojectsarepackagedasNetBeansmodules (see<ahref="http://libs.netbeans.org">libraries</a>)and itispreferedtousethisapproachwhenmoremodulesmay dependonsuchthird-partylibrary. </hint> </question>
-->
<answer id="dep-non-nb">
SAX parser is used to parse settings files.
</answer>
<!-- Question: dep-platform
<questionid="dep-platform"> Onwhichplatformsyourmodulerun?Any?Doesitruninthesame way? <hint> IfyourmoduleisusingJNIordealswithspecialdifferencesof OSeslikefilesystems,etc.pleasedescribeherewhattheyare. </hint> </question>
-->
<answer id="dep-platform"> 100% pure Java. Runs anywhere. Swing is used for GUI display.
</answer>
<!-- Question: deploy-jar
<questionid="deploy-jar"> DoyoudeployjustmoduleJARfile(s)orsomeotherfiles? <hint> IfyourmoduleconsistjustfromonemoduleJARfile,justconfirmthat. IfitusesmorethanoneJAR,describewheretherearelocated,how theyrefertoeachother. IfitconsistofmoduleJAR(s)andotherfiles,pleasedescribe whatistheirpurpose,whyotherfilesarenecessary.Please makesurethatinstallation/deinstallationleavesthesystem instateasitwasbeforeinstallation. </hint> </question>
-->
<answer id="deploy-jar">
Module API is part of openide.jar, implementation is mostly in core-windows.jar. Module
API also contains dummy implementation usable for tests.
</answer>
<!-- Question: deploy-nbm
<questionid="deploy-nbm"> CanyoudeployNBMviaAutoUpdatecenter? <hint> Ifnotwhy? </hint> </question>
-->
<answer id="deploy-nbm">
Whole openide.jar and core-windows.jar can be deployed via AU center.
</answer>
<!-- Question: deploy-packages
<questionid="deploy-packages"> Arepackagesofyourmodulemadeinaccessiblebynotdeclaringthem public? <hint> NetBeansmodulesystemallowsrestrictionofaccessrightsto publicclassesofyourmodulefromothermodules.Thisprevents unwanteddependenciesofothersonyourcodeandshouldbeused wheneverpossible(<ahref="http://www.netbeans.org/download/apis/org/openide/doc-files/upgrade.html#3.4-public-packages"> publicpackages </a>). </hint> </question>
-->
<answer id="deploy-packages">
No. Window System API contains
<api group="java" name="WindowSystemAPI"type="export" category="official"url="@TOP@/org/openide/windows/doc-files/api.html"/>.
Some parts of core can use semi-private API <api group="java" name="WindowSystemImplementationAPI"type="export" category="friend"/>.
</answer>
<!-- Question: deploy-shared
<questionid="deploy-shared"> Doyouneedtobeinstalledinsharedlocationoronlyinuserdirectory? <hint> Installationlocationshallnotmatter,ifitdoesexplainwhy. </hint> </question>
-->
<answer id="deploy-shared">
openide.jar and core-windows.jar needs to be in the system directory.
</answer>
<answer id="deploy-dependencies">
You might use <code>OpenIDE-Module-Requires: org.openide.windows.WindowManager</code>
but it is not generally done.
</answer>
<questionid="exec-component"> Isexecutionofyourcodeinfluencedby(string)property ofanyofyourcomponents? <hint> Often<code>JComponent.getClientProperty</code>,<code>Action.getValue</code> or<code>PropertyDescriptor.getValue</code>,etc.areusedtoinfluence abehaviourofsomecode.Thisofcourseformsaninterfacethatshould bedocumented.Alsoifonedependsonsomeinterfacethatanobject implements(<code>componentinstanceofRunnable</code>)thatformsan APIaswell. </hint> </question>
-->
<answer id="exec-component">
Yes. Component can control its persistence and way how they are displayed in container.
<api type="export" group="property" name="KeepNonPersistentTCInModelWhenClosed" category="private">
Client property "KeepNonPersistentTCInModelWhenClosed" of TopComponent controls behavior of winsys
when TopComponent with persistence type"Never" or "OnlyOpened" is closed. As some TopComponent wants
to keep their position in winsys ie. be able to reopen at the same place and some TopComponent wants
to be removed from winsys model.
If property is not set nonpersistent TopComponent is removed from model when closed - it is original
behavior before fix of issue #101700.
If property is set (to Boolean.TRUE) then TopComponent is kept in model. It means that
client must explicitly set this client property to get behavior requested by issue #101700.
</api>
<api type="export" group="property" name="netbeans.winsys.tc.activate_at_startup" category="private">
Name of TopComponent's Boolean client property which instructs the window system to activate
the given TopComponent at startup time regardless which TopComponent was active at
shutdown time. So it's usuable for welcome screen-like behavior.
If more than one TopComponent has this property set to Boolean.TRUE then
an arbitrary one will be selected and activated.
</api>
<api type="export" group="property" name="TopComponentAllowDockAnywhere" category="private">
Name of client property (of Boolean type) which says whether the TopComponent is allowed
to be docked anywhere (even crossing view-editor border).
</api>
<api type="export" group="property" name="netbeans.winsys.tc.keep_preferred_size_when_slided_in" category="stable">
Name of TopComponent's Boolean client property which forces the window system
to respect TopComponent's preferred size when it is slided-in from left/right/bottom
sliding bar when set to Boolean.TRUE. Otherwise the slided-in TopComponent
will fill the entire width/length of the IDE window (the default behavior).
This switch is intended for tools/palette windows like e.g. color chooser,
tool picker etc.
</api>
<api type="export" group="property" name="netbeans.winsys.tc.closing_disabled" category="stable">
Name of TopComponent's Boolean client property which removes close button
from TopComponent's header and disables its 'Close Window' action when set to Boolean.TRUE.
</api>
<api type="export" group="property" name="netbeans.winsys.tc.sliding_disabled" category="stable">
Name of TopComponent's Boolean client property which removes 'minimized' button
from TopComponent's header and disables its 'Minimize Window' action when
set to Boolean.TRUE. TopComponents which are already slided-out and have this
property set to Boolean.TRUE will have 'pin' button removed from their header
and their 'Minimize Window' action will be disabled.
</api>
<api type="export" group="property" name="netbeans.winsys.tc.undocking_disabled" category="stable">
Name of TopComponent's Boolean client property which disables TopComponent's 'Undock Window' action when set to Boolean.TRUE. TopComponents which are already
floating and have this property set to Boolean.TRUE will have their 'Dock Window' action disabled.
</api>
<api type="export" group="property" name="netbeans.winsys.tc.dragging_disabled" category="stable">
Name of TopComponent's Boolean client property which disables drag and drop
when set to Boolean.TRUE.
</api>
<api type="export" group="property" name="netbeans.winsys.tc.maximization_disabled" category="stable">
Name of TopComponent's Boolean client property which disables TopComponent
maximization by double-clicking its header when set to Boolean.TRUE. TopComponent's 'Maximize Window' action will be also disabled.
</api>
<api type="export" group="property" name="netbeans.winsys.tc.draganddrop_copy_disabled" category="stable">
Name of TopComponent's Boolean client property which disables 'copy' drag and drop action
of a TopComponent when set to Boolean.TRUE.
</api>
<!--<api group="property" name="NamingType" type="export" category="private"> Validvaluesare"BothOnlyCompName","SDIOnlyCompName","MDIOnlyCompName". Defaultis""(emptystring).Thispropertycontrolshowwindow(frame)titleisconstructed fromModenameandTopComponentname. Bydefaultframetitleis{Modedisplayname}[{TopComponentname}]. "BothOnlyCompName"meansthatonly{TopComponentname}isdisplayedforbothMDIandSDImode. "SDIOnlyCompName","MDIOnlyCompName"arethesame"BothOnlyCompName"butonlyinSDIorMDImode. ItisclientpropertyofTopComponent.Usageexample:TodisplayonlyTopComponentnameintitle ofwindowbothinMDIandSDImodeuse<code>putClientProperty("NamingType","BothOnlyCompName");</code> ininitializationcodeofTopComponenteg.inconstructor. </api> <apigroup="property"name="TabPolicy"type="export"category="private"> Validvalueis"HideWhenAlone".JTabbedPaneisusedwithtabs.Whenthisproperty issetandTopComponentisaloneingivenpaneJTabbedPaneisnotusedie.tabisnot displayed.ItisusedtosavespaceandtoavoidconfusionwhenTopComponentusesits owntabsanditisusualyalone.OfcoursewhenthereismorethanoneTopComponentin onepaneJTabbedPaneisusedandtabsaredisplayed. Defaultis""(emptystring).Insuchcasetabisdisplayedalways. ItisclientpropertyofTopComponent.Usageexample:TodisabletabwhenTopComponent isaloneincontaineruse<code>putClientProperty("TabPolicy","HideWhenAlone");</code>ininitialization codeofTopComponenteg.inconstructor.
</api>-->
<api group="property" name="OpenIDE-Transmodal-Action"type="export" category="friend">
<p>
An <code>Action</code> with the property <code>OpenIDE-Transmodal-Action</code> set to
<code>Boolean.TRUE</code> should function on all focused components. This includes the Main
Window, dialogs, popup menus, etc. Otherwise only the Main Window and <code>TopComponent</code>s
will receive the keystroke.
</p>
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.TopComponent.DragAndDrop.Enabled" category="stable">
Name of resource bundle property which disables the drag and drop of window
TopComponents when its value is set to <code>false</code>, the default value is <code>true</code>.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.TopComponent.DragAndDrop.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.TopComponent.Undocking.Enabled" category="stable">
Name of resource bundle property which disables undocking of window
TopComponents when its value is set to <code>false</code>, the default value is <code>true</code>.
When this feature is disabled then there is no 'Undock' item in TopComponent popup menu
and 'Undock Window' action the main menu is disabled.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.TopComponent.Undocking.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.TopComponent.Sliding.Enabled" category="stable">
Name of resource bundle property which disables sliding of window
TopComponents when its value is set to <code>false</code>, the default value is <code>true</code>.
When this feature is disabled then there is no 'Minimize Window' item in TopComponent popup menu
and also the Minimize button in TopComponent's header is hidden.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.TopComponent.Sliding.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.TopComponent.Resizing.Enabled" category="stable">
Name of resource bundle property which disables resizing of window
TopComponents when its value is set to <code>false</code>, the default value is <code>true</code>.
When this feature is disabled then it is not possible to drag splitter bars
to change the size of TopComponents.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.TopComponent.Resizing.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.View.TopComponent.Closing.Enabled" category="stable">
Name of resource bundle property which disables closing of view TopComponents (non-editor windows)
when its value is set to <code>false</code>, the default value is <code>true</code>.
When this feature is disabled then there is no 'Close Window' item in view's popup menu,
there is no close button in TopComponent's header and also 'Close Window' action in
the main menu is disabled when a view TopComponent is activated.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.View.TopComponent.Closing.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.Editor.TopComponent.Closing.Enabled" category="stable">
Name of resource bundle property which disables closing of editor TopComponents (document windows)
when its value is set to <code>false</code>, the default value is <code>true</code>.
When this feature is disabled then there are no 'Close Window', 'Close All Documents' and 'Close Other Documents' items in editor's popup menu,
there is no close button in editor's header and also Close actions in
the main menu are disabled when an editor TopComponent is activated.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.Editor.TopComponent.Closing.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.TopComponent.Maximization.Enabled" category="stable">
Name of resource bundle property which disables maximization of TopComponents
when its value is set to <code>false</code>, the default value is <code>true</code>.
When this feature is disabled then there is no 'Maximize Window' item
in TopComponent's popup menu and also 'Maximize Window' action in
the main menu is disabled.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.TopComponent.Maximization.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.Splitter.Respect.MinimumSize.Enabled" category="stable">
Name of resource bundle property which forces splitter to ignore TopComponent
minimum size when resizing when its value is set to <code>false</code>,
the default value is <code>true</code>.
When this feature is enabled then the splitter bars will not move beyond
the minimum size of its TopComponents.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.Splitter.Respect.MinimumSize.Enabled=true command-line switch to override.
</api>
<api type="export" group="property" name="NbMainWindow.showCustomBackground" category="stable">
Name of boolean property in <code>javax.swing.UIManager</code>. When the property value
is <code>TRUE</code> then the window system will turn off opacity
for most of the main window components - menu bar, toolbars, status bar,
sliding bars and the main desktop area component. That means that the main
window background will be showing through these components.
The property value must be set before the window system loads.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.Mode.View.DragAndDrop.Enabled" category="stable">
Name of resource bundle property which allows to drag and drop the whole
group of non-document windows when its value is set to <code>true</code>,
which is also the default value.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.Mode.View.DragAndDrop.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.Mode.Editor.DragAndDrop.Enabled" category="stable">
Name of resource bundle property which allows to drag and drop the whole
group of document windows when its value is set to <code>false</code>,
which is also the default value.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.Mode.Editor.DragAndDrop.Enabled=true command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.Mode.View.Undocking.Enabled" category="stable">
Name of resource bundle property which allows to float the whole
group of non-document windows when its value is set to <code>true</code>,
which is also the default value.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.Mode.View.Undocking.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.Mode.Editor.Undocking.Enabled" category="stable">
Name of resource bundle property which allows to float the whole
group of document windows when its value is set to <code>false</code>,
which is also the default value.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.Mode.Editor.Undocking.Enabled=true command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.Mode.Sliding.Enabled" category="stable">
Name of resource bundle property which allows to minimize (slide-out) the whole
group of non-document windows when its value is set to <code>true</code>,
which is also the default value.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.Mode.Sliding.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.TopComponent.Auto.Slide.In.Minimized.Mode.Enabled" category="stable">
Name of resource bundle property which controls the opening of windows in a
minimized (slided-out) group of non-document windows. When set to true
(the default value) then a window which should open in a minimized group (Mode)
will open also minimized (slided-out). When set to false a window will open
docked even though the whole group (Mode) has been minimized.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.TopComponent.Auto.Slide.In.Minimized.Mode.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.Mode.Closing.Enabled" category="stable">
Name of resource bundle property which allows to close the whole
group of non-document windows when its value is set to <code>true</code>,
which is also the default value.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.Mode.Closing.Enabled=false command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.WinSys.Show.Hide.MainWindow.While.Switching.Role" category="stable">
Name of resource bundle property which controls whether the main IDE
window may hide temporarily (<code>true</code>) when switching window
layout role or whether the main window should stay visible when switching
roles (<code>false</code>). The default value is <code>false</code>.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.WinSys.Show.Hide.MainWindow.While.Switching.Role=true command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.WinSys.Open.New.Editors.Docked" category="stable">
Name of resource bundle property which when set to <code>true</code> will
force opening of new editor windows docked into the main IDE window.
When set to <code>false</code> new editor windows will open tabbed
with the last active editor window (which may be floating).
The default value is <code>false</code>.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.WinSys.Open.New.Editors.Docked=true command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.WinSys.DragAndDrop.Sliding.Enabled" category="stable">
Name of resource bundle property which enables/disables drag and drop
of TopComponents into sliding Modes. When set to <code>true</code> then user can
drag a TopComponent and drop it into a sliding bar to minimize it.
The default value is <code>false</code>.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.WinSys.DragAndDrop.Sliding.Enabled=true command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.WinSys.TabControl.SimpleTabs.Enabled" category="stable">
Name of resource bundle property which allows replacing the custom TabbedContainer
with plain Swing JTabbedPane implementation when the property value is <code>true</code>.
The default value is <code>false</code>.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.WinSys.TabControl.SimpleTabs.Enabled=true command-line switch to override.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.WinSys.TabControl.SimpleTabs.Placement" category="stable">
Name of resource bundle property which defines the placement of window tabs.
The possible values are <code>top</code> (default), <code>bottom</code>,
<code>left</code>, <code>right</code>. Branding of this property has no effect when
<code>WinSys.TabControl.SimpleTabs.Enabled</code> is set to false.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.WinSys.TabControl.SimpleTabs.MultiRow" category="stable">
Name of resource bundle property which defines the tab layout when JTabbedPane
implementation of tab control is being used. When set to <code>true</code>
window tabs will be organized into multiple rows, when set to <code>false</code>
the tab displayer will have scroll buttons.
Branding of this property has no effect when
<code>WinSys.TabControl.SimpleTabs.Enabled</code> is set to false.
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
</api>
<api type="export" group="branding" name="org.netbeans.core.windows.WinSys.CtrlTabSwitching.In.JTable.Enabled" category="stable">
Name of resource bundle property which can disable window switching
when the input focus is in JTable or JTabbedPane.<br/>
Ctrl+Tab and Ctrl+Shift+Tab key strokes are hard-coded to switch between
opened TopComponents. However the same keys are also used in some Containers
(e.g. JTable and JTabbedPane) to transfer input focus to next Component.<br/>
When this property is set to <code>true</code> (default value) and input
focus is in JTable or JTabbedPane then the window system will consume
Ctrl+Tab and Ctrl+Shift+Tab key strokes and show window switcher popup.<br/>
When this property is set to <code>false</code> then KeyboardFocusManager will consume
Ctrl+Tab and Ctrl+Shift+Tab key strokes to transfer focus out of JTable or
out of JTabbedPane.<br/>
The property value can be adjusted by branding of <code>org.netbeans.core.windows</code> module.
Or use -J-DNB.WinSys.WinSys.CtrlTabSwitching.In.JTable.Enabled=true command-line switch to override.
</api>
</answer>
<!-- Question: exec-privateaccess
<questionid="exec-privateaccess"> Areyouawareofanyotherpartofthesystemcallingsomeof yourmethodsbyreflection? <hint> Ifso,describethe"contract"asanAPI.Likelyprivateorfriendone,but stillAPIandconsiderrewriteofit. </hint> </question>
-->
<answer id="exec-privateaccess">
No. Now is the window persistence independent from projects. <!--Yes projects module invokes serialization of window system. It is removed in new projects -
window system configuration will not be part of project.-->
</answer>
<!-- Question: exec-property
<questionid="exec-property"> Isexecutionofyourcodeinfluencedbyanyenvironmentof system(<code>System.getProperty</code>)property? <hint> Ifthereisapropertythatcanchangethebehaviourofyour code,somebodywilllikelyuseit.Youshoulddescribewhatitdoes andthestabilitycategoryofthisAPI.Youmayuse <PRE> <propertyname="id"category="private"> descriptionoftheproperty,whereitisused,whatitinfluence,etc. </property> </PRE> </hint> </question>
-->
<answer id="exec-property">
<api group="systemproperty" name="netbeans.winsys.imageSource"type="export" category="private">
Valid values are path to image in NB like "org/netbeans/core/resources/splash.gir".
It puts the specified image into the the emptied documents area.
it is experimental now.
<code>-J-Dnetbeans.winsys.imageSource=org/netbeans/core/resources/splash.gif</code>
</api>
<api group="systemproperty" name="netbeans.winsys.dndfade.on"type="export" category="private">
Valid values are "true" and "false". Default is "false".
If it is "true" it paint faded feedback during DnD of windows. Keep in mind it makes
some performance impact on DnD.
It is experimental now.
<code>-J-Dnetbeans.winsys.fade.on=true</code>
</api>
<api group="systemproperty" name="netbeans.winsys.disable_dnd"type="export" category="private">
Valid values are "true" and "false". Default is "false".
If it is "true" it disables DnD of windows.
<code>-J-Dnetbeans.winsys.disable_dnd=true</code>
</api>
<api group="systemproperty" name="netbeans.winsys.allow.dock.anywhere"type="export"category="private">
Valid values are "true" and "false". Default is "false".
It allows user to move (e.g. using DnD) <code>TopComponent</code>S between editor(document) and view
which is restricte otherwise.
It is experimental now.
<code>-J-Dnetbeans.winsys.allow.dock.anywhere=true</code>
</api>
<api group="systemproperty" name="netbeans.winsys.hideEmptyDocArea"type="export" category="private">
Valid values are "true" and "false". Default is "false".
If it is "true" it doesn't show empty documents area.
<code>-J-Dnetbeans.winsys.hideEmptyDocArea=true</code>
</api>
<api group="systemproperty" name="netbeans.winsys.statusLine.in.menuBar"type="export" category="private">
Valid values are "true" and "false". Default is "false".
If it is "true" it shows status line at the and of menu bar instead of the
bottom of documents are (or main window).
<code>-J-Dnetbeans.winsys.statusLine.in.menuBar=true</code>
</api>
<api group="systemproperty" name="netbeans.winsys.no_toolbars"type="export" category="private">
Valid values are "true" and "false". Default is "false".
If it is "true" it hides all toolbars.
<code>-J-Dnetbeans.winsys.no_toolbars=true</code>
</api>
<api group="systemproperty" name="netbeans.winsys.menu_bar.path"type="export" category="private">
If this property is set its value must point to a file on the system file system
that provides instance of type <code>org.openide.awt.MenuBar</code>.
This alternative menu bar will be used instead of the default one.
<code>-J-Dnetbeans.winsys.menu_bar.path=foo/bar.instance</code>
</api>
<api group="systemproperty" name="netbeans.winsys.status_line.path"type="export" category="private">
If this property is set its value must point to a file on the system file system
that provides instance of type <code>javax.swing.JComponent</code>.
This alternative status line will be used instead of the default one.
<code>-J-Dnetbeans.winsys.status_line.path=foo/bar.instance</code>
</api>
<api group="systemproperty" name="netbeans.winsys.no_help_in_dialogs"type="export" category="private">
Valid values are "true" and "false". Default is "false".
If set to "true" the modal dialogs will be shown without the help button.
<code>-J-Dnetbeans.winsys.no_help_in_dialogs=true</code>
</api>
<api group="property" name="netbeans.windows"type="export" category="private">
This property was deleted and has no effect now, as sdi support was dropped
and replaced by individual seperate windows. Please don't use, it's useless.
</api>
<api group="systemproperty" name="org.openide.windows.DummyWindowManager.VISIBLE"type="export" category="private">
<p>
If set to <code>false</code>, windows opened (e.g. <code>TopComponent.open</code>) using the
dummy fallback window manager will not really be set to be visible. Useful for unit tests which
must incidentally use the Window System API but for which actual display of windows is undesirable.
</p>
</api>
<api group="javax.swing.UIManager" name="tab_focus_fill_dark"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_focus_fill_dark")</code>
</api>
<api group="javax.swing.UIManager" name="tab_focus_fill_bright"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_focus_fill_bright")</code>
</api>
<api group="javax.swing.UIManager" name="tab_unsel_fill_dark"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_unsel_fill_dark")</code>
</api>
<api group="javax.swing.UIManager" name="tab_unsel_fill_bright"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_unsel_fill_bright")</code>
</api>
<api group="javax.swing.UIManager" name="tab_sel_fill"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_sel_fill")</code>
</api>
<api group="javax.swing.UIManager" name="tab_sel_fill_bright"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_sel_fill_bright")</code>
</api>
<api group="javax.swing.UIManager" name="tab_sel_fill_dark"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_sel_fill_dark")</code>
</api>
<api group="javax.swing.UIManager" name="tab_border"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_border")</code>
</api>
<api group="javax.swing.UIManager" name="tab_bottom_border"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_bottom_border")</code>
</api>
<api group="javax.swing.UIManager" name="tab_sel_border"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_sel_border")</code>
</api>
<api group="javax.swing.UIManager" name="workplace_fill"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("workplace_fill")</code>
</api>
<api group="javax.swing.UIManager" name="tab_highlight_header"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_highlight_header")</code>
</api>
<api group="javax.swing.UIManager" name="tab_highlight_header_fill"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("tab_highlight_header_fill")</code>
</api>
<api group="javax.swing.UIManager" name="standard_border"type="export" category="private">
One of colors used in own tabs UI implementation.
Usage example: To get color, call <code>javax.swing.UIManager.get("standard_border")</code>
</api>
<api group="javax.swing.UIManager" name="org.netbeans.core.windows.view.ui.tabcontrol.BorderProvider"type="export" category="private">
Custom border management for tabbed containers can be achieved by implementing
interface <code>org.netbeans.core.windows.view.ui.tabcontrol.BorderProvider</code>
and putting instance into Swing's UIManager table under key with the same name
as interface has.
Usage example: Provide BorderProviderImpl implementation and put it in table
<code>javax.swing.UIManager.put("org.netbeans.core.windows.view.ui.tabcontrol.BorderProvider", borderProviderImpl)</code>
during startup, before main window is shown.
</api> <!--<api group="systemproperty" name="netbeans.scrolling.tabs" type="export" category="private"> Validvaluesare"true"and"false".Defaultis"false".IfitistruenewJDK1.4scrollingtabs areused. Itcanbesetoncommandlineorinide.cfg.Usageexample:Toenablescrollingtabsuse <code>-J-Dnetbeans.scrolling.tabs=true</code> </api> <apigroup="systemproperty"name="netbeans.winsys.dnd"type="export"category="private"> Validvaluesare"true"and"false".Defaultis"false".IfitistrueitenableswindowsystemDnD onJDK1.4. Itcanbesetoncommandlineorinide.cfg.Usageexample:ToenablewindowsystemDnDuse <code>-J-Dnetbeans.winsys.dnd=true</code> </api> <apigroup="systemproperty"name="netbeans.windows.tabs_on_top"type="export"category="private"> Validvaluesare"true"and"false".Defaultis"false".Ifitsitruetabsareput ontop.Bydefaulttabsareatbottom. Itcanbesetoncommandlineorinide.cfg.Usageexample:Toplacetabsontopofcontainer(area) use<code>-J-Dnetbeans.windows.tabs_on_top=true</code> </api> <apigroup="systemproperty"name="netbeans.windows.no_wswitcher"type="export"category="private"> Validvaluesare"true"and"false".Defaultis"false".Ifitistrueworkspaceswitcher andstatuslinearenotdisplayed.Itcanbeusedtosavesomescreenspaceesp.useful onnotebook. Itcanbesetoncommandlineorinide.cfg.Usageexample:Todisable(hide)defaultworkspace use<code>-J-Dnetbeans.windows.no_wswitcher=true</code>
</api>-->
<p>
A bit different than property but still important is the
<a href="@org-openide-util@/org/openide/util/doc-files/logging.html">
structured logging</a> produced by this module:
</p>
<api name="org.netbeans.ui.actions.UI_ACTION_KEY_PRESS" category="friend" group="logger"type="export">
There is a special support for notifying when an action is invoked by the
<a href="@TOP@/org/openide/windows/TopComponent.html">TopComponent</a>'s
key event handling code. The support is using <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/Logger.html">
Logger.getLogger("org.netbeans.ui.actions")
</a> and sents a <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/LogRecord.html">LogRecord</a>
with message <code>UI_ACTION_KEY_PRESS</code>,
<code>FINER</code> <a href="@JDK@@JDKMODULE_JAVA_LOGGING@/java/util/logging/LogRecord.html">level</a>
and paramerters:
<ul>
<li>{<b>0</b>} instance of the <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/KeyStroke.html">KeyStroke</a></li>
<li>{<b>1</b>} toString of the <a href="@JDK@@JDKMODULE_JAVA_DESKTOP@/javax/swing/KeyStroke.html">KeyStroke</a></li>
<li>{<b>2</b>} instance of the action</li>
<li>{<b>3</b>} class of the action</li>
<li>{<b>4</b>} display name of the action</li>
</ul>
whenever such action is invoked. This message can then be consumed
by enhanced UI logger that track what the user is going.
</api>
</answer>
<questionid="format-clipboard"> Whichprotocolsyourcodereads/insertswhencommunicatingwith clipboard? </question>
-->
<answer id="format-clipboard">
Module uses the same standard protocol as actions module. In case of Copy-n-Paste
instances of Workspace, Mode and TopComponent are passed to clipboard.
<p/>There are defined three kinds of <code>DataFlavor</code>S for pure internal usage for DnD of <code>TopComponent</code>S.
They are constructed using MIME Types constructed following way:
<ul>
<li><api group="java" category="private"type="export" name="DataFlavorDnDTopComponent">DataFlavor.javaJVMLocalObjectMimeType + "; class=org.openide.windows.TopComponent"</api></li>
<li><api group="java" category="private"type="export" name="DataFlavorDnDTopComponent.Cloneable">DataFlavor.javaJVMLocalObjectMimeType + "; class=org.openide.windows.TopComponent$Cloneable"</api></li>
<li><api group="java" category="private"type="export" name="DataFlavorDnDTopComponentArray">DataFlavor.javaJVMLocalObjectMimeType + "; class=org.netbeans.core.windows.dnd.TopComponentDragSupport$TopComponentArray"</api></li>
</ul>
</answer>
<!-- Question: format-dnd
<questionid="format-dnd"> Whichprotocolsyourcodeunderstandsduringdrag-n-drop? </question>
-->
<answer id="format-dnd">
Window system DnD: Module uses standard AWT DragDrop protocol. TopComponent
instances are transfered. Experimental, not enabled by default.
Explorer DnD: It is also possible to DnD nodes in Explorer in such case instances
of Workspace, Mode and TopComponent are transfered.
</answer>
<questionid="lookup-lookup"> Doesyourmoduleuses<code>org.openide.util.Lookup</code> tofindanycomponentstocommunicateto?Whichones? <hint> Pleasedescribetheinterfacesyouaresearchingfor,where aredefined,whetheryouaresearchingforjustoneormoreofthem, iftheorderisimportant,etc.Alsoclasifythestabilityofsuch APIcontract. </hint> </question>
-->
<answer id="lookup-lookup">
Window Manager implementation (from core) registers itself and lookup is used
from API part to get the instance and return as
<a href="@TOP@/org/openide/windows/WindowManager.html#getDefault()">WindowManager.getDefault ()</a>
and also <a href="@TOP@/org/openide/windows/WindowManager.html#componentRegistry()">WindowManager.componentRegistry()</a>.
gets the registered instance of <code>TopComponent.Registry</code>.
Also there are provided implementations of <a href="@org-openide-dialogs@/org/openide/DialogDisplayer.html#getDefault()">DialogDisplayer.getDefault()</a>
and <a href="@org-openide-nodes@/org/openide/nodes/NodeOperation.html#getDefault()">NodeOperation.getDefault()</a> services.
<p/>
There is also provided service which implements <api category="friend" group="java" name="NbTopManager.WindowSystem"type="import">org.netbeans.core.NbTopManager$WindowSystem interface</api>,
which is used in core module. It is used for starting window system (loading and show) in startup sequence and finishiing of window system (hiding and saving)
during exit sequence. The reason of this is that module API is not sufficient fot window system module, since it needs to provide its loading after all
module layers are loaded etc.
</answer>
<!-- Question: lookup-register
<questionid="lookup-register"> Doyouregisteranythingintothelookupforothertofind? <hint> Doyouregisterusinglayerfileorusing<code>META-INF/services</code>? Whoissupposedtofindyourcomponent? </hint> </question>
-->
<answer id="lookup-register">
WindowManager and TopComponent.Registry are registered. Used to find sinleton
instance by singleton accessor.
</answer>
<!-- Question: lookup-remove
<questionid="lookup-remove"> Areremovingentriesofothermodulesfromthelookup? <hint> Why?Ofcourse,thatispossible,butitcanbedangerous.Isthemodule youraremaskingresourcefromawareofwhatyouaredoing? </hint> </question>
-->
<answer id="lookup-remove">
Yes. It removes implementation of <a href="@org-openide-nodes@/org/openide/nodes/NodeOperation.html#getDefault()">NodeOperation.getDefault()</a>
service provided by openide-explorer module.
</answer>
<!-- Question: perf-exit
<questionid="perf-exit"> Doesyourmoduleexecutesanythingonexit? </question>
-->
<answer id="perf-exit">
Module configuration is saved on exit.
</answer>
<questionid="perf-limit"> Arethereanylimitsinnumber/sizeofelementsyourcode canhandle? </question>
-->
<answer id="perf-limit">
Yes. Of course it is size of memory. The other limits were not set yet.
</answer>
<!-- Question: perf-mem
<questionid="perf-mem"> Whatistheamountofmemoryyourcomponentoccupies?Estimate witharelactiontothenumberofwindows,etc. </question>
-->
<answer id="perf-mem"> <!-- TODO Needs to add estimated size of plain TopComponent object constructed -> new TopComponent() --> <!--Estimate for default window system layout. Created empty workspace test and I measured howheapincreaseswhenotherworkspacesareinitializedbyswitchingtothem. Editing-1.5MB, GUIEditing-600KB, Debugging-700KB,
sum - 2.8MB.-->
</answer>
<questionid="perf-progress"> Doesyourmoduleexecutessomelongrunningtask? <hint>Typicallytheyaretaskslikeconnectingover network,computinghugeamountofdata,compilation. Suchcommunicationshouldbedoneasynchronously(forexample using<code>RequestProcessor</code>),definitivelyitshould notblockAWTthread. </hint> </question>
-->
<answer id="perf-progress">
It executes long running tasks at startup and exit of IDE, i.e. loading and saving of window system configurations. <!--Initializing of workspace (due to lazy loading of components) can be long depending onnumberofcomponentsortimenecessarytoinitializecomponents.Itisperformed
in AWT thread because user is blocked anyway till workspace is initialized.-->
</answer>
<!-- Question: perf-scale
<questionid="perf-scale"> Whichexternalcriteriainfluencetheperformanceofyour program(sizeoffileineditor,numberoffilesinmenu, insourcedirectory,etc.)andhowwellyourcodescales? Pleaseincludesomeestimates. </question>
-->
<answer id="perf-scale">
The performance of window system can influence meny externals quite heavily. Cases which can singificantly
influence window system responsiveness are:
<ul>
<li>Long running client task performed in AWT thead</li>
<li>Any sublcass of <code>TopComponnet</code> with slow internal responsiveness, e.g. with slow
painting routines, validating, bad UI management etc.</li>
</ul>
<p/>
Depends on number of displayed frames, components. Currently it is linear though
some part of components initialization is done only when necessary (eg. when component
is in JTabbedPane it is not necessary to initialize component ui when component
is not visible.
</answer>
<!-- Question: perf-startup
<questionid="perf-startup"> Doesyourmoduleexecutesanythingonstartup? </question>
-->
<answer id="perf-startup">
Yes. The window system configuration is loaded and shown the result on screen. <!--Current workspace is initialized.-->
</answer>
<questionid="resources-layer"> Doesyourmoduleprovideownlayer?Doesitcreatesomefilesor foldersonit?Whatitistryingtocommunicatebythatandwithwhich component? <hint> NetBeansallowsautomaticanddeclarativeinstallationofresources bymodulelayers.Moduleregisterfilesintoappropriateplaces andothercomponentsusethatinformationtoperformtheirtask (buildmenu,toolbar,windowlayout,listoftemplates,setof options,etc.). </hint> </question>
-->
<answer id="resources-layer">
Yes. Default window system layout is in module layer. Other modules can define
their own winsys elements (mode, group, component) in their module layer.
</answer>
<questionid="resources-read"> Doesyourmodulereadanyresourcesfromlayers?Forwhatpurpose? <hint> Asthisissomekindofintermoduledependency,itisakindofAPI. Pleasedescribeitandclasifyaccordingto <ahref="http://openide.netbeans.org/tutorial/api-design.html#categories"> commonstabilitycategories</a>. </hint> </question>
-->
<answer id="resources-read">
Module reads its own configuration from its layer and eventualy from other module layers
if provided. Data have following <a href="https://netbeans.apache.org/projects/platform/core/windowsystem/changes#s342">folder structure</a>.
It contains <api group="layer" category="private"type="export" name="ModuleDataStructure"url="https://netbeans.apache.org/projects/platform/core/windowsystem/changes#s342">Module folder structure under Windows2 directory </api>
and <api group="layer" category="private"type="export" name="LocalDataStructure"url="https://netbeans.apache.org/projects/platform/core/windowsystem/changes#s342">Local folder structure under Windows2Local directory</api>.
</answer>
</api-answers>
Messung V0.5 in Prozent
¤ Diese beiden folgenden Angebotsgruppen bietet das Unternehmen0.48Angebot
(Wie Sie bei der Firma Beratungs- und Dienstleistungen beauftragen können 2026-09-27)
¤
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.