Package com.jidesoft.swing

Class JideBorderLayout

  • All Implemented Interfaces:
    java.awt.LayoutManager, java.awt.LayoutManager2, java.io.Serializable
    public class JideBorderLayout
extends java.lang.Object
implements java.awt.LayoutManager2, java.io.Serializable
    This is a modified version of BorderLayout. Different from BorderLayout, the TOP and BOTTOM component's width are same as CENTER component's width. In BorderLayout, their width are the same as the container's width.
    See Also:
    BorderLayout, Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String AFTER_LAST_LINE
      Synonym for PAGE_END.
      static java.lang.String AFTER_LINE_ENDS
      Synonym for LINE_END.
      static java.lang.String BEFORE_FIRST_LINE
      Synonym for PAGE_START.
      static java.lang.String BEFORE_LINE_BEGINS
      Synonym for LINE_START.
      static java.lang.String CENTER
      The center layout constraint (middle of container).
      static java.lang.String EAST
      The east layout constraint (right side of container).
      static java.lang.String LINE_END
      The component goes at the end of the line direction for the layout.
      static java.lang.String LINE_START
      The component goes at the beginning of the line direction for the layout.
      static java.lang.String NORTH
      The north layout constraint (top of container).
      static java.lang.String PAGE_END
      The component comes after the last line of the layout's content.
      static java.lang.String PAGE_START
      The component comes before the first line of the layout's content.
      static java.lang.String SOUTH
      The south layout constraint (bottom of container).
      static java.lang.String WEST
      The west layout constraint (left side of container).

    • Constructor Summary

      Constructors 
      Constructor Description
      JideBorderLayout()
      Constructs a new border layout with no gaps between components.
      JideBorderLayout​(int hgap, int vgap)
      Constructs a border layout with the specified gaps between components.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addLayoutComponent​(java.awt.Component comp, java.lang.Object constraints)
      Adds the specified component to the layout, using the specified constraint object.
      void addLayoutComponent​(java.lang.String name, java.awt.Component comp)
      Deprecated.
      replaced by addLayoutComponent(Component, Object).
      java.lang.Object getConstraints​(java.awt.Component comp)
      Gets the constraints for the specified component
      int getHgap()
      Returns the horizontal gap between components.
      float getLayoutAlignmentX​(java.awt.Container parent)
      Returns the alignment along the x axis.
      float getLayoutAlignmentY​(java.awt.Container parent)
      Returns the alignment along the y axis.
      java.awt.Component getLayoutComponent​(java.awt.Container target, java.lang.Object constraints)
      Returns the component that corresponds to the given constraint location based on the target Container's component orientation.
      java.awt.Component getLayoutComponent​(java.lang.Object constraints)
      Gets the component that was added using the given constraint
      int getVgap()
      Returns the vertical gap between components.
      void invalidateLayout​(java.awt.Container target)
      Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
      void layoutContainer​(java.awt.Container target)
      Lays out the container argument using this border layout.
      java.awt.Dimension maximumLayoutSize​(java.awt.Container target)
      Returns the maximum dimensions for this layout given the components in the specified target container.
      java.awt.Dimension minimumLayoutSize​(java.awt.Container target)
      Determines the minimum size of the target container using this layout manager.
      java.awt.Dimension preferredLayoutSize​(java.awt.Container target)
      Determines the preferred size of the target container using this layout manager, based on the components in the container.
      void removeLayoutComponent​(java.awt.Component comp)
      Removes the specified component from this border layout.
      void setHgap​(int hgap)
      Sets the horizontal gap between components.
      void setVgap​(int vgap)
      Sets the vertical gap between components.
      java.lang.String toString()
      Returns a string representation of the state of this border layout.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • NORTH

        public static final java.lang.String NORTH
        The north layout constraint (top of container).
        See Also:
        Constant Field Values

      • SOUTH

        public static final java.lang.String SOUTH
        The south layout constraint (bottom of container).
        See Also:
        Constant Field Values

      • EAST

        public static final java.lang.String EAST
        The east layout constraint (right side of container).
        See Also:
        Constant Field Values

      • WEST

        public static final java.lang.String WEST
        The west layout constraint (left side of container).
        See Also:
        Constant Field Values

      • CENTER

        public static final java.lang.String CENTER
        The center layout constraint (middle of container).
        See Also:
        Constant Field Values

      • BEFORE_FIRST_LINE

        public static final java.lang.String BEFORE_FIRST_LINE
        Synonym for PAGE_START. Exists for compatibility with previous versions. PAGE_START is preferred.
        Since:
        1.2
        See Also:
        PAGE_START, Constant Field Values

      • AFTER_LAST_LINE

        public static final java.lang.String AFTER_LAST_LINE
        Synonym for PAGE_END. Exists for compatibility with previous versions. PAGE_END is preferred.
        Since:
        1.2
        See Also:
        PAGE_END, Constant Field Values

      • BEFORE_LINE_BEGINS

        public static final java.lang.String BEFORE_LINE_BEGINS
        Synonym for LINE_START. Exists for compatibility with previous versions. LINE_START is preferred.
        Since:
        1.2
        See Also:
        LINE_START, Constant Field Values

      • AFTER_LINE_ENDS

        public static final java.lang.String AFTER_LINE_ENDS
        Synonym for LINE_END. Exists for compatibility with previous versions. LINE_END is preferred.
        Since:
        1.2
        See Also:
        LINE_END, Constant Field Values

      • PAGE_START

        public static final java.lang.String PAGE_START
        The component comes before the first line of the layout's content. For Western, left-to-right and top-to-bottom orientations, this is equivalent to NORTH.
        Since:
        1.4
        See Also:
        Component.getComponentOrientation(), Constant Field Values

      • PAGE_END

        public static final java.lang.String PAGE_END
        The component comes after the last line of the layout's content. For Western, left-to-right and top-to-bottom orientations, this is equivalent to SOUTH.
        Since:
        1.4
        See Also:
        Component.getComponentOrientation(), Constant Field Values

      • LINE_START

        public static final java.lang.String LINE_START
        The component goes at the beginning of the line direction for the layout. For Western, left-to-right and top-to-bottom orientations, this is equivalent to WEST.
        Since:
        1.4
        See Also:
        Component.getComponentOrientation(), Constant Field Values

      • LINE_END

        public static final java.lang.String LINE_END
        The component goes at the end of the line direction for the layout. For Western, left-to-right and top-to-bottom orientations, this is equivalent to EAST.
        Since:
        1.4
        See Also:
        Component.getComponentOrientation(), Constant Field Values

    • Constructor Detail

      • JideBorderLayout

        public JideBorderLayout()
        Constructs a new border layout with no gaps between components.

      • JideBorderLayout

        public JideBorderLayout​(int hgap,
                        int vgap)
        Constructs a border layout with the specified gaps between components. The horizontal gap is specified by hgap and the vertical gap is specified by vgap.
        Parameters:
        hgap - the horizontal gap.
        vgap - the vertical gap.

    • Method Detail

      • getHgap

        public int getHgap()
        Returns the horizontal gap between components.
        Since:
        JDK1.1

      • setHgap

        public void setHgap​(int hgap)
        Sets the horizontal gap between components.
        Parameters:
        hgap - the horizontal gap between components
        Since:
        JDK1.1

      • getVgap

        public int getVgap()
        Returns the vertical gap between components.
        Since:
        JDK1.1

      • setVgap

        public void setVgap​(int vgap)
        Sets the vertical gap between components.
        Parameters:
        vgap - the vertical gap between components
        Since:
        JDK1.1

      • addLayoutComponent

        public void addLayoutComponent​(java.awt.Component comp,
                               java.lang.Object constraints)
        Adds the specified component to the layout, using the specified constraint object. For border layouts, the constraint must be one of the following constants: NORTH, SOUTH, EAST, WEST, or CENTER.

        Most applications do not call this method directly. This method is called when a component is added to a container using the Container.add method with the same argument types.

        Specified by:
        addLayoutComponent in interface java.awt.LayoutManager2
        Parameters:
        comp - the component to be added.
        constraints - an object that specifies how and where the component is added to the layout.
        Throws:
        java.lang.IllegalArgumentException - if the constraint object is not a string, or if it not one of the five specified constants.
        Since:
        JDK1.1
        See Also:
        Container.add(java.awt.Component, java.lang.Object)

      • addLayoutComponent

        @Deprecated
