jdk-sandbox: jdk/src/share/classes/javax/swing/plaf/nimbus/package.html@327690766109 (annotated)

2658 43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	2	<html>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	3	<head>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	4	<!--
5506 202f599c92aa 6943119: Rebrand source copyright notices ohair parents: 4394 diff changeset	5	Copyright (c) 1998, 2001, Oracle and/or its affiliates. All rights reserved.
2658 43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	6	DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	7
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	8	This code is free software; you can redistribute it and/or modify it
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	9	under the terms of the GNU General Public License version 2 only, as
5506 202f599c92aa 6943119: Rebrand source copyright notices ohair parents: 4394 diff changeset	10	published by the Free Software Foundation. Oracle designates this
2658 43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	11	particular file as subject to the "Classpath" exception as provided
5506 202f599c92aa 6943119: Rebrand source copyright notices ohair parents: 4394 diff changeset	12	by Oracle in the LICENSE file that accompanied this code.
2658 43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	13
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	14	This code is distributed in the hope that it will be useful, but WITHOUT
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	15	ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	16	FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	17	version 2 for more details (a copy is included in the LICENSE file that
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	18	accompanied this code).
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	19
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	20	You should have received a copy of the GNU General Public License version
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	21	2 along with this work; if not, write to the Free Software Foundation,
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	22	Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	23
5551 327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc. ohair parents: 5506 diff changeset	24	Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc. ohair parents: 5506 diff changeset	25	or visit www.oracle.com if you need additional information or have any
327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc. ohair parents: 5506 diff changeset	26	questions.
2658 43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	27	-->
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	28
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	29	</head>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	30	<body bgcolor="white">
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	31
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	32	Provides user interface objects built according to the cross-platform
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	33	Nimbus look and feel.
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	34
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	35	<p>Nimbus uses instances of the {@link javax.swing.Painter} interface to paint
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	36	components. With each Swing component it associates a foreground and a
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	37	background {@code Painter}, and there may be several painters for different
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	38	component states.
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	39
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	40	<p>Nimbus allows customizing many of its properties, including painters, by
3094 abb391749982 6844273: jdk/make/docs/CORE_PKGS.gmk does not list Nimbus peterz parents: 2658 diff changeset	41	altering the {@link javax.swing.UIDefaults} table. Here's an example:
2658 43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	42	<code><pre>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	43	UIManager.put("ProgressBar.tileWidth", myTileWidth);
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	44	UIManager.put("ProgressBar[Enabled].backgroundPainter", myBgPainter);
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	45	UIManager.put("ProgressBar[Enabled].foregroundPainter", myFgPainter);
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	46	</pre></code>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	47
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	48	<p>Per-component customization is also possible. When rendering a component,
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	49	Nimbus checks its client property named "Nimbus.Overrides". The value of this
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	50	property should be an instance of {@code UIDefaults}. Settings from that table
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	51	override the UIManager settings, but for that particular component instance
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	52	only. An optional client property, "Nimbus.Overrides.InheritDefaults" of type
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	53	Boolean, specifies whether the overriding settings should be merged with
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	54	default ones ({@code true}), or replace them ({@code false}). By default they
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	55	are merged:
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	56	<code><pre>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	57	JProgressBar bar = new JProgressBar();
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	58	UIDefaults overrides = new UIDefaults();
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	59	overrides.put("ProgressBar.cycleTime", 330);
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	60	...
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	61	bar.putClientProperty("Nimbus.Overrides", overrides);
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	62	bar.putClientProperty("Nimbus.Overrides.InheritDefaults", false);
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	63	</pre></code>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	64
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	65	<p>Colors in Nimbus are derived from a core set of
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	66	<a href="doc-files/properties.html#primaryColors">primary colors</a>. There are also
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	67	<a href="doc-files/properties.html#secondaryColors">secondary colors</a>, which are
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	68	derived from primary ones, but serve themselves as base colors for other
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	69	derived colors. The derivation mechanism allows for runtime customization,
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	70	i.e. if a primary or secondary color is changed, all colors that are derived
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	71	from it are automatically updated. The method
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	72	{@link javax.swing.plaf.nimbus.NimbusLookAndFeel#getDerivedColor(java.lang.String, float, float, float, int, boolean)}
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	73	may be used to create a derived color.
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	74
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	75	<p>These classes are designed to be used while the
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	76	corresponding <code>LookAndFeel</code> class has been
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	77	installed
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	78	(<code>UIManager.setLookAndFeel(new <i>XXX</i>LookAndFeel())</code>).
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	79	Using them while a different <code>LookAndFeel</code> is installed
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	80	may produce unexpected results, including exceptions.
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	81	Additionally, changing the <code>LookAndFeel</code>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	82	maintained by the <code>UIManager</code> without updating the
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	83	corresponding <code>ComponentUI</code> of any
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	84	<code>JComponent</code>s may also produce unexpected results,
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	85	such as the wrong colors showing up, and is generally not
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	86	encouraged.
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	87
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	88	<p><strong>Note:</strong>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	89	Most of the Swing API is <em>not</em> thread safe.
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	90	For details, see
4394 92a8ec883f5d 6827653: Make Synth UI classes public peterz parents: 3094 diff changeset	91	<a href="http://java.sun.com/docs/books/tutorial/uiswing/concurrency/index.html"
92a8ec883f5d 6827653: Make Synth UI classes public peterz parents: 3094 diff changeset	92	target="_top">Concurrency in Swing</a>,
2658 43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	93	a section in
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	94	<em><a href="http://java.sun.com/docs/books/tutorial/"
4394 92a8ec883f5d 6827653: Make Synth UI classes public peterz parents: 3094 diff changeset	95	target="_top">The Java Tutorial</a></em>.
2658 43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	96
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	97	@since 1.7
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	98	@serial exclude
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	99
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	100	</body>
43e06bc950ec 6591875: Nimbus Swing Look and Feel peterz parents: diff changeset	101	</html>

author	ohair
	Wed, 26 May 2010 20:28:04 -0700
changeset 5551	327690766109
parent 5506	202f599c92aa
child 21254	f6d36ee3f269
permissions	-rw-r--r--