org.jvnet.substance.utils.params
Interface ParamReader

All Known Implementing Classes:
JvmFlagsParamReader, PropertiesFileParamReader

public interface ParamReader

Base interface for parameter readers. This class is for internal use only.

Author:
Kirill Grouchnikov

Method Summary
 java.lang.String getBorderPainterProperty()
          Returns the value that specifies the global Substance border painter.
 java.lang.String getButtonShaperProperty()
          Returns the value that specifies the global Substance button shaper.
 java.lang.String getGradientPainterProperty()
          Returns the value that specifies the global Substance gradient painter.
 java.lang.String getThemeProperty()
          Returns the value that specifies the global Substance theme.
 java.lang.String getTitlePainterProperty()
          Returns the value that specifies the global Substance title painter.
 java.lang.String getTraceFileNameProperty()
          Returns the name of the trace file.
 SubstanceConstants.ImageWatermarkKind getWatermarkImageKindProperty()
          Returns the value that specifies the kind of image-based watermark.
 java.lang.Float getWatermarkImageOpacityProperty()
          Returns the value that specifies the opacity of image-based watermark.
 java.lang.String getWatermarkImageProperty()
          Returns the value that specifies the image location for image-based watermark.
 java.lang.String getWatermarkProperty()
          Returns the value that specifies the global Substance watermark.
 boolean isDebugUiMode()
          Returns the indication whether Substance is running the application under debug UI mode.
 boolean toBleedWatermark()
          Returns indication whether the watermark should "bleed" through usuallu opaque controls, such as trees, lists, tables and text controls (text field, text area, etc).
 boolean toEnableInvertedThemes()
          Returns the indication whether Substance should enable inverted color themes.
 boolean toEnableNegatedThemes()
          Returns the indication whether Substance should enable negated color themes.
 boolean toShowExtraElementProperty()
          Returns the indication whether Substance can add additional UI elements (such as system menu items, menu search panel).
 java.lang.String toShowHeapStatusPanelProperty()
          Returns the indication for showing the heap status panel in the custom-decorated title panes.
 

Method Detail

getThemeProperty

java.lang.String getThemeProperty()
Returns the value that specifies the global Substance theme. If not null, should be a fully-qualified class name of a class that extends SubstanceTheme.

Returns:
The value that specifies the global Substance theme. If not null, should be a fully-qualified class name of a class that extends SubstanceTheme.

getWatermarkProperty

java.lang.String getWatermarkProperty()
Returns the value that specifies the global Substance watermark. If not null, should be a fully-qualified class name of a class that implements SubstanceWatermark.

Returns:
The value that specifies the global Substance watermark. If not null, should be a fully-qualified class name of a class that implements SubstanceWatermark.

getWatermarkImageProperty

java.lang.String getWatermarkImageProperty()
Returns the value that specifies the image location for image-based watermark. This value is relevant only if the getWatermarkProperty() returns the class name of SubstanceImageWatermark. The value can point at either the local file or remote HTTP-based file.

Returns:
The value that specifies the image location for image-based watermark.

getWatermarkImageKindProperty

SubstanceConstants.ImageWatermarkKind getWatermarkImageKindProperty()
Returns the value that specifies the kind of image-based watermark. This value is relevant only if the getWatermarkProperty() returns the class name of SubstanceImageWatermark.

Returns:
The value that specifies the kind of image-based watermark.

getWatermarkImageOpacityProperty

java.lang.Float getWatermarkImageOpacityProperty()
Returns the value that specifies the opacity of image-based watermark. This value is relevant only if the getWatermarkProperty() returns the class name of SubstanceImageWatermark.

Returns:
The value that specifies the opacity of image-based watermark.

toBleedWatermark

boolean toBleedWatermark()
Returns indication whether the watermark should "bleed" through usuallu opaque controls, such as trees, lists, tables and text controls (text field, text area, etc).

Returns:
Indication whether the watermark should "bleed" through usuallu opaque controls.

getButtonShaperProperty

java.lang.String getButtonShaperProperty()
Returns the value that specifies the global Substance button shaper. If not null, should be a fully-qualified class name of a class that implements SubstanceButtonShaper.

Returns:
The value that specifies the global Substance button shaper. If not null, should be a fully-qualified class name of a class that implements SubstanceButtonShaper.

getGradientPainterProperty

java.lang.String getGradientPainterProperty()
Returns the value that specifies the global Substance gradient painter. If not null, should be a fully-qualified class name of a class that implements SubstanceGradientPainter.

Returns:
The value that specifies the global Substance gradient painter. If not null, should be a fully-qualified class name of a class that implements SubstanceGradientPainter.

getTitlePainterProperty

java.lang.String getTitlePainterProperty()
Returns the value that specifies the global Substance title painter. If not null, should be a fully-qualified class name of a class that implements SubstanceTitlePainter.

Returns:
The value that specifies the global Substance title painter. If not null, should be a fully-qualified class name of a class that implements SubstanceTitlePainter.

getBorderPainterProperty

java.lang.String getBorderPainterProperty()
Returns the value that specifies the global Substance border painter. If not null, should be a fully-qualified class name of a class that implements SubstanceBorderPainter.

Returns:
The value that specifies the global Substance border painter. If not null, should be a fully-qualified class name of a class that implements SubstanceBorderPainter.

toShowHeapStatusPanelProperty

java.lang.String toShowHeapStatusPanelProperty()
Returns the indication for showing the heap status panel in the custom-decorated title panes. If the value is null, no heap status panel will be shown, if the value is an empty string, the heap status panel will be shown. Otherwise, the value is taken to be the filename for logging the heap status information (and the heap status panel will be shown).

Returns:
Indication for showing the heap status panel in the custom-decorated title panes. Possible return values:
  • If the value is null, no heap status panel will be shown.
  • If the value is an empty string, the heap status panel will be shown.
  • Otherwise, the value is taken to be the filename for logging the heap status information (and the heap status panel will be shown).

toShowExtraElementProperty

boolean toShowExtraElementProperty()
Returns the indication whether Substance can add additional UI elements (such as system menu items, menu search panel).

Returns:
true if Substance can add additional UI elements (such as system menu items, menu search panel), false otherwise.

getTraceFileNameProperty

java.lang.String getTraceFileNameProperty()
Returns the name of the trace file. The trace file will contain output of the memory analyser which can be used to pinpoint the memory leaks.

Returns:
The name of the trace file for memory analysis. If null, the tracing mechanism will not be activated.

toEnableInvertedThemes

boolean toEnableInvertedThemes()
Returns the indication whether Substance should enable inverted color themes.

Returns:
true if Substance should enable inverted color themes, false otherwise.

toEnableNegatedThemes

boolean toEnableNegatedThemes()
Returns the indication whether Substance should enable negated color themes.

Returns:
true if Substance should enable negated color themes, false otherwise.

isDebugUiMode

boolean isDebugUiMode()
Returns the indication whether Substance is running the application under debug UI mode.

Returns:
true if Substance is running the application under debug UI mode, false otherwise.