public void addLayoutComponent​(java.lang.String name,
                               java.awt.Component comp)
        Deprecated.
        replaced by addLayoutComponent(Component, Object).
        Specified by:
        addLayoutComponent in interface java.awt.LayoutManager

      • removeLayoutComponent

        public void removeLayoutComponent​(java.awt.Component comp)
        Removes the specified component from this border layout. This method is called when a container calls its remove or removeAll methods. Most applications do not call this method directly.
        Specified by:
        removeLayoutComponent in interface java.awt.LayoutManager
        Parameters:
        comp - the component to be removed.
        See Also:
        Container.remove(java.awt.Component), Container.removeAll()

      • getLayoutComponent

        public java.awt.Component getLayoutComponent​(java.lang.Object constraints)
        Gets the component that was added using the given constraint
        Parameters:
        constraints - the desired constraint, one of CENTER, NORTH, SOUTH, WEST, EAST, PAGE_START, PAGE_END, LINE_START, LINE_END
        Returns:
        the component at the given location, or null if the location is empty
        Throws:
        java.lang.IllegalArgumentException - if the constraint object is not one of the nine specified constants
        Since:
        1.5
        See Also:
        addLayoutComponent(java.awt.Component, java.lang.Object)

      • getLayoutComponent

        public java.awt.Component getLayoutComponent​(java.awt.Container target,
                                             java.lang.Object constraints)
        Returns the component that corresponds to the given constraint location based on the target Container's component orientation. Components added with the relative constraints PAGE_START, PAGE_END, LINE_START, and LINE_END take precedence over components added with the explicit constraints NORTH, SOUTH, WEST, and EAST. The Container's component orientation is used to determine the location of components added with LINE_START and LINE_END.
        Parameters:
        constraints - the desired absolute position, one of CENTER, NORTH, SOUTH, EAST, WEST
        target - the Container used to obtain the constraint location based on the target Container's component orientation.
        Returns:
        the component at the given location, or null if the location is empty
        Throws:
        java.lang.IllegalArgumentException - if the constraint object is not one of the five specified constants
        java.lang.NullPointerException - if the target parameter is null
        Since:
        1.5
        See Also:
        addLayoutComponent(java.awt.Component, java.lang.Object)

      • getConstraints

        public java.lang.Object getConstraints​(java.awt.Component comp)
        Gets the constraints for the specified component
        Parameters:
        comp - the component to be queried
        Returns:
        the constraint for the specified component, or null if component is null or is not present in this layout
        Since:
        1.5
        See Also:
        addLayoutComponent(java.awt.Component, java.lang.Object)

      • minimumLayoutSize

        public java.awt.Dimension minimumLayoutSize​(java.awt.Container target)
        Determines the minimum size of the target container using this layout manager.

        This method is called when a container calls its getMinimumSize method. Most applications do not call this method directly.

        Specified by:
        minimumLayoutSize in interface java.awt.LayoutManager
        Parameters:
        target - the container in which to do the layout.
        Returns:
        the minimum dimensions needed to lay out the subcomponents of the specified container.
        See Also:
        Container, BorderLayout.preferredLayoutSize(java.awt.Container), Container.getMinimumSize()

      • preferredLayoutSize

        public java.awt.Dimension preferredLayoutSize​(java.awt.Container target)
        Determines the preferred size of the target container using this layout manager, based on the components in the container.

        Most applications do not call this method directly. This method is called when a container calls its getPreferredSize method.

        Specified by:
        preferredLayoutSize in interface java.awt.LayoutManager
        Parameters:
        target - the container in which to do the layout.
        Returns:
        the preferred dimensions to lay out the subcomponents of the specified container.
        See Also:
        Container, BorderLayout.minimumLayoutSize(java.awt.Container), Container.getPreferredSize()

      • maximumLayoutSize

        public java.awt.Dimension maximumLayoutSize​(java.awt.Container target)
        Returns the maximum dimensions for this layout given the components in the specified target container.
        Specified by:
        maximumLayoutSize in interface java.awt.LayoutManager2
        Parameters:
        target - the component which needs to be laid out
        See Also:
        Container, minimumLayoutSize(java.awt.Container), preferredLayoutSize(java.awt.Container)

      • getLayoutAlignmentX

        public float getLayoutAlignmentX​(java.awt.Container parent)
        Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.
        Specified by:
        getLayoutAlignmentX in interface java.awt.LayoutManager2

      • getLayoutAlignmentY

        public float getLayoutAlignmentY​(java.awt.Container parent)
        Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.
        Specified by:
        getLayoutAlignmentY in interface java.awt.LayoutManager2

      • invalidateLayout

        public void invalidateLayout​(java.awt.Container target)
        Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
        Specified by:
        invalidateLayout in interface java.awt.LayoutManager2

      • layoutContainer

        public void layoutContainer​(java.awt.Container target)
        Lays out the container argument using this border layout.

        This method actually reshapes the components in the specified container in order to satisfy the constraints of this BorderLayout object. The NORTH and SOUTH components, if any, are placed at the top and bottom of the container, respectively. The WEST and EAST components are then placed on the left and right, respectively. Finally, the CENTER object is placed in any remaining space in the middle.

        Most applications do not call this method directly. This method is called when a container calls its doLayout method.

        Specified by:
        layoutContainer in interface java.awt.LayoutManager
        Parameters:
        target - the container in which to do the layout.
        See Also:
        Container, Container.doLayout()

      • toString

        public java.lang.String toString()
        Returns a string representation of the state of this border layout.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this border layout.