Package 

Interface FoldAwareColumnScope

  • @Immutable() 
public interface FoldAwareColumnScope

    Copy of ColumnScope that excludes the weight Modifier attribute.

    Also adds a new ignoreFold Modifier attribute.

    • Method Summary

      Modifier and Type Method Description
      abstract Modifier ignoreFold(Modifier $self) Ignore the fold when placing this child within the FoldAwareColumn.
      abstract Modifier align(Modifier $self, Alignment.Horizontal alignment) Align the element horizontally within the Column.
      abstract Modifier alignBy(Modifier $self, VerticalAlignmentLine alignmentLine) Position the element horizontally such that its alignmentLine aligns with sibling elements also configured to alignBy.
      abstract Modifier alignBy(Modifier $self, Function1<Measured, Integer> alignmentLineBlock) Position the element horizontally such that the alignment line for the content as determined by alignmentLineBlock aligns with sibling elements also configured to alignBy.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • ignoreFold

        @Stable() abstract Modifier ignoreFold(Modifier $self)

        Ignore the fold when placing this child within the FoldAwareColumn.

      • align

        @Stable() abstract Modifier align(Modifier $self, Alignment.Horizontal alignment)

        Align the element horizontally within the Column. This alignment will have priority over the Column's horizontalAlignment parameter.

        Example usage:

      • alignBy

        @Stable() abstract Modifier alignBy(Modifier $self, VerticalAlignmentLine alignmentLine)

        Position the element horizontally such that its alignmentLine aligns with sibling elements also configured to alignBy. alignBy is a form of align, so both modifiers will not work together if specified for the same layout. Within a Column, all components with alignBy will align horizontally using the specified VerticalAlignmentLines or values provided using the other alignBy overload, forming a sibling group. At least one element of the sibling group will be placed as it had Alignment.Start align in Column, and the alignment of the other siblings will be then determined such that the alignment lines coincide. Note that if only one element in a Column has the alignBy modifier specified the element will be positioned as if it had Alignment.Start align.

        Example usage:

      • alignBy

        @Stable() abstract Modifier alignBy(Modifier $self, Function1<Measured, Integer> alignmentLineBlock)

        Position the element horizontally such that the alignment line for the content as determined by alignmentLineBlock aligns with sibling elements also configured to alignBy. alignBy is a form of align, so both modifiers will not work together if specified for the same layout. Within a Column, all components with alignBy will align horizontally using the specified VerticalAlignmentLines or values obtained from alignmentLineBlock, forming a sibling group. At least one element of the sibling group will be placed as it had Alignment.Start align in Column, and the alignment of the other siblings will be then determined such that the alignment lines coincide. Note that if only one element in a Column has the alignBy modifier specified the element will be positioned as if it had Alignment.Start align.

        Example usage: