Java Doc for SubstanceLookAndFeel.java in  » Swing-Library » substance-look-feel » org » jvnet » substance » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Client property name for specifying that the colorization amount applied to the background and foreground of the current theme and the specific control.

Fade kind for tree decorations animation kind.

Client property name for specifying that icons on buttons and toggle buttons should match the color of the current theme when they are in default state.

Note that setting this property on a container (such as JScrollPane ) will affect all its children (recursively) unless they set this property.

Example of setting a custom background composite on a scroll pane (will affect the painting of the scroll bars and all its children):

Example of marking all application controls with the same background composite:

For JVM flag, the value should be a fully-qualified name of the border painter class. This class must have a default (no-argument) constructor. For client property, the value should be either a fully-qualified class name as above or an instance of SubstanceBorderPainter .

Example of specifying a custom default border painter as a VM flag:

Example of using a painter class name as client property value:

Note that SubstanceButtonShaper implementations are not required to respect this property. The current implementations of the default StandardButtonShaper and ClassicButtonShaper respect this property.

Example of marking a button to ignore minimum dimension settings:

Example of marking all application buttons to ignore minimum dimension settings:

• The name of one of the values in SubstanceConstants.Side enum.
• Array of names of the values in SubstanceConstants.Side enum.
• A value in SubstanceConstants.Side enum.
• Array of values in SubstanceConstants.Side enum.

Example of marking a button to have open north side:

Example of marking a button to never paint background:

Example of marking all application buttons to never paint background:

If this property is used as a JVM flag, the value should be a fully-qualified name of the button shaper class. This class must have a default (no-argument) constructor.

If this property is used as a client property, the value can be one of:

• String - fully-qualified name of the button shaper class.
• SubstanceButtonShaper object itself.

Example of specifying a custom default button shaper as a VM flag:

Example of using a shaper class name as client property value:

Example of using a SubstanceButtonShaper object as client property value:

• The name of one of the values in SubstanceConstants.Side enum.
• Array of names of the values in SubstanceConstants.Side enum.
• A value in SubstanceConstants.Side enum.
• Array of values in SubstanceConstants.Side enum.

Note that not all SubstanceButtonShaper implementations are required to respect this property. The default StandardButtonShaper and ClassicButtonShaper respect this property.

Example of marking a button to have straight north side:

Client property name for specifying that the colorization amount applied to the background and foreground of the current theme and the specific control. By default, when the application does not use any custom colors, all the controls are painted with the colors of the current theme / skin. The colors coming from the look-and-feel implement the marker UIResource interface which allows the UI delegates to differentiate between application-specific colors which are not changed, and the LAF-provide colors that are changed on LAF switch.

Up until version 4.2, the support for custom background and foreground colors in Substance was not very consistent. On some controls, such as buttons, the background color was ignored completely (in favour of the current theme), while on others it was used to color the entire bounds of the control (such as check box). This new client property installs the "smart colorization" mode which uses the colors of the current theme and the custom background and foreground colors (where installed by application) to colorize the relevant portions of the control. For example, on checkbox the custom background color will be used to colorize the check box itself, while the custom foreground color will be applied to the check box text and the check mark.

The value of this property specifies the actual colorization amount. Value of 0.0 results in no colorization at all. Values closer to 1.0 result in controls being colorized in almost full amount of the custom colors. Note that in order to maintain the gradients (fill, border, etc), even value of 1.0 does not result in full custom color being applied to the relevant visuals of the control.

This property can be specified globally on UIManager , applying on all controls, or on the specific component / container. In the later case, the value will be applied to the component / container itself and all its children that do not specify a custom value for this property.

The value should be an instance of Double in 0.0-1.0 range.

Example of marking a button to have custom background color and colorizing it with 50%:

• The default SwingConstants.SOUTH - the popup is displayed directly below the combo aligned to the left.
• SwingConstants.NORTH - the popup is displayed directly above the combo aligned to the left.
• SwingConstants.EAST - the popup is displayed to the left of the combo aligned to the top.
• SwingConstants.WEST - the popup is displayed to the right of the combo aligned to the top.
• SwingConstants.CENTER - the popup is displayed centered vertically over the combo aligned to the left.

Note that the combo arrow changes in accordance with the combo popup flyout orientation. Example of setting a combobox with a custom flyout orientation:

• ComboPopupPrototypeCallback - will provide application-specific logic at runtime.
• Object - will point to the prototype entry itself.

This property can be set either on a specific JComboBox or globally on UIManager .

Here is an example of combo popup prototype set to a model element:

Here is an example of combo popup prototype set to a dynamic callback. This callback always returns the last model element:

-Dsubstancelaf.configFile=C:/myConfigSubstance.properties

Example of specifying a (toolbar) button to have corner radius of 5 pixels:

Example of specifying all buttons of a toolbar to have corner radius of 3 pixels:

Example of specifying all toolbar buttons to have corner radius of 0 pixels:

Example of setting this property via VM flag:

Example of setting this property on UIManager :

Example of setting this property via VM flag:

Example of setting this property on UIManager :

Example of setting this property via VM flag:

Example of setting this property on UIManager :

