Package io.guise.framework.component.layout

Class RegionLayout

java.lang.Object
com.globalmentor.beans.BoundPropertyObject
io.guise.framework.event.GuiseBoundPropertyObject
io.guise.framework.component.layout.AbstractLayout<RegionConstraints>
io.guise.framework.component.layout.RegionLayout
All Implemented Interfaces:
com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, Layout<RegionConstraints>
public class RegionLayout extends AbstractLayout<RegionConstraints>
A layout that defines locations of components in internationalized relative terms. This layout uses default constraints of Region.CENTER.

The region will span two of the components, if present, across the perpendicular flow. Which flow is spanned across the other is determined by setting setSpanFlow(Flow). For example, in a right-to-left top-to-bottom orientation, a span flow of Flow.LINE (the default) will result in the top and bottom components spanning across the space used by the left, center, and right components.

Author:
Garret Wilson
See Also:

  • Field Details

    • FIXED_PROPERTY

      public static final String FIXED_PROPERTY
      The bound property of the fixed setting.

    • LINE_ALIGNMENT_PROPERTY

      public static final String LINE_ALIGNMENT_PROPERTY
      The bound property of the line alignment.

    • PAGE_ALIGNMENT_PROPERTY

      public static final String PAGE_ALIGNMENT_PROPERTY
      The bound property of the page alignment.

    • LINE_EXTENT_PROPERTY

      public static final String LINE_EXTENT_PROPERTY
      The line extent (width in left-to-right top-to-bottom orientation) bound property.

    • PAGE_EXTENT_PROPERTY

      public static final String PAGE_EXTENT_PROPERTY
      The page extent (height in left-to-right top-to-bottom orientation) bound property.

    • PADDING_LINE_NEAR_EXTENT_PROPERTY

      public static final String PADDING_LINE_NEAR_EXTENT_PROPERTY
      The bound property of the line near padding extent.

    • PADDING_LINE_FAR_EXTENT_PROPERTY

      public static final String PADDING_LINE_FAR_EXTENT_PROPERTY
      The bound property of the line far padding extent.

    • PADDING_PAGE_NEAR_EXTENT_PROPERTY

      public static final String PADDING_PAGE_NEAR_EXTENT_PROPERTY
      The bound property of the page near padding extent.

    • PADDING_PAGE_FAR_EXTENT_PROPERTY

      public static final String PADDING_PAGE_FAR_EXTENT_PROPERTY
      The bound property of the page far padding extent.

    • SPAN_FLOW_PROPERTY

      public static final String SPAN_FLOW_PROPERTY
      The bound property of the span flow.

  • Constructor Details

    • RegionLayout

      public RegionLayout()
      Default constructor with Flow.LINE span flow.

    • RegionLayout

      public RegionLayout(Flow spanFlow)
      Span flow constructor.
      Parameters:
      spanFlow - The logical axis which will span components across the other logical axis.
      Throws:
      NullPointerException - if the given span flow is null.

  • Method Details

    • isFixed

      public boolean isFixed()
      Returns:
      whether the sizes of the regions are fixed or will dynamically change to support the given content.

    • setFixed

      public void setFixed(boolean newFixed)
      Sets whether the sizes of the regions are fixed or will dynamically change to support the given content. This is a bound property of type Boolean.
      Parameters:
      newFixed - true if the sizes of the regions are fixed, or false if the regions will dynamically change to support the given content.
      See Also:

    • getAlignment

      public double getAlignment(Flow flow)
      Returns the default alignment of the indicated flow relative to the beginning of the alignment axis.
      Parameters:
      flow - The flow for which an alignment should be returned.
      Returns:
      The alignment of the given flow.

    • getLineAlignment

      public double getLineAlignment()
      Returns:
      The default alignment of the line flow relative to the beginning of the alignment axis.

    • getPageAlignment

      public double getPageAlignment()
      Returns:
      The default alignment of the page flow relative to the beginning of the alignment axis.

    • setAlignment

      public void setAlignment(Flow flow, double newAlignment)
      Sets the alignment of a given flow. This method also acts as a convenience method by unconditionally updating the flow alignment of the region constraints of any child components of this layout's owner. The alignment of each flow represents a bound property of type Double.
      Parameters:
      flow - The flow for which the alignment should be set.
      newAlignment - The alignment of the region relative to the beginning of the given flow.
      Throws:
      NullPointerException - if the given flow is null.
      See Also:

    • setLineAlignment

      public void setLineAlignment(double newAlignment)
      Sets the default alignment of the line flow. For example, in a left-to-right top-to-bottom orientation, line alignments of 0.0, 0.5, and 1.0 would be equivalent to what are commonly known as left, center, and right alignments, respectively. This method also acts as a convenience method by unconditionally updating the line alignment of the region constraints of any child components of this layout's owner. This is a bound property of type Double.
      Parameters:
      newAlignment - The line alignment of the region relative to the beginning of the alignment axis.
      See Also:

    • setPageAlignment

      public void setPageAlignment(double newAlignment)
      Sets the alignment of the page flow. For example, in a left-to-right top-to-bottom orientation, page alignments of 0.0, 0.5, and 1.0 would be equivalent to what are commonly known as top, middle, and bottom alignments, respectively. This method also acts as a convenience method by unconditionally updating the page alignment of the region constraints of any child components of this layout's owner. This is a bound property of type Double.
      Parameters:
      newAlignment - The page alignment of the region relative to the beginning of the alignment axis.
      See Also:

    • getExtent

      public Extent getExtent(Flow flow)
      Returns the default extent of the indicated flow.
      Parameters:
      flow - The flow for which an extent should be returned.
      Returns:
      The extent of the given flow.

    • getLineExtent

      public Extent getLineExtent()
      Returns the default extent of the line flow. In left-to-right top-to-bottom orientation, this is commonly known as the width.
      Returns:
      The extent of the flow, or null if no preferred extent has been specified

    • getPageExtent

      public Extent getPageExtent()
      Returns the default extent of the page flow. In left-to-right top-to-bottom orientation, this is commonly known as the height.
      Returns:
      The extent of the flow, or null if no preferred extent has been specified

    • setExtent

      public void setExtent(Flow flow, Extent newExtent)
      Sets the default extent of a given flow. This method also acts as a convenience method by unconditionally updating the extent of any child components of this layout's owner. The extent of each flow represents a bound property.
      Parameters:
      flow - The flow for which the extent should be set.
      newExtent - The new requested extent of the region, or null there is no extent preference.
      Throws:
      NullPointerException - if the given flow is null.
      See Also:

    • setLineExtent

      public void setLineExtent(Extent newExtent)
      Sets the default extent of the line flow. In left-to-right top-to-bottom orientation, this is commonly known as the width. This method also acts as a convenience method by unconditionally updating the extent of any child components of this layout's owner. This is a bound property.
      Parameters:
      newExtent - The new requested extent of the region, or null there is no extent preference.
      See Also:

    • setPageExtent

      public void setPageExtent(Extent newExtent)
      Sets the default extent of the page flow. In left-to-right top-to-bottom orientation, this is commonly known as the height. This method also acts as a convenience method by unconditionally updating the extent of any child components of this layout's owner. This is a bound property.
      Parameters:
      newExtent - The new requested extent of the region, or null there is no extent preference.
      See Also:

    • getPaddingExtent

      public Extent getPaddingExtent(Border border)
      Returns the default padding extent of the indicated border.
      Parameters:
      border - The border for which a padding extent should be returned.
      Returns:
      The padding extent of the given border.

    • getPaddingLineNearExtent

      public Extent getPaddingLineNearExtent()
      Returns the default padding extent of the line near page near border.
      Returns:
      The padding extent of the given border.

    • getPaddingLineFarExtent

      public Extent getPaddingLineFarExtent()
      Returns the default padding extent of the line far page near border.
      Returns:
      The padding extent of the given border.

    • getPaddingPageNearExtent

      public Extent getPaddingPageNearExtent()
      Returns the default padding extent of the line near page far border.
      Returns:
      The padding extent of the given border.

    • getPaddingPageFarExtent

      public Extent getPaddingPageFarExtent()
      Returns the default padding extent of the line far page far border.
      Returns:
      The padding extent of the given border.

    • setPaddingExtent

      public void setPaddingExtent(Border border, Extent newPaddingExtent)
      Sets the default padding extent of a given border. This method also acts as a convenience method by unconditionally updating the padding extent of the region constraints of any child components of this layout's owner. The padding extent of each border represents a bound property.
      Parameters:
      border - The border for which the padding extent should be set.
      newPaddingExtent - The padding extent.
      Throws:
      NullPointerException - if the given border and/or padding extent is null.
      See Also:

    • setPaddingLineNearExtent

      public void setPaddingLineNearExtent(Extent newPaddingExtent)
      Sets the default padding extent of the line near border. This method also acts as a convenience method by unconditionally updating the padding extent of the region constraints of any child components of this layout's owner. This is a bound property.
      Parameters:
      newPaddingExtent - The padding extent.
      Throws:
      NullPointerException - if the given padding extent is null.
      See Also:

    • setPaddingLineFarExtent

      public void setPaddingLineFarExtent(Extent newPaddingExtent)
      Sets the default padding extent of the line far border. This method also acts as a convenience method by unconditionally updating the padding extent of the region constraints of any child components of this layout's owner. This is a bound property.
      Parameters:
      newPaddingExtent - The padding extent, or null if the default padding extent should be used.
      Throws:
      NullPointerException - if the given padding extent is null.
      See Also:

    • setPaddingPageNearExtent

      public void setPaddingPageNearExtent(Extent newPaddingExtent)
      Sets the default padding extent of the page near border. This method also acts as a convenience method by unconditionally updating the padding extent of the region constraints of any child components of this layout's owner. This is a bound property.
      Parameters:
      newPaddingExtent - The padding extent, or null if the default padding extent should be used.
      Throws:
      NullPointerException - if the given padding extent is null.
      See Also:

    • setPaddingPageFarExtent

      public void setPaddingPageFarExtent(Extent newPaddingExtent)
      Sets the default padding extent of the page far border. This method also acts as a convenience method by unconditionally updating the padding extent of the region constraints of any child components of this layout's owner. This is a bound property.
      Parameters:
      newPaddingExtent - The padding extent, or null if the default padding extent should be used.
      Throws:
      NullPointerException - if the given padding extent is null.
      See Also:

    • setPaddingExtent

      public void setPaddingExtent(Extent newPaddingExtent)
      Sets the default padding extent of all borders. This method also acts as a convenience method by unconditionally updating the padding extent of the region constraints of any child components of this layout's owner. The padding extent of each border represents a bound property. This is a convenience method that calls setPaddingExtent(Border, Extent) for each border.
      Parameters:
      newPaddingExtent - The padding extent.
      Throws:
      NullPointerException - if the given padding extent is null.
      See Also:

    • getSpanFlow

      public Flow getSpanFlow()
      Returns:
      The logical axis which will span components across the other logical axis.

    • setSpanFlow

      public void setSpanFlow(Flow newSpanFlow)
      Sets the logical axis which will span components across the other logical axis. This is a bound property.
      Parameters:
      newSpanFlow - The logical axis which will span components across the other logical axis.
      Throws:
      NullPointerException - if the given span flow is null.
      See Also:

    • getConstraintsClass

      public Class<? extends RegionConstraints> getConstraintsClass()
      Returns:
      The class representing the type of constraints appropriate for this layout.

    • createDefaultConstraints

      public RegionConstraints createDefaultConstraints()
      Creates default constraints for the layout component.

      This implementation returns Region.CENTER. The new extents will have the default alignment, extent, and padding.

      Returns:
      New default constraints for the layout component.

    • getComponent

      public Component getComponent(Region region)
      Retrieves a component for a given region.
      Parameters:
      region - The region for which a component should be returned.
      Returns:
      The component with which the given region is associated, or null if no component has the given region specified.