Class Layout

java.lang.Object
com.codename1.ui.layouts.Layout
Direct Known Subclasses:
BorderLayout, BoxLayout, CoordinateLayout, FlowLayout, GridBagLayout, GridLayout, GroupLayout, LayeredLayout, MigLayout, TableLayout, TextModeLayout
public abstract class Layout extends Object
Abstract class that can be used to arrange components in a container using a predefined algorithm. This class may be implemented externally and is similar in spirit to the AWT/Swing layout managers.

  • Constructor Details

    • Layout

      public Layout()

  • Method Details

    • layoutContainer

      public abstract void layoutContainer(Container parent)

      Layout the given parent container children

      Parameters
      • parent: the given parent container

    • getPreferredSize

      public abstract Dimension getPreferredSize(Container parent)

      Returns the container preferred size

      Parameters
      • parent: the parent container
      Returns

      the container preferred size

    • addLayoutComponent

      public void addLayoutComponent(Object value, Component comp, Container c)

      Some layouts can optionally track the addition of elements with meta-data that allows the user to "hint" on object positioning.

      Parameters

      • value: optional meta data information, like alignment orientation

      • comp: the added component to the layout

      • c: the parent container

    • removeLayoutComponent

      public void removeLayoutComponent(Component comp)

      Removes the component from the layout this operation is only useful if the layout maintains references to components within it

      Parameters
      • comp: the removed component from layout

    • getComponentConstraint

      public Object getComponentConstraint(Component comp)

      Returns the optional component constraint

      Parameters
      • comp: the component whose constraint should be returned
      Returns

      the optional component constraint

    • cloneConstraint

      public Object cloneConstraint(Object constraint)

    • isOverlapSupported

      public boolean isOverlapSupported()

      This method returns true if the Layout allows Components to Overlap.

      Returns

      true if Components may intersect in this layout

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isConstraintTracking

      public boolean isConstraintTracking()

      If this method returns true, the addLayoutComponent method will be called when replacing a layout for every component within the container

      Returns

      false by default

    • obscuresPotential

      public boolean obscuresPotential(Container parent)

      Some layout managers can obscure their child components in some cases this returns true if the basic underpinnings are in place for that. This method doesn't take padding/margin etc. into account since that is checked by the caller

      Parameters
      • parent: parent container
      Returns

      true if there is a chance that this layout manager can fully obscure the background, when in doubt return false...

    • overridesTabIndices

      public boolean overridesTabIndices(Container parent)

      If a layout specifies a different traversal order of its components than the component index, then it should override this method to return true, and it should also override #getChildrenInTraversalOrder(com.codename1.ui.Container) to set the tab indices of a container's children.

      Parameters
      • parent: The parent component.
      Returns

      True if this layout overrides tab traversal order.

    • updateTabIndices

      public final int updateTabIndices(Container parent, int offset)

      Updates the tab traversal order

      Parameters

      • parent

      • offset

    • getChildrenInTraversalOrder

      protected Component[] getChildrenInTraversalOrder(Container parent)

      Gets the children of the parent container in the order that they should be traversed when tabbing through a form.

      This should only be overridden if the Layout defines a different traversal order than the standard index order.

      Layouts that implement this method, should override the #overridesTabIndices(com.codename1.ui.Container) method to return true.

      Parameters
      • parent
      Returns

      Array of Components in the order