JButton button = new JButton("text");
button.putClientProperty(SubstanceLookAndFeel.FLAT_PROPERTY,
  Boolean.TRUE);
since:
   version 3.0
See Also:   SubstanceLookAndFeel.BUTTON_PAINT_NEVER_PROPERTY

In order to compute the kind of focus indication for some component, the component's hierarchy is traversed bottom up. The first component that has this property set, defines the focus indication kind. Finally, if neither component not its ancestors define this property, the global setting on UIManager is checked. If there is no global setting, the default SubstanceConstants.FocusKind.ALL_INNER is used. Here is an example to illustrate the above:

In the code above:

• Button b1 will have SubstanceConstants.FocusKind.NONE focus kind which is set directly on the button.
• Button b2 will have SubstanceConstants.FocusKind.UNDERLINE focus kind which is inherited from its topPanel parent.
• Button b3 will have SubstanceConstants.FocusKind.ALL_INNER focus kind which is set directly on the button.

For the JVM flag, the value should be fully-qualified name of the gradient painter class. This class must have a default (no-argument) constructor. For the client property, the value can be either a fully-qualified class name as above or an instance of SubstanceGradientPainter .

Example of specifying a custom default gradient painter as a VM flag:

Example of using a painter class name as client property value:

Example of using a painter instance as client property value:

Example of marking a scroll pane to have custom grip handles on its scroll bars:

