de.winterdrache.layout
Class MSBLayout.ConstraintsFactory

java.lang.Object
  de.winterdrache.layout.MSBLayout.ConstraintsFactory

Enclosing class:

MSBLayout

public static class MSBLayout.ConstraintsFactory
extends Object

When a new box is added to an MSBLayout without an accompanying Constraints object, MSBLayout uses a ConstraintsFactory to provide the Constraints. MSBLayout.getConstraintsFactory() returns the factory used.

For Components the MSBLayout.ConstraintsFactory maps the Component's Class to the Constraints to be used for the component box. The Constraints for hboxes, vboxes and glues are accessed via the constants HBOX, VBOX and GLUE. When the factory has no specialized set of constraints defined for a class, it returns a default set of constraints, never null.

API Reference

Follow this link to skip ahead to the API reference.

Default Constraints

Common for all classes

halign	-1.0f (= justify)
valign	-1.0f (= justify)
padding	(0,0)
hscale	1.0f
vscale	1.0f
hweight	100*
vweight	100*
hshrink	100*
vshrink	100*

* does not apply to glues

Special

classes	HBOX, VBOX
hfill	2 (= grow width to fill space regardless of preferred width)
vfill	2 (= grow height to fill space regardless of preferred height)
margin	(Gap.DEFER, Gap.DEFER, Gap.DEFER, Gap.DEFER)

class	GLUE
hfill	1 (= grow width to fill space up to glue's set maximum width)
vfill	1 (= grow width to fill space up to glue's set maximum width)
margin	(Gap.DEFER, Gap.DEFER, Gap.DEFER, Gap.DEFER)
hweight	MAX_WEIGHT_SHRINK
vweight	MAX_WEIGHT_SHRINK
hshrink	MAX_WEIGHT_SHRINK
vshrink	MAX_WEIGHT_SHRINK

Component classes

class	JSeparator
hfill	1 (= grow width to fill space up to separator's maximum width)
vfill	1 (= grow height to fill space up to separator's maximum height)
margin	(Gap.WEAK_UNRELATED, Gap.WEAK_UNRELATED, Gap.WEAK_UNRELATED, Gap.WEAK_UNRELATED)

classes	JTextField, JFormattedTextField, JPasswordField, JComboBox, JProgressBar
hfill	1 (= grow width to fill space up to component's maximum width)
vfill	0 (= insist on preferred height)
margin	(Gap.WEAK_RELATED, Gap.WEAK_RELATED, Gap.WEAK_RELATED, Gap.WEAK_RELATED)

classes	JTextArea, JEditorPane, JTextPane, JSplitPane, JScrollPane, JLayeredPane, JDesktopPane, JSlider, JScrollBar, JPanel, JTabbedPane, JFileChooser, JColorChooser, Box.Filler
hfill	1 (= grow width to fill space up to component's maximum width)
vfill	1 (= grow height to fill space up to component's maximum height)
margin	(Gap.WEAK_RELATED, Gap.WEAK_RELATED, Gap.WEAK_RELATED, Gap.WEAK_RELATED)

classes	all others
hfill	0 (= insist on preferred width)
vfill	0 (= insist on preferred height)
margin	(Gap.WEAK_RELATED, Gap.WEAK_RELATED, Gap.WEAK_RELATED, Gap.WEAK_RELATED)

Author:

Matthias S. Benkmann

Field Summary

protected MSBLayout.MutableConstraints	defaultConstraints The Constraints returned when mapClass2Constraints does not contain a mapping for a given class.
static Class<?>	GLUE Constant for accessing the Constraints for a glue;
static Class<?>	HBOX Constant for accessing the Constraints for a hbox.
protected Map<Class<?>,MSBLayout.MutableConstraints>	mapClass2Constraints Maps a Class to a MutableConstraints object that holds the constraints for that class.
static Class<?>	VBOX Constant for accessing the Constraints for a vbox;

Constructor Summary

MSBLayout.ConstraintsFactory()
Creates a new ConstraintsFactory that contains only a default Constraints object but no specialized constraints.

MSBLayout.ConstraintsFactory(MSBLayout.ConstraintsFactory orig)
Creates a new ConstraintsFactory that starts with an independent copy of all Constraints from orig.

Method Summary

Iterable<Class<?>>	classes() Returns all the classes for which this ConstraintsFactory has specialized Constraints.
MSBLayout.Constraints	getConstraintsFor(Class<?> cls) Returns Constraints to be used for the component boxes around objects of Class cls.
MSBLayout.Constraints	getConstraintsForHBox() The same as getConstraintsFor(MSBLayout.ConstraintsFactory.HBOX).
MSBLayout.Constraints	getConstraintsForVBox() The same as getConstraintsFor(MSBLayout.ConstraintsFactory.VBOX).
MSBLayout.MutableConstraints	modifyConstraintsFor(Class<?> cls) Returns a MutableConstraints object that you can modify to affect all future calls to getConstraintsFor(Class) for the given class.
MSBLayout.MutableConstraints	modifyConstraintsForHBox() The same as modifyConstraintsFor(MSBLayout.ConstraintsFactory.HBOX).
MSBLayout.MutableConstraints	modifyConstraintsForVBox() The same as modifyConstraintsFor(MSBLayout.ConstraintsFactory.VBOX).
MSBLayout.MutableConstraints	modifyDefaultConstraints() Returns a MutableConstraints object that you can modify to affect all future calls to getConstraintsFor(Class) for classes that have no specialized constraints.
void	setConstraintsFor(Class<?> cls, MSBLayout.Constraints constraints) Tells this factory to return the given constraints on future calls to getConstraintsFor(Class) for class cls.
void	setDefaultConstraints(MSBLayout.Constraints constraints) Tells this factory to use the given constraints Object as the Constraints to be used whenever no specialized constraints have been defined.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HBOX

public static final Class<?> HBOX

Constant for accessing the Constraints for a hbox.

VBOX

public static final Class<?> VBOX

Constant for accessing the Constraints for a vbox;

GLUE

public static final Class<?> GLUE

Constant for accessing the Constraints for a glue;

mapClass2Constraints

protected Map<Class<?>,MSBLayout.MutableConstraints> mapClass2Constraints

Maps a Class to a MutableConstraints object that holds the constraints for that class.

See Also:

HBOX, VBOX, GLUE, defaultConstraints

defaultConstraints

protected MSBLayout.MutableConstraints defaultConstraints

The Constraints returned when mapClass2Constraints does not contain a mapping for a given class.

Constructor Detail

MSBLayout.ConstraintsFactory

public MSBLayout.ConstraintsFactory()

Creates a new ConstraintsFactory that contains only a default Constraints object but no specialized constraints.

MSBLayout.ConstraintsFactory

public MSBLayout.ConstraintsFactory(MSBLayout.ConstraintsFactory orig)

Creates a new ConstraintsFactory that starts with an independent copy of all Constraints from orig. If you want to start out with the default set of Constraints, you can pass MSBLayout.getDefaultConstraintsFactory(). If you want to create a ConstraintsFactory that only has one default Constraints object but no specialized constraints, then pass null.

Method Detail

getConstraintsFor

public MSBLayout.Constraints getConstraintsFor(Class<?> cls)

Returns Constraints to be used for the component boxes around objects of Class cls. Usually cls would be one of the Swing UI classes such as JTextField.class. The special constants HBOX and VBOX can be used to access the Constraints for hboxes and vboxes and the special constant GLUE accesses the constraints for glues.

If this factory has no specialized constraints for the given class, it will return a default Constraints object, i.e. this method never returns null.

See Also:

modifyConstraintsFor(Class), modifyDefaultConstraints(), getConstraintsForHBox(), getConstraintsForVBox(), modifyConstraintsForHBox(), modifyConstraintsForVBox(), setConstraintsFor(Class, de.winterdrache.layout.MSBLayout.Constraints)

setConstraintsFor

public void setConstraintsFor(Class<?> cls,
                              MSBLayout.Constraints constraints)

Tells this factory to return the given constraints on future calls to getConstraintsFor(Class) for class cls.

modifyConstraintsFor

public MSBLayout.MutableConstraints modifyConstraintsFor(Class<?> cls)

Returns a MutableConstraints object that you can modify to affect all future calls to getConstraintsFor(Class) for the given class. The Constraints object is initialized with the current constraints associated with cls. You should make all your changes to the returned object right away. Modifications to the object after any further method calls to the factory may or may not have an effect.

See Also:

getConstraintsFor(Class), setConstraintsFor(Class, de.winterdrache.layout.MSBLayout.Constraints)

modifyDefaultConstraints

public MSBLayout.MutableConstraints modifyDefaultConstraints()

Returns a MutableConstraints object that you can modify to affect all future calls to getConstraintsFor(Class) for classes that have no specialized constraints. You should make all your changes to the returned object right away. Modifications to the object after any further method calls to the factory may or may not have an effect.

setDefaultConstraints

public void setDefaultConstraints(MSBLayout.Constraints constraints)

Tells this factory to use the given constraints Object as the Constraints to be used whenever no specialized constraints have been defined.

getConstraintsForHBox

public MSBLayout.Constraints getConstraintsForHBox()

The same as getConstraintsFor(MSBLayout.ConstraintsFactory.HBOX).

See Also:

getConstraintsFor(Class), modifyConstraintsFor(Class)

getConstraintsForVBox

public MSBLayout.Constraints getConstraintsForVBox()

The same as getConstraintsFor(MSBLayout.ConstraintsFactory.VBOX).

See Also:

getConstraintsFor(Class), modifyConstraintsFor(Class)

modifyConstraintsForHBox

public MSBLayout.MutableConstraints modifyConstraintsForHBox()

The same as modifyConstraintsFor(MSBLayout.ConstraintsFactory.HBOX). You should make all your changes to the returned object right away. Modifications to the object after any further method calls to the factory may or may not have an effect.

See Also:

modifyConstraintsFor(Class), getConstraintsFor(Class)

modifyConstraintsForVBox

public MSBLayout.MutableConstraints modifyConstraintsForVBox()

The same as modifyConstraintsFor(MSBLayout.ConstraintsFactory.VBOX). You should make all your changes to the returned object right away. Modifications to the object after any further method calls to the factory may or may not have an effect.

See Also:

modifyConstraintsFor(Class), getConstraintsFor(Class)

classes

public Iterable<Class<?>> classes()

Returns all the classes for which this ConstraintsFactory has specialized Constraints. For all other classes getConstraintsFor(Class) will return a default set of Constraints. Note that the iteration will contain HBOX and/or VBOX and/or GLUE if the factory has specialized constraints for hboxes, vboxes and/or glues respectively.