diff options
author | Adrien Hopkins <adrien.p.hopkins@gmail.com> | 2024-03-24 13:25:22 -0500 |
---|---|---|
committer | Adrien Hopkins <adrien.p.hopkins@gmail.com> | 2024-03-24 13:25:22 -0500 |
commit | ed53492243ecad8d975401a97f5b634328ad2c71 (patch) | |
tree | 8a744f46320710355a02c9b2c371602ce69aefec /src/main/java/sevenUnitsGUI/GridBagBuilder.java | |
parent | c878761f737c90fc3fa1caedd48e2ee01637108f (diff) | |
parent | 91d51c3c49c4c0877483220ac0f12db4efab8f60 (diff) |
Release version 0.5.0 (merge into stable)
Diffstat (limited to 'src/main/java/sevenUnitsGUI/GridBagBuilder.java')
-rw-r--r-- | src/main/java/sevenUnitsGUI/GridBagBuilder.java | 205 |
1 files changed, 107 insertions, 98 deletions
diff --git a/src/main/java/sevenUnitsGUI/GridBagBuilder.java b/src/main/java/sevenUnitsGUI/GridBagBuilder.java index 32e94d7..fdbaee7 100644 --- a/src/main/java/sevenUnitsGUI/GridBagBuilder.java +++ b/src/main/java/sevenUnitsGUI/GridBagBuilder.java @@ -30,13 +30,16 @@ final class GridBagBuilder { /** * The built {@code GridBagConstraints}'s {@code gridx} property. * <p> - * Specifies the cell containing the leading edge of the component's display area, where the first cell in a row has - * <code>gridx=0</code>. The leading edge of a component's display area is its left edge for a horizontal, - * left-to-right container and its right edge for a horizontal, right-to-left container. The value - * <code>RELATIVE</code> specifies that the component be placed immediately following the component that was added - * to the container just before this component was added. + * Specifies the cell containing the leading edge of the component's display + * area, where the first cell in a row has <code>gridx=0</code>. The leading + * edge of a component's display area is its left edge for a horizontal, + * left-to-right container and its right edge for a horizontal, right-to-left + * container. The value <code>RELATIVE</code> specifies that the component be + * placed immediately following the component that was added to the container + * just before this component was added. * <p> - * The default value is <code>RELATIVE</code>. <code>gridx</code> should be a non-negative value. + * The default value is <code>RELATIVE</code>. <code>gridx</code> should be a + * non-negative value. * * @serial * @see #clone() @@ -48,11 +51,13 @@ final class GridBagBuilder { /** * The built {@code GridBagConstraints}'s {@code gridy} property. * <p> - * Specifies the cell at the top of the component's display area, where the topmost cell has <code>gridy=0</code>. - * The value <code>RELATIVE</code> specifies that the component be placed just below the component that was added to - * the container just before this component was added. + * Specifies the cell at the top of the component's display area, where the + * topmost cell has <code>gridy=0</code>. The value <code>RELATIVE</code> + * specifies that the component be placed just below the component that was + * added to the container just before this component was added. * <p> - * The default value is <code>RELATIVE</code>. <code>gridy</code> should be a non-negative value. + * The default value is <code>RELATIVE</code>. <code>gridy</code> should be a + * non-negative value. * * @serial * @see #clone() @@ -65,9 +70,10 @@ final class GridBagBuilder { * <p> * Specifies the number of cells in a row for the component's display area. * <p> - * Use <code>REMAINDER</code> to specify that the component's display area will be from <code>gridx</code> to the - * last cell in the row. Use <code>RELATIVE</code> to specify that the component's display area will be from - * <code>gridx</code> to the next to the last one in its row. + * Use <code>REMAINDER</code> to specify that the component's display area + * will be from <code>gridx</code> to the last cell in the row. Use + * <code>RELATIVE</code> to specify that the component's display area will be + * from <code>gridx</code> to the next to the last one in its row. * <p> * <code>gridwidth</code> should be non-negative and the default value is 1. * @@ -80,13 +86,16 @@ final class GridBagBuilder { /** * The built {@code GridBagConstraints}'s {@code gridheight} property. * <p> - * Specifies the number of cells in a column for the component's display area. + * Specifies the number of cells in a column for the component's display + * area. * <p> - * Use <code>REMAINDER</code> to specify that the component's display area will be from <code>gridy</code> to the - * last cell in the column. Use <code>RELATIVE</code> to specify that the component's display area will be from - * <code>gridy</code> to the next to the last one in its column. + * Use <code>REMAINDER</code> to specify that the component's display area + * will be from <code>gridy</code> to the last cell in the column. Use + * <code>RELATIVE</code> to specify that the component's display area will be + * from <code>gridy</code> to the next to the last one in its column. * <p> - * <code>gridheight</code> should be a non-negative value and the default value is 1. + * <code>gridheight</code> should be a non-negative value and the default + * value is 1. * * @serial * @see #clone() @@ -99,15 +108,17 @@ final class GridBagBuilder { * <p> * Specifies how to distribute extra horizontal space. * <p> - * The grid bag layout manager calculates the weight of a column to be the maximum <code>weightx</code> of all the - * components in a column. If the resulting layout is smaller horizontally than the area it needs to fill, the extra - * space is distributed to each column in proportion to its weight. A column that has a weight of zero receives no - * extra space. + * The grid bag layout manager calculates the weight of a column to be the + * maximum <code>weightx</code> of all the components in a column. If the + * resulting layout is smaller horizontally than the area it needs to fill, + * the extra space is distributed to each column in proportion to its weight. + * A column that has a weight of zero receives no extra space. * <p> - * If all the weights are zero, all the extra space appears between the grids of the cell and the left and right - * edges. + * If all the weights are zero, all the extra space appears between the grids + * of the cell and the left and right edges. * <p> - * The default value of this field is <code>0</code>. <code>weightx</code> should be a non-negative value. + * The default value of this field is <code>0</code>. <code>weightx</code> + * should be a non-negative value. * * @serial * @see #clone() @@ -120,15 +131,17 @@ final class GridBagBuilder { * <p> * Specifies how to distribute extra vertical space. * <p> - * The grid bag layout manager calculates the weight of a row to be the maximum <code>weighty</code> of all the - * components in a row. If the resulting layout is smaller vertically than the area it needs to fill, the extra - * space is distributed to each row in proportion to its weight. A row that has a weight of zero receives no extra - * space. + * The grid bag layout manager calculates the weight of a row to be the + * maximum <code>weighty</code> of all the components in a row. If the + * resulting layout is smaller vertically than the area it needs to fill, the + * extra space is distributed to each row in proportion to its weight. A row + * that has a weight of zero receives no extra space. * <p> - * If all the weights are zero, all the extra space appears between the grids of the cell and the top and bottom - * edges. + * If all the weights are zero, all the extra space appears between the grids + * of the cell and the top and bottom edges. * <p> - * The default value of this field is <code>0</code>. <code>weighty</code> should be a non-negative value. + * The default value of this field is <code>0</code>. <code>weighty</code> + * should be a non-negative value. * * @serial * @see #clone() @@ -139,20 +152,26 @@ final class GridBagBuilder { /** * The built {@code GridBagConstraints}'s {@code anchor} property. * <p> - * This field is used when the component is smaller than its display area. It determines where, within the display - * area, to place the component. + * This field is used when the component is smaller than its display area. It + * determines where, within the display area, to place the component. * <p> - * There are three kinds of possible values: orientation relative, baseline relative and absolute. Orientation - * relative values are interpreted relative to the container's component orientation property, baseline relative - * values are interpreted relative to the baseline and absolute values are not. The absolute values are: - * <code>CENTER</code>, <code>NORTH</code>, <code>NORTHEAST</code>, <code>EAST</code>, <code>SOUTHEAST</code>, - * <code>SOUTH</code>, <code>SOUTHWEST</code>, <code>WEST</code>, and <code>NORTHWEST</code>. The orientation - * relative values are: <code>PAGE_START</code>, <code>PAGE_END</code>, <code>LINE_START</code>, - * <code>LINE_END</code>, <code>FIRST_LINE_START</code>, <code>FIRST_LINE_END</code>, <code>LAST_LINE_START</code> - * and <code>LAST_LINE_END</code>. The baseline relative values are: <code>BASELINE</code>, - * <code>BASELINE_LEADING</code>, <code>BASELINE_TRAILING</code>, <code>ABOVE_BASELINE</code>, - * <code>ABOVE_BASELINE_LEADING</code>, <code>ABOVE_BASELINE_TRAILING</code>, <code>BELOW_BASELINE</code>, - * <code>BELOW_BASELINE_LEADING</code>, and <code>BELOW_BASELINE_TRAILING</code>. The default value is + * There are three kinds of possible values: orientation relative, baseline + * relative and absolute. Orientation relative values are interpreted + * relative to the container's component orientation property, baseline + * relative values are interpreted relative to the baseline and absolute + * values are not. The absolute values are: <code>CENTER</code>, + * <code>NORTH</code>, <code>NORTHEAST</code>, <code>EAST</code>, + * <code>SOUTHEAST</code>, <code>SOUTH</code>, <code>SOUTHWEST</code>, + * <code>WEST</code>, and <code>NORTHWEST</code>. The orientation relative + * values are: <code>PAGE_START</code>, <code>PAGE_END</code>, + * <code>LINE_START</code>, <code>LINE_END</code>, + * <code>FIRST_LINE_START</code>, <code>FIRST_LINE_END</code>, + * <code>LAST_LINE_START</code> and <code>LAST_LINE_END</code>. The baseline + * relative values are: <code>BASELINE</code>, <code>BASELINE_LEADING</code>, + * <code>BASELINE_TRAILING</code>, <code>ABOVE_BASELINE</code>, + * <code>ABOVE_BASELINE_LEADING</code>, <code>ABOVE_BASELINE_TRAILING</code>, + * <code>BELOW_BASELINE</code>, <code>BELOW_BASELINE_LEADING</code>, and + * <code>BELOW_BASELINE_TRAILING</code>. The default value is * <code>CENTER</code>. * * @serial @@ -164,17 +183,18 @@ final class GridBagBuilder { /** * The built {@code GridBagConstraints}'s {@code fill} property. * <p> - * This field is used when the component's display area is larger than the component's requested size. It determines - * whether to resize the component, and if so, how. + * This field is used when the component's display area is larger than the + * component's requested size. It determines whether to resize the component, + * and if so, how. * <p> * The following values are valid for <code>fill</code>: * * <ul> * <li><code>NONE</code>: Do not resize the component. - * <li><code>HORIZONTAL</code>: Make the component wide enough to fill its display area horizontally, but do not - * change its height. - * <li><code>VERTICAL</code>: Make the component tall enough to fill its display area vertically, but do not change - * its width. + * <li><code>HORIZONTAL</code>: Make the component wide enough to fill its + * display area horizontally, but do not change its height. + * <li><code>VERTICAL</code>: Make the component tall enough to fill its + * display area vertically, but do not change its width. * <li><code>BOTH</code>: Make the component fill its display area entirely. * </ul> * <p> @@ -188,8 +208,8 @@ final class GridBagBuilder { /** * The built {@code GridBagConstraints}'s {@code insets} property. * <p> - * This field specifies the external padding of the component, the minimum amount of space between the component and - * the edges of its display area. + * This field specifies the external padding of the component, the minimum + * amount of space between the component and the edges of its display area. * <p> * The default value is <code>new Insets(0, 0, 0, 0)</code>. * @@ -201,8 +221,9 @@ final class GridBagBuilder { /** * The built {@code GridBagConstraints}'s {@code ipadx} property. * <p> - * This field specifies the internal padding of the component, how much space to add to the minimum width of the - * component. The width of the component is at least its minimum width plus <code>ipadx</code> pixels. + * This field specifies the internal padding of the component, how much space + * to add to the minimum width of the component. The width of the component + * is at least its minimum width plus <code>ipadx</code> pixels. * <p> * The default value is <code>0</code>. * @@ -215,8 +236,9 @@ final class GridBagBuilder { /** * The built {@code GridBagConstraints}'s {@code ipady} property. * <p> - * This field specifies the internal padding, that is, how much space to add to the minimum height of the component. - * The height of the component is at least its minimum height plus <code>ipady</code> pixels. + * This field specifies the internal padding, that is, how much space to add + * to the minimum height of the component. The height of the component is at + * least its minimum height plus <code>ipady</code> pixels. * <p> * The default value is 0. * @@ -227,10 +249,8 @@ final class GridBagBuilder { private int ipady; /** - * @param gridx - * x position - * @param gridy - * y position + * @param gridx x position + * @param gridy y position * @since 2018-11-30 * @since v0.1.0 */ @@ -239,31 +259,25 @@ final class GridBagBuilder { } /** - * @param gridx - * x position - * @param gridy - * y position - * @param gridwidth - * number of cells occupied horizontally - * @param gridheight - * number of cells occupied vertically + * @param gridx x position + * @param gridy y position + * @param gridwidth number of cells occupied horizontally + * @param gridheight number of cells occupied vertically * @since 2018-11-30 * @since v0.1.0 */ - public GridBagBuilder(final int gridx, final int gridy, final int gridwidth, final int gridheight) { - this(gridx, gridy, gridwidth, gridheight, 0.0, 0.0, GridBagConstraints.CENTER, GridBagConstraints.NONE, + public GridBagBuilder(final int gridx, final int gridy, final int gridwidth, + final int gridheight) { + this(gridx, gridy, gridwidth, gridheight, 0.0, 0.0, + GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0); } /** - * @param gridx - * x position - * @param gridy - * y position - * @param gridwidth - * number of cells occupied horizontally - * @param gridheight - * number of cells occupied vertically + * @param gridx x position + * @param gridy y position + * @param gridwidth number of cells occupied horizontally + * @param gridheight number of cells occupied vertically * @param weightx * @param weighty * @param anchor @@ -274,9 +288,10 @@ final class GridBagBuilder { * @since 2018-11-30 * @since v0.1.0 */ - private GridBagBuilder(final int gridx, final int gridy, final int gridwidth, final int gridheight, - final double weightx, final double weighty, final int anchor, final int fill, final Insets insets, - final int ipadx, final int ipady) { + private GridBagBuilder(final int gridx, final int gridy, final int gridwidth, + final int gridheight, final double weightx, final double weighty, + final int anchor, final int fill, final Insets insets, final int ipadx, + final int ipady) { super(); this.gridx = gridx; this.gridy = gridy; @@ -297,8 +312,9 @@ final class GridBagBuilder { * @since v0.1.0 */ public GridBagConstraints build() { - return new GridBagConstraints(this.gridx, this.gridy, this.gridwidth, this.gridheight, this.weightx, - this.weighty, this.anchor, this.fill, this.insets, this.ipadx, this.ipady); + return new GridBagConstraints(this.gridx, this.gridy, this.gridwidth, + this.gridheight, this.weightx, this.weighty, this.anchor, this.fill, + this.insets, this.ipadx, this.ipady); } /** @@ -401,8 +417,7 @@ final class GridBagBuilder { } /** - * @param anchor - * anchor to set + * @param anchor anchor to set * @since 2018-11-30 * @since v0.1.0 */ @@ -412,8 +427,7 @@ final class GridBagBuilder { } /** - * @param fill - * fill to set + * @param fill fill to set * @since 2018-11-30 * @since v0.1.0 */ @@ -423,8 +437,7 @@ final class GridBagBuilder { } /** - * @param insets - * insets to set + * @param insets insets to set * @since 2018-11-30 * @since v0.1.0 */ @@ -434,8 +447,7 @@ final class GridBagBuilder { } /** - * @param ipadx - * ipadx to set + * @param ipadx ipadx to set * @since 2018-11-30 * @since v0.1.0 */ @@ -445,8 +457,7 @@ final class GridBagBuilder { } /** - * @param ipady - * ipady to set + * @param ipady ipady to set * @since 2018-11-30 * @since v0.1.0 */ @@ -456,8 +467,7 @@ final class GridBagBuilder { } /** - * @param weightx - * weightx to set + * @param weightx weightx to set * @since 2018-11-30 * @since v0.1.0 */ @@ -467,8 +477,7 @@ final class GridBagBuilder { } /** - * @param weighty - * weighty to set + * @param weighty weighty to set * @since 2018-11-30 * @since v0.1.0 */ |