public abstract class AbstractI15dPanelBuilder extends PanelBuilder
PanelBuilder
this class provides convenience behavior to map
resource keys to their associated internationalized (i15d) strings
when adding labels, titles and titled separators.
The localized texts used in methods #addI15d*
can be
marked texts, i.e. strings with an optional mnemonic marker.
See the MnemonicUtils
class comment for details.
For debugging purposes you can automatically set a tooltip for the
created labels that show its resource key. In case of an inproper
resource localization, the label will show the wrong text, and the tooltip
will help you identify the resource key with the broken localization.
This feature can be enabled by calling setDebugToolTipsEnabled
.
If you want to enable it in a deployed application, you can set the system
parameter I15dPanelBuilder.debugToolTipsEnabled
to "true".
Subclasses must implement the conversion from resource key
to the localized string in #getI15dString(String)
.
For example class I15dPanelBuilder gets a ResourceBundle during
construction, and requests strings from that bundle.
currentCellConstraints
Modifier | Constructor and Description |
---|---|
protected |
AbstractI15dPanelBuilder(FormLayout layout)
Constructs an AbstractI15dPanelBuilder for the given layout.
|
protected |
AbstractI15dPanelBuilder(FormLayout layout,
javax.swing.JPanel container)
Constructs an AbstractI15dPanelBuilder
for the given FormLayout and layout container.
|
Modifier and Type | Method and Description |
---|---|
javax.swing.JLabel |
addI15dLabel(java.lang.String resourceKey,
CellConstraints constraints)
Adds an internationalized (i15d) textual label to the form using the
specified constraints.
|
javax.swing.JLabel |
addI15dLabel(java.lang.String resourceKey,
CellConstraints labelConstraints,
java.awt.Component component,
CellConstraints componentConstraints)
Adds an internationalized (i15d) label and component to the panel using
the given cell constraints.
|
javax.swing.JLabel |
addI15dLabel(java.lang.String resourceKey,
java.lang.String encodedConstraints)
Adds an internationalized (i15d) textual label to the form using the
specified constraints.
|
javax.swing.JLabel |
addI15dROLabel(java.lang.String resourceKey,
CellConstraints constraints)
Adds an internationalized (i15d) textual label to the form using the
specified constraints that is intended to label a read-only component.
|
javax.swing.JLabel |
addI15dROLabel(java.lang.String resourceKey,
CellConstraints labelConstraints,
java.awt.Component component,
CellConstraints componentConstraints)
Adds an internationalized (i15d) label and component to the panel using
the given cell constraints.
|
javax.swing.JLabel |
addI15dROLabel(java.lang.String resourceKey,
java.lang.String encodedConstraints)
Adds an internationalized (i15d) textual label to the form using the
specified constraints that is intended to label a read-only component.
|
javax.swing.JComponent |
addI15dSeparator(java.lang.String resourceKey,
CellConstraints constraints)
Adds an internationalized (i15d) titled separator to the form using the
specified constraints.
|
javax.swing.JComponent |
addI15dSeparator(java.lang.String resourceKey,
java.lang.String encodedConstraints)
Adds an internationalized (i15d) titled separator to the form using
the specified constraints.
|
javax.swing.JLabel |
addI15dTitle(java.lang.String resourceKey,
CellConstraints constraints)
Adds a title to the form using the specified constraints.
|
javax.swing.JLabel |
addI15dTitle(java.lang.String resourceKey,
java.lang.String encodedConstraints)
Adds a title to the form using the specified constraints.
|
protected abstract java.lang.String |
getI15dString(java.lang.String resourceKey)
Looks up and returns the internationalized (i15d) string for the given
resource key, for example from a
ResourceBundle or
ResourceMap . |
static boolean |
isDebugToolTipsEnabled()
Returns whether the debug tool tips are enabled or not.
|
static void |
setDebugToolTipsEnabled(boolean b)
Enables or disables the debug tool tips.
|
add, add, addLabel, addLabel, addLabel, addLabel, addROLabel, addROLabel, addROLabel, addROLabel, addSeparator, addSeparator, addSeparator, addSeparator, addTitle, addTitle, addTitle, getLabelForFeatureEnabledDefault, getPanel, isLabelForApplicable, isLabelForFeatureEnabled, setBackground, setBorder, setDefaultDialogBorder, setLabelFor, setLabelForFeatureEnabled, setLabelForFeatureEnabledDefault, setOpaque
add, add, appendColumn, appendColumn, appendGlueColumn, appendGlueRow, appendLabelComponentsGapColumn, appendParagraphGapRow, appendRelatedComponentsGapColumn, appendRelatedComponentsGapRow, appendRow, appendRow, appendUnrelatedComponentsGapColumn, appendUnrelatedComponentsGapRow, cellConstraints, createLeftAdjustedConstraints, getColumn, getColumnIncrementSign, getLeadingColumn, getRow, isLeftToRight, nextColumn, nextColumn, nextLine, nextLine, nextRow, nextRow, setAlignment, setBounds, setColumn, setColumnSpan, setExtent, setHAlignment, setLeftToRight, setOrigin, setRow, setRowSpan, setVAlignment
createComponentFactory, getColumnCount, getComponentFactory, getContainer, getDefaultComponentFactory, getLayout, getRowCount, setComponentFactory, setDefaultComponentFactory
protected AbstractI15dPanelBuilder(FormLayout layout)
layout
- the FormLayout used to lay out the containerjava.lang.NullPointerException
- if layout
is null
protected AbstractI15dPanelBuilder(FormLayout layout, javax.swing.JPanel container)
layout
- the FormLayout used to lay out the containercontainer
- the layout containerjava.lang.NullPointerException
- if layout
or container
is null
public static boolean isDebugToolTipsEnabled()
public static void setDebugToolTipsEnabled(boolean b)
b
- true to enable, false to disablepublic final javax.swing.JLabel addI15dLabel(java.lang.String resourceKey, CellConstraints constraints)
resourceKey
- the resource key for the label's textconstraints
- the label's cell constraintspublic final javax.swing.JLabel addI15dLabel(java.lang.String resourceKey, java.lang.String encodedConstraints)
resourceKey
- the resource key for the label's textencodedConstraints
- a string representation for the constraintspublic final javax.swing.JLabel addI15dLabel(java.lang.String resourceKey, CellConstraints labelConstraints, java.awt.Component component, CellConstraints componentConstraints)
JLabel.setLabelFor(java.awt.Component)
.
Note: The CellConstraints
objects for the label
and the component must be different. Cell constraints are implicitly
cloned by the FormLayout
when added to the container.
However, in this case you may be tempted to reuse a
CellConstraints
object in the same way as with many other
builder methods that require a single CellConstraints
parameter.
The pitfall is that the methods CellConstraints.xy**(...)
just set the coordinates but do not create a new instance.
And so the second invocation of xy***(...)
overrides
the settings performed in the first invocation before the object
is cloned by the FormLayout
.
Wrong:
builder.addI15dLabel("name.key", CC.xy(1, 7), // will be modified by the code below nameField, CC.xy(3, 7) // sets the single instance to (3, 7) );Correct:
builder.addI15dLabel("name.key", CC.xy(1, 7).clone(), // cloned before the next modification nameField, CC.xy(3, 7) // sets this instance to (3, 7) );
resourceKey
- the resource key for the labellabelConstraints
- the label's cell constraintscomponent
- the component to addcomponentConstraints
- the component's cell constraintsjava.lang.IllegalArgumentException
- if the same cell constraints instance
is used for the label and the componentJLabel.setLabelFor(java.awt.Component)
public final javax.swing.JLabel addI15dROLabel(java.lang.String resourceKey, CellConstraints constraints)
resourceKey
- the resource key for the label's textconstraints
- the label's cell constraintspublic final javax.swing.JLabel addI15dROLabel(java.lang.String resourceKey, java.lang.String encodedConstraints)
resourceKey
- the resource key for the label's textencodedConstraints
- a string representation for the constraintspublic final javax.swing.JLabel addI15dROLabel(java.lang.String resourceKey, CellConstraints labelConstraints, java.awt.Component component, CellConstraints componentConstraints)
JLabel.setLabelFor(java.awt.Component)
.
Note: The CellConstraints
objects for the label
and the component must be different. Cell constraints are implicitly
cloned by the FormLayout
when added to the container.
However, in this case you may be tempted to reuse a
CellConstraints
object in the same way as with many other
builder methods that require a single CellConstraints
parameter.
The pitfall is that the methods CellConstraints.xy**(...)
just set the coordinates but do not create a new instance.
And so the second invocation of xy***(...)
overrides
the settings performed in the first invocation before the object
is cloned by the FormLayout
.
Wrong:
builder.addI15dROLabel("name.key", CC.xy(1, 7), // will be modified by the code below nameField, CC.xy(3, 7) // sets the single instance to (3, 7) );Correct:
builder.addI15dROLabel("name.key", CC.xy(1, 7).clone(), // cloned before the next modification nameField, CC.xy(3, 7) // sets this instance to (3, 7) );Better:
builder.addI15dROLabel("name.key", CC.xy(1, 7) // creates a CellConstraints object nameField, CC.xy(3, 7) // creates another CellConstraints object );
resourceKey
- the resource key for the labellabelConstraints
- the label's cell constraintscomponent
- the component to addcomponentConstraints
- the component's cell constraintsjava.lang.IllegalArgumentException
- if the same cell constraints instance
is used for the label and the componentJLabel.setLabelFor(java.awt.Component)
public final javax.swing.JComponent addI15dSeparator(java.lang.String resourceKey, CellConstraints constraints)
resourceKey
- the resource key for the separator titleconstraints
- the separator's cell constraintspublic final javax.swing.JComponent addI15dSeparator(java.lang.String resourceKey, java.lang.String encodedConstraints)
resourceKey
- the resource key for the separator titleencodedConstraints
- a string representation for the constraintspublic final javax.swing.JLabel addI15dTitle(java.lang.String resourceKey, CellConstraints constraints)
resourceKey
- the resource key for the separator titleconstraints
- the separator's cell constraintspublic final javax.swing.JLabel addI15dTitle(java.lang.String resourceKey, java.lang.String encodedConstraints)
resourceKey
- the resource key for the separator titleencodedConstraints
- a string representation for the constraintsprotected abstract java.lang.String getI15dString(java.lang.String resourceKey)
ResourceBundle
or
ResourceMap
.resourceKey
- the key to look for in the resource mapjava.lang.IllegalStateException
- if the localization is not possible,
for example, because no ResourceBundle
has been setCopyright © 2002-2011 JGoodies Karsten Lentzsch. All Rights Reserved.