LayoutConstraintsDescriptor (Drombler Commons 1.0 API)

java.lang.Object
- org.drombler.commons.docking.LayoutConstraintsDescriptor

All Implemented Interfaces:

org.softsmithy.lib.beans.Bean
```
public final class LayoutConstraintsDescriptor
extends Object
implements org.softsmithy.lib.beans.Bean
```
The layout constraints of a Docking Area.

Author:

puce

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`FLEXIBLE_PREF` The default value for flexible heights or widths.
`static String`	`PREF_HEIGHT_PROPERTY_NAME` The name of the 'prefHeight' property.
`static String`	`PREF_WIDTH_PROPERTY_NAME` The name of the 'prefWidth' property.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)`
`boolean`	`equals(Object obj)`
`static LayoutConstraintsDescriptor`	`flexible()` Gets a LayoutConstraintsDescriptor with a flexible width and a flexible height.
`static LayoutConstraintsDescriptor`	`getLayoutConstraints(double prefWidth, double prefHeight)` Gets a LayoutConstraintsDescriptor with the specified preferred width and preferred height.
`double`	`getPrefHeight()` Gets the preferred height of the Docking Area.
`double`	`getPrefWidth()` Gets the preferred width of the Docking Area.
`int`	`hashCode()`
`static boolean`	`isFlexible(double size)` Checks if a size is negative and thus considered flexible.
`static boolean`	`isPreferred(double size)` Checks if a size is non-negative and thus considered preferred.
`static LayoutConstraintsDescriptor`	`prefHeight(double prefHeight)` Gets a LayoutConstraintsDescriptor with the specified preferred height and a flexible width.
`static LayoutConstraintsDescriptor`	`prefWidth(double prefWidth)` Gets a LayoutConstraintsDescriptor with the specified preferred width and a flexible height.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)`
`void`	`setPrefHeight(double prefHeight)` Sets the preferred height of the Docking Area.
`void`	`setPrefWidth(double prefWidth)` Sets the preferred width of the Docking Area.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PREF_WIDTH_PROPERTY_NAME
```
public static final String PREF_WIDTH_PROPERTY_NAME
```
    The name of the 'prefWidth' property.
    
    See Also:
    
    getPrefWidth(), Constant Field Values
  - PREF_HEIGHT_PROPERTY_NAME
```
public static final String PREF_HEIGHT_PROPERTY_NAME
```
    The name of the 'prefHeight' property.
    
    See Also:
    
    getPrefHeight(), Constant Field Values
  - FLEXIBLE_PREF
```
public static final double FLEXIBLE_PREF
```
    The default value for flexible heights or widths.
    
    See Also:
    
    isFlexible(double), Constant Field Values
- Method Detail
  - getLayoutConstraints
```
public static LayoutConstraintsDescriptor getLayoutConstraints(double prefWidth,
                                                               double prefHeight)
```
    Gets a LayoutConstraintsDescriptor with the specified preferred width and preferred height.
    
    Parameters:
    
    prefWidth - the preferred width of the Docking Area. Can be negative to indicate a flexible width.
    
    prefHeight - the preferred height of the Docking Area. Can be negative to indicate a flexible height.
    
    Returns:
    
    a LayoutConstraintsDescriptor with the specified preferred width and preferred height
  - prefWidth
```
public static LayoutConstraintsDescriptor prefWidth(double prefWidth)
```
    Gets a LayoutConstraintsDescriptor with the specified preferred width and a flexible height.
    
    Parameters:
    
    prefWidth - the preferred width of the Docking Area. Can be negative to indicate a flexible width.
    
    Returns:
    
    a LayoutConstraintsDescriptor with the specified preferred width and a flexible height
  - prefHeight
```
public static LayoutConstraintsDescriptor prefHeight(double prefHeight)
```
    Gets a LayoutConstraintsDescriptor with the specified preferred height and a flexible width.
    
    Parameters:
    
    prefHeight - the preferred height of the Docking Area. Can be negative to indicate a flexible height.
    
    Returns:
    
    a LayoutConstraintsDescriptor with the specified preferred height and a flexible width
  - flexible
```
public static LayoutConstraintsDescriptor flexible()
```
    Gets a LayoutConstraintsDescriptor with a flexible width and a flexible height.
    
    Returns:
    
    a LayoutConstraintsDescriptor with a flexible width and a flexible height
  - getPrefWidth
```
public double getPrefWidth()
```
    Gets the preferred width of the Docking Area. Can be negative to indicate a flexible width.
    
    Returns:
    
    the preferred width of the Docking Area
  - setPrefWidth
```
public void setPrefWidth(double prefWidth)
```
    Sets the preferred width of the Docking Area. Can be negative to indicate a flexible width.
    
    This is a bound property.
    
    Parameters:
    
    prefWidth - the preferred width of the Docking Area. Can be negative to indicate a flexible width.
  - getPrefHeight
```
public double getPrefHeight()
```
    Gets the preferred height of the Docking Area. Can be negative to indicate a flexible height.
    
    Returns:
    
    the preferred height of the Docking Area
  - setPrefHeight
```
public void setPrefHeight(double prefHeight)
```
    Sets the preferred height of the Docking Area. Can be negative to indicate a flexible height.
    
    This is a bound property.
    
    Parameters:
    
    prefHeight - the preferred height of the Docking Area. Can be negative to indicate a flexible height.
  - isFlexible
```
public static boolean isFlexible(double size)
```
    Checks if a size is negative and thus considered flexible.
    
    Parameters:
    
    size - the size
    
    Returns:
    
    true, if it should be considered a flexible size, else false
  - isPreferred
```
public static boolean isPreferred(double size)
```
    Checks if a size is non-negative and thus considered preferred.
    
    Parameters:
    
    size - the size
    
    Returns:
    
    true, if it should be considered a preferred size, else false
  - addPropertyChangeListener
```
public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)
```
    Specified by:
    
    addPropertyChangeListener in interface org.softsmithy.lib.beans.Bean
  - removePropertyChangeListener
```
public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)
```
    Specified by:
    
    removePropertyChangeListener in interface org.softsmithy.lib.beans.Bean
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class LayoutConstraintsDescriptor

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREF_WIDTH_PROPERTY_NAME

PREF_HEIGHT_PROPERTY_NAME

FLEXIBLE_PREF

Method Detail

getLayoutConstraints

prefWidth

prefHeight

flexible

getPrefWidth

setPrefWidth

getPrefHeight

setPrefHeight

isFlexible

isPreferred

addPropertyChangeListener

removePropertyChangeListener

toString

hashCode

equals