When this VM flag is set (no need to specify a value), the system menu on decorated title panes will have a check box menu item that controls the visibility of the heap status panel. The SubstanceLookAndFeel.permanentlyShowHeapStatusPanel(JRootPane) (can be called only when the VM flag is set) removes the above check box menu item and adds the heap status panel to the title pane (if it wasn't shown prior to calling that method). The SubstanceLookAndFeel.permanentlyHideHeapStatusPanel(JRootPane) (can be called only when the VM flag is set) removes the above check box menu item and removes the heap status panel to the title pane (if it was shown prior to calling that method).

Example of setting soft fill kind:

• System menu items
• Menu search panel
• Lock icon on non-editable text components

Example of setting this property via VM flag:

Example of setting this property on UIManager :

Example of marking a scroll pane to have overlays on the scroll bars:

Example of marking all application controls to have overlays:

Example of marking a button to be painted active:

Example of marking all application controls to be painted active:

Example of having all password fields echo 3 characters per each typed user character:

Example of having a specific password field echo 2 characters per each typed user character:

JScrollPane jsp = new JScrollPane(new JPanel());
jsp.putClientProperty(SubstanceLookAndFeel.SCROLL_PANE_BUTTONS_POLICY,
  ScrollPaneButtonPolicyKind.MULTIPLE);
since:
   version 3.1

Example of setting that all tabs in the application will have modified animation on close button:

A more complex example:

In the example above, the first first-level child (jtpSecondary) has the animation on the entire tab (since it overrides the global setting). The second first-level child tab (panelSecondary) has animation on the close button (from the global UIManager setting). The first second-level tab has the animation on the entire tab (setting inherited from the parent jtpSecondary tab that overrides the global setting). The second second-level tab has animation on the close button (since its setting overrides the parent setting).

Example of setting that all tabs in the application will have close buttons:

A more complex example:

In the example above, the first first-level child (jtpSecondary) doesn't have the close button (since it overrides the global setting). The second first-level child tab (panelSecondary) has close button (from the global UIManager setting). The first second-level tab doesn't have the close button (setting inherited from the parent jtpSecondary tab that overrides the global setting). The second second-level tab has the close button (since its setting overrides the parent setting).

Example of custom tab close callback set on a tabbed pane:

Example of setting that all tabbed panes in the application have single full border (default setting prior to version 4.1):

Example of specifying that the specific tabbed pane has single full border (default setting prior to version 4.1):

Example of setting that all tabbed panes in the application will follow placement for the text alignment:

Example of specifying that the specific tabbed pane will follow placement for the text alignment:

Example of setting that all tabbed panes in the application will be vertically oriented:

Example of specifying that the specific tabbed pane will be vertically oriented:

Example of setting that all vertically-oriented tabs in the application will have unrotated icons:

An example of tabbed pane with two different kinds of icon orientation:

In the example above, the first tab (tab1) has the horizontally-oriented icon (the same as with SwingConstants.TOP or SwingConstants.BOTTOM ) , while the second tab (tab2) has the rotated icon (oriented along the tab text).

If this property is used as a JVM flag, the value should be a fully-qualified name of the theme class. This class must have a default (no-argument) constructor. This means that you can not specify "generic" themes such as SubstanceMixTheme or SubstanceToneTheme .

If this property is used as a client property, the value can be one of:

• String - theme display name (only for primitive themes).
• ThemeInfo object (call SubstanceLookAndFeel.getAllThemes() ).
• SubstanceTheme object itself.

Example of specifying a custom default theme as a VM flag:

Example of using a theme display name as client property value:

Example of using a ThemeInfo object as client property value:

Example of using a SubstanceTheme object as client property value:

For JVM flag, the value should be a fully-qualified name of the title painter class. This class must have a default (no-argument) constructor. For client property, the value should be either a fully-qualified class name as above or an instance of SubstanceTitlePainter .

Example of specifying a custom default title painter as a VM flag:

Example of using a painter class name as client property value:

-Dsubstancelaf.traceFile=C:/temp/myApp.substance.log

Fade kind for tree decorations animation kind. Disabled by default, use FadeConfigurationManager.allowFades(FadeKind) to enable.

Tree decorations include collapse / expand icons and vertical / horizontal lines.

Smart tree scroll is relevant for scroll panes containing a tree. When enabled, it automatically scrolls the tree horizontally when the viewport shows mainly empty area (especially relevant for multi-level trees with narrow viewports).

Client property name for specifying that icons on buttons and toggle buttons should match the color of the current theme when they are in default state. The button is in default state when it's not pressed, not selected, not armed and not rolled over. The value should be an instance of Boolean . By default, all buttons show regular (full-color original) icons. The value can be set on the specific button or globally on UIManager .

Example of marking a button to have theme-matching icon in default state:

In order to compute whether the current watermark should be painted on some component, the component's hierarchy is traversed bottom up. The first component that has this property set, defines the watermark visibility. Finally, if neither component not its ancestors define this property, the global setting on UIManager is checked. If there is no global setting, the watermark is not ignored (it is painted). Here is an example to illustrate the above:

JPanel topPanel = new JPanel();
topPanel.putClientProperty(SubstanceLookAndFeel.WATERMARK_IGNORE,
  Boolean.TRUE);
JPanel panel1 = new JPanel();
JPanel panel2 = new JPanel();
panel2.putClientProperty(SubstanceLookAndFeel.WATERMARK_IGNORE,
  Boolean.FALSE);
JTextField tf1 = new JTextField("field1");
tf1.putClientProperty(SubstanceLookAndFeel.WATERMARK_IGNORE, Boolean.TRUE);
JTextField tf2 = new JTextField("field2");
panel1.add(tf1);
panel1.add(tf2);
topPanel.add(panel1);
topPanel.add(panel2);

In the code above, if UIManager has no value for this property, the watermark will be painted only on panel2 and tf1. The panel1 and tf2 "inherit" the watermark-ignore setting from their topPanel ancestor.
since:
   version 2.2

-Dsubstancelaf.watermark.image.kind=APP_ANCHOR
since:
   version 2.3
See Also:   SubstanceLookAndFeel.getImageWatermarkKind()
See Also:   SubstanceLookAndFeel.getImageWatermarkOpacity()
See Also:   SubstanceLookAndFeel.setImageWatermarkKind(ImageWatermarkKind)
See Also:   SubstanceLookAndFeel.setImageWatermarkOpacity(float)
See Also:   SubstanceLookAndFeel.WATERMARK_IMAGE_OPACITY
See Also:   SubstanceLookAndFeel.WATERMARK_IMAGE_PROPERTY

-Dsubstancelaf.watermark.image.opacity=0.6
since:
   version 2.3
See Also:   SubstanceLookAndFeel.getImageWatermarkKind()
See Also:   SubstanceLookAndFeel.getImageWatermarkOpacity()
See Also:   SubstanceLookAndFeel.setImageWatermarkKind(ImageWatermarkKind)
See Also:   SubstanceLookAndFeel.setImageWatermarkOpacity(float)
See Also:   SubstanceLookAndFeel.WATERMARK_IMAGE_KIND
See Also:   SubstanceLookAndFeel.WATERMARK_IMAGE_PROPERTY

Example of specifying a local image as watermark image:

Example of specifying a URL image as watermark image:

Example of specifying a custom default watermark as a VM flag:

When this property is used as a JVM flag, there is no need to specify any value:

When this property is set a client property on UIManager , the value should be one of Boolean.TRUE or Boolean.FALSE . For example,

• JInternalFrame - the close button of the specific internal frame will be animated (in case that the internal frame has decorated title pane). In addition, once such internal frame is iconified (to a JInternalFrame.JDesktopIcon ), the close button of the matching desktop icon is animated as well.
• JRootPane - the close button of the title pane of the matching frame / dialog will be animated (in case that the frame / dialog have decorated title pane).
• JComponent in a JTabbedPane . Based on the SubstanceLookAndFeel.TABBED_PANE_CLOSE_BUTTONS_MODIFIED_ANIMATION property presence, either the entire tab or its close button area is animated. In this case, this property must be set on the tab component itself, not on one of its child components.

The animation cycles between red, orange and yellow themes. In most cases (all but tabs not marked with SubstanceLookAndFeel.TABBED_PANE_CLOSE_BUTTONS_MODIFIED_ANIMATION property), the animation will be visible only when the mouse hovers over the close button of the matching container (frame, dialog, internal frame, desktop icon, tab). The tooltip of the close button is changed as well to reflect that the container contents are marked as modified.

Here is a sample text editing application that illustrates the use of this property. Once the contents of the text pane are changed, the frame is marked as modified. The Save button marks the frame as not-modified. In the real application, the listener on this button will need to persist the changes as well.

• The specified theme is the main theme for a new mixed theme.
• The secondary theme is of the same kind.