| java.lang.Object
 com.jidesoft.swing.JideBorderLayout
| JideBorderLayout | | public class JideBorderLayout implements LayoutManager2,java.io.Serializable(Code) | | This is a modified version of BorderLayout. Different from
BorderLayout, the TOP and BOTTOM component's width are same
as CENTER compoennt's width. In BorderLayout, their width are the same
as the container's width.
See Also: BorderLayout |
| Field Summary | |
| final public static String | AFTER_LAST_LINE
Synonym for PAGE_END. | | final public static String | AFTER_LINE_ENDS
Synonym for LINE_END. | | final public static String | BEFORE_FIRST_LINE
Synonym for PAGE_START. | | final public static String | BEFORE_LINE_BEGINS
Synonym for LINE_START. | | final public static String | CENTER
The center layout constraint (middle of container). | | final public static String | EAST
The east layout constraint (right side of container). | | final public static String | LINE_END
The component goes at the end of the line direction for the
layout. | | final public static String | LINE_START
The component goes at the beginning of the line direction for the
layout. | | final public static String | NORTH
The north layout constraint (top of container). | | final public static String | PAGE_END
The component comes after the last line of the layout's content. | | final public static String | PAGE_START
The component comes before the first line of the layout's content. | | final public static String | SOUTH
The south layout constraint (bottom of container). | | final public static String | WEST
The west layout constraint (left side of container). | | Component | center
Constant to specify components location to be the
center portion of the border layout. | | Component | east
Constant to specify components location to be the
east portion of the border layout. | | Component | firstItem
A relative positioning constant, that can be used instead of
north, south, east, west or center. | | Component | firstLine
A relative positioning constant, that can be used instead of
north, south, east, west or center.
mixing the two types of constants can lead to unpredicable results. | | int | hgap
Constructs a border layout with the horizontal gaps
between components. | | Component | lastItem
A relative positioning constant, that can be used instead of
north, south, east, west or center. | | Component | lastLine
A relative positioning constant, that can be used instead of
north, south, east, west or center. | | Component | north
Constant to specify components location to be the
north portion of the border layout. | | Component | south
Constant to specify components location to be the
south portion of the border layout. | | int | vgap
Constructs a border layout with the vertical gaps
between components. | | Component | west
Constant to specify components location to be the
west portion of the border layout. |
| Constructor Summary | |
| public | JideBorderLayout()
Constructs a new border layout with
no gaps between components. | | public | JideBorderLayout(int hgap, int vgap)
Constructs a border layout with the specified gaps
between components. |
| Method Summary | |
| public void | addLayoutComponent(Component comp, Object constraints)
Adds the specified component to the layout, using the specified
constraint object. | | public void | addLayoutComponent(String name, Component comp)
| | public int | getHgap()
Returns the horizontal gap between components. | | public float | getLayoutAlignmentX(Container parent)
Returns the alignment along the x axis. | | public float | getLayoutAlignmentY(Container parent)
Returns the alignment along the y axis. | | public int | getVgap()
Returns the vertical gap between components. | | public void | invalidateLayout(Container target)
Invalidates the layout, indicating that if the layout manager
has cached information it should be discarded. | | public void | layoutContainer(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. | | public Dimension | maximumLayoutSize(Container target)
Returns the maximum dimensions for this layout given the components
in the specified target container. | | public Dimension | minimumLayoutSize(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. | | public Dimension | preferredLayoutSize(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. | | public void | removeLayoutComponent(Component comp)
Removes the specified component from this border layout. | | public void | setHgap(int hgap)
Sets the horizontal gap between components. | | public void | setVgap(int vgap)
Sets the vertical gap between components. | | public String | toString()
Returns a string representation of the state of this border layout. |
| AFTER_LAST_LINE | | final public static String AFTER_LAST_LINE(Code) | | Synonym for PAGE_END. Exists for compatibility with previous
versions. PAGE_END is preferred.
See Also: JideBorderLayout.PAGE_END
since:
1.2 |
| AFTER_LINE_ENDS | | final public static String AFTER_LINE_ENDS(Code) | | Synonym for LINE_END. Exists for compatibility with previous
versions. LINE_END is preferred.
See Also: JideBorderLayout.LINE_END
since:
1.2 |
| BEFORE_FIRST_LINE | | final public static String BEFORE_FIRST_LINE(Code) | | Synonym for PAGE_START. Exists for compatibility with previous
versions. PAGE_START is preferred.
See Also: JideBorderLayout.PAGE_START
since:
1.2 |
| BEFORE_LINE_BEGINS | | final public static String BEFORE_LINE_BEGINS(Code) | | Synonym for LINE_START. Exists for compatibility with previous
versions. LINE_START is preferred.
See Also: JideBorderLayout.LINE_START
since:
1.2 |
| CENTER | | final public static String CENTER(Code) | | The center layout constraint (middle of container).
|
| EAST | | final public static String EAST(Code) | | The east layout constraint (right side of container).
|
| LINE_END | | final public static String LINE_END(Code) | | 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.
See Also: Component.getComponentOrientation
since:
1.4 |
| LINE_START | | final public static String LINE_START(Code) | | 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.
See Also: Component.getComponentOrientation
since:
1.4 |
| NORTH | | final public static String NORTH(Code) | | The north layout constraint (top of container).
|
| PAGE_END | | final public static String PAGE_END(Code) | | 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.
See Also: Component.getComponentOrientation
since:
1.4 |
| PAGE_START | | final public static String PAGE_START(Code) | | 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.
See Also: Component.getComponentOrientation
since:
1.4 |
| SOUTH | | final public static String SOUTH(Code) | | The south layout constraint (bottom of container).
|
| WEST | | final public static String WEST(Code) | | The west layout constraint (left side of container).
|
| firstItem | | Component firstItem(Code) | | A relative positioning constant, that can be used instead of
north, south, east, west or center.
Please read Description for firstLine.
|
| firstLine | | Component firstLine(Code) | | A relative positioning constant, that can be used instead of
north, south, east, west or center.
mixing the two types of constants can lead to unpredicable results. If
you use both types, the relative constants will take precedence.
For example, if you add components using both the NORTH
and BEFORE_FIRST_LINE constants in a container whose
orientation is LEFT_TO_RIGHT, only the
BEFORE_FIRST_LINE will be layed out.
This will be the same for lastLine, firstItem, lastItem.
|
| hgap | | int hgap(Code) | | Constructs a border layout with the horizontal gaps
between components.
The horizontal gap is specified by hgap.
|
| lastItem | | Component lastItem(Code) | | A relative positioning constant, that can be used instead of
north, south, east, west or center.
Please read Description for firstLine.
|
| lastLine | | Component lastLine(Code) | | A relative positioning constant, that can be used instead of
north, south, east, west or center.
Please read Description for firstLine.
|
| vgap | | int vgap(Code) | | Constructs a border layout with the vertical gaps
between components.
The vertical gap is specified by vgap.
|
| JideBorderLayout | | public JideBorderLayout()(Code) | | Constructs a new border layout with
no gaps between components.
|
| JideBorderLayout | | public JideBorderLayout(int hgap, int vgap)(Code) | | 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.
Parameters:
vgap - the vertical gap. |
| addLayoutComponent | | public void addLayoutComponent(Component comp, Object constraints)(Code) | | 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.
Parameters:
comp - the component to be added.
Parameters:
constraints - an object that specifies how and wherethe component is added to the layout.
throws:
IllegalArgumentException - if the constraint object is nota string, or if it not one of the five specifiedconstants.
See Also: Container.add(ComponentObject)
since:
JDK1.1 |
| getHgap | | public int getHgap()(Code) | | Returns the horizontal gap between components.
the horizontal gap between components |
| getLayoutAlignmentX | | public float getLayoutAlignmentX(Container parent)(Code) | | 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.
|
| getLayoutAlignmentY | | public float getLayoutAlignmentY(Container parent)(Code) | | 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.
|
| getVgap | | public int getVgap()(Code) | | Returns the vertical gap between components.
the vertical gap between components |
| invalidateLayout | | public void invalidateLayout(Container target)(Code) | | Invalidates the layout, indicating that if the layout manager
has cached information it should be discarded.
|
| layoutContainer | | public void layoutContainer(Container target)(Code) | | 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.
Parameters:
target - the container in which to do the layout.
See Also: Container
See Also: Container.doLayout |
| minimumLayoutSize | | public Dimension minimumLayoutSize(Container target)(Code) | | 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.
Parameters:
target - the container in which to do the layout. the minimum dimensions needed to lay out the subcomponentsof the specified container.
See Also: Container
See Also: Container.getMinimumSize |
| preferredLayoutSize | | public Dimension preferredLayoutSize(Container target)(Code) | | 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.
Parameters:
target - the container in which to do the layout. the preferred dimensions to lay out the subcomponentsof the specified container.
See Also: Container
See Also: Container.getPreferredSize |
| removeLayoutComponent | | public void removeLayoutComponent(Component comp)(Code) | | 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.
Parameters:
comp - the component to be removed.
See Also: Container.remove(Component)
See Also: Container.removeAll |
| setHgap | | public void setHgap(int hgap)(Code) | | Sets the horizontal gap between components.
Parameters:
hgap - the horizontal gap between components
since:
JDK1.1 |
| setVgap | | public void setVgap(int vgap)(Code) | | Sets the vertical gap between components.
Parameters:
vgap - the vertical gap between components
since:
JDK1.1 |
| toString | | public String toString()(Code) | | Returns a string representation of the state of this border layout.
a string representation of this border layout. |
|
|