net.miginfocom.layout

Class ConstraintParser

java.lang.Object

net.miginfocom.layout.ConstraintParser

public final class ConstraintParser
extends java.lang.Object

Parses string constraints.

Method Summary

Modifier and Type	Method and Description
static BoundSize	parseBoundSize(java.lang.String s, boolean isGap, boolean isHor) Parses a single "min:pref:max" value.
static AC	parseColumnConstraints(java.lang.String s) Parses the column or rows constraints.
static CC	parseComponentConstraint(java.lang.String s) Parses one component constraint and returns the parsed value.
static java.util.Map<ComponentWrapper,CC>	parseComponentConstraints(java.util.Map<ComponentWrapper,java.lang.String> constrMap) Parses all component constraints and stores the parsed values in the transient (cache) member varables.
static UnitValue[]	parseInsets(java.lang.String s, boolean acceptPanel) Parses insets which consists of 1-4 UnitValues.
static LC	parseLayoutConstraint(java.lang.String s) Parses the layout constraints and stores the parsed values in the transient (cache) member varables.
static AC	parseRowConstraints(java.lang.String s) Parses the column or rows constraints.
static UnitValue	parseUnitValue(java.lang.String s, boolean isHor) Parses a single unit value.
static UnitValue	parseUnitValueOrAlign(java.lang.String s, boolean isHor, UnitValue emptyReplacement) Parses a single unit value that may also be an alignment as parsed by parseAlignKeywords(String, boolean).
static java.lang.String	prepare(java.lang.String s) Makes null "", trims and converts to lower case.

Methods inherited from class java.lang.Object

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

Method Detail

parseLayoutConstraint

public static LC parseLayoutConstraint(java.lang.String s)

Parses the layout constraints and stores the parsed values in the transient (cache) member varables.

Parameters:

s - The String to parse. Should not be null and must be lower case and trimmed.

Returns:

The parsed constraint. Never null.

Throws:

java.lang.RuntimeException - if the constaint was not valid.

parseRowConstraints

public static AC parseRowConstraints(java.lang.String s)

Parses the column or rows constraints. They normally looks something like "[min:pref]rel[10px][]".

Parameters:

s - The string to parse. Not null.

Returns:

An array of DimConstraints that is as many are there exist "[...]" sections in the string that is parsed.

Throws:

java.lang.RuntimeException - if the constraint was not valid.

parseColumnConstraints

public static AC parseColumnConstraints(java.lang.String s)

Parses the column or rows constraints. They normally looks something like "[min:pref]rel[10px][]".

Parameters:

s - The string to parse. Not null.

Returns:

An array of DimConstraints that is as many are there exist "[...]" sections in the string that is parsed.

Throws:

java.lang.RuntimeException - if the constraint was not valid.

parseComponentConstraints

public static java.util.Map<ComponentWrapper,CC> parseComponentConstraints(java.util.Map<ComponentWrapper,java.lang.String> constrMap)

Parses all component constraints and stores the parsed values in the transient (cache) member varables.

Parameters:

constrMap - The constraints as Strings. Strings must be lower case and trimmed

Returns:

The parsed constraints. Never null.

parseComponentConstraint

public static CC parseComponentConstraint(java.lang.String s)

Parses one component constraint and returns the parsed value.

Parameters:

s - The string to parse. Should not be null and must be lower case and trimmed.

Returns:

The parsed constraint. Never null.

Throws:

java.lang.RuntimeException - if the constaint was not valid.

parseInsets

public static UnitValue[] parseInsets(java.lang.String s,
                                      boolean acceptPanel)

Parses insets which consists of 1-4 UnitValues.

Parameters:

s - The string to parse. E.g. "10 10 10 10" or "20". If less than 4 groups the last will be used for the missing.

acceptPanel - If "panel" and "dialog" should be accepted. They are used to access platform defaults.

Returns:

An array of length 4 with the parsed insets.

Throws:

java.lang.IllegalArgumentException - if the parsing could not be done.

parseBoundSize

public static BoundSize parseBoundSize(java.lang.String s,
                                       boolean isGap,
                                       boolean isHor)

Parses a single "min:pref:max" value. May look something like "10px:20lp:30%" or "pref!".

Parameters:

s - The string to parse. Not null.

isGap - If this bound size is a gap (different empty string handling).

isHor - If the size is for the horizontal dimension.

Returns:

A bound size that may be null if the string was "null", "n" or null.

parseUnitValueOrAlign

public static UnitValue parseUnitValueOrAlign(java.lang.String s,
                                              boolean isHor,
                                              UnitValue emptyReplacement)

Parses a single unit value that may also be an alignment as parsed by parseAlignKeywords(String, boolean).

Parameters:

s - The string to parse. Not null. May look something like "10px" or "5dlu".

isHor - If the value is for the horizontal dimension.

emptyReplacement - A replacement if s is empty. May be null.

Returns:

The parsed unit value. May be null.

parseUnitValue

public static UnitValue parseUnitValue(java.lang.String s,
                                       boolean isHor)

Parses a single unit value. E.g. "10px" or "5in"

Parameters:

s - The string to parse. Not null. May look something like "10px" or "5dlu".

isHor - If the value is for the horizontal dimension.

Returns:

The parsed unit value. null is empty string,

prepare

public static java.lang.String prepare(java.lang.String s)

Makes null "", trims and converts to lower case.

Parameters:

s - The string

Returns:

Not null.