Package com.jidesoft.swing
Class JideBorderLayout
java.lang.Object
com.jidesoft.swing.JideBorderLayout
- All Implemented Interfaces:
LayoutManager
,LayoutManager2
,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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Synonym for PAGE_END.static final String
Synonym for LINE_END.static final String
Synonym for PAGE_START.static final String
Synonym for LINE_START.static final String
The center layout constraint (middle of container).static final String
The east layout constraint (right side of container).static final String
The component goes at the end of the line direction for the layout.static final String
The component goes at the beginning of the line direction for the layout.static final String
The north layout constraint (top of container).static final String
The component comes after the last line of the layout's content.static final String
The component comes before the first line of the layout's content.static final String
The south layout constraint (bottom of container).static final String
The west layout constraint (left side of container). -
Constructor Summary
ConstructorsConstructorDescriptionConstructs 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
Modifier and TypeMethodDescriptionvoid
addLayoutComponent
(Component comp, Object constraints) Adds the specified component to the layout, using the specified constraint object.void
addLayoutComponent
(String name, Component comp) Deprecated.getConstraints
(Component comp) Gets the constraints for the specified componentint
getHgap()
Returns the horizontal gap between components.float
getLayoutAlignmentX
(Container parent) Returns the alignment along the x axis.float
getLayoutAlignmentY
(Container parent) Returns the alignment along the y axis.getLayoutComponent
(Container target, Object constraints) Returns the component that corresponds to the given constraint location based on the targetContainer
's component orientation.getLayoutComponent
(Object constraints) Gets the component that was added using the given constraintint
getVgap()
Returns the vertical gap between components.void
invalidateLayout
(Container target) Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.void
layoutContainer
(Container target) Lays out the container argument using this border layout.maximumLayoutSize
(Container target) Returns the maximum dimensions for this layout given the components in the specified target container.minimumLayoutSize
(Container target) Determines the minimum size of thetarget
container using this layout manager.preferredLayoutSize
(Container target) Determines the preferred size of thetarget
container using this layout manager, based on the components in the container.void
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.toString()
Returns a string representation of the state of this border layout.
-
Field Details
-
NORTH
The north layout constraint (top of container).- See Also:
-
SOUTH
The south layout constraint (bottom of container).- See Also:
-
EAST
The east layout constraint (right side of container).- See Also:
-
WEST
The west layout constraint (left side of container).- See Also:
-
CENTER
The center layout constraint (middle of container).- See Also:
-
BEFORE_FIRST_LINE
Synonym for PAGE_START. Exists for compatibility with previous versions. PAGE_START is preferred.- Since:
- 1.2
- See Also:
-
AFTER_LAST_LINE
Synonym for PAGE_END. Exists for compatibility with previous versions. PAGE_END is preferred.- Since:
- 1.2
- See Also:
-
BEFORE_LINE_BEGINS
Synonym for LINE_START. Exists for compatibility with previous versions. LINE_START is preferred.- Since:
- 1.2
- See Also:
-
AFTER_LINE_ENDS
Synonym for LINE_END. Exists for compatibility with previous versions. LINE_END is preferred.- Since:
- 1.2
- See Also:
-
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:
-
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:
-
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:
-
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:
-
-
Constructor Details
-
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 byhgap
and the vertical gap is specified byvgap
.- Parameters:
hgap
- the horizontal gap.vgap
- the vertical gap.
-
-
Method Details
-
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
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
, orCENTER
. Most applications do not call this method directly. This method is called when a component is added to a container using theContainer.add
method with the same argument types.- Specified by:
addLayoutComponent
in interfaceLayoutManager2
- Parameters:
comp
- the component to be added.constraints
- an object that specifies how and where the component is added to the layout.- Throws:
IllegalArgumentException
- if the constraint object is not a string, or if it not one of the five specified constants.- Since:
- JDK1.1
- See Also:
-
addLayoutComponent
Deprecated.replaced byaddLayoutComponent(Component, Object)
.- Specified by:
addLayoutComponent
in interfaceLayoutManager
-
removeLayoutComponent
Removes the specified component from this border layout. This method is called when a container calls itsremove
orremoveAll
methods. Most applications do not call this method directly.- Specified by:
removeLayoutComponent
in interfaceLayoutManager
- Parameters:
comp
- the component to be removed.- See Also:
-
getLayoutComponent
Gets the component that was added using the given constraint- Parameters:
constraints
- the desired constraint, one ofCENTER
,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:
IllegalArgumentException
- if the constraint object is not one of the nine specified constants- Since:
- 1.5
- See Also:
-
getLayoutComponent
Returns the component that corresponds to the given constraint location based on the targetContainer
's component orientation. Components added with the relative constraintsPAGE_START
,PAGE_END
,LINE_START
, andLINE_END
take precedence over components added with the explicit constraintsNORTH
,SOUTH
,WEST
, andEAST
. TheContainer
's component orientation is used to determine the location of components added withLINE_START
andLINE_END
.- Parameters:
constraints
- the desired absolute position, one ofCENTER
,NORTH
,SOUTH
,EAST
,WEST
target
- theContainer
used to obtain the constraint location based on the targetContainer
's component orientation.- Returns:
- the component at the given location, or
null
if the location is empty - Throws:
IllegalArgumentException
- if the constraint object is not one of the five specified constantsNullPointerException
- if the target parameter is null- Since:
- 1.5
- See Also:
-
getConstraints
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:
-
minimumLayoutSize
Determines the minimum size of thetarget
container using this layout manager. This method is called when a container calls itsgetMinimumSize
method. Most applications do not call this method directly.- Specified by:
minimumLayoutSize
in interfaceLayoutManager
- 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:
-
preferredLayoutSize
Determines the preferred size of thetarget
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 itsgetPreferredSize
method.- Specified by:
preferredLayoutSize
in interfaceLayoutManager
- 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:
-
maximumLayoutSize
Returns the maximum dimensions for this layout given the components in the specified target container.- Specified by:
maximumLayoutSize
in interfaceLayoutManager2
- Parameters:
target
- the component which needs to be laid out- See Also:
-
getLayoutAlignmentX
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 interfaceLayoutManager2
-
getLayoutAlignmentY
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 interfaceLayoutManager2
-
invalidateLayout
Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.- Specified by:
invalidateLayout
in interfaceLayoutManager2
-
layoutContainer
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 thisBorderLayout
object. TheNORTH
andSOUTH
components, if any, are placed at the top and bottom of the container, respectively. TheWEST
andEAST
components are then placed on the left and right, respectively. Finally, theCENTER
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 itsdoLayout
method.- Specified by:
layoutContainer
in interfaceLayoutManager
- Parameters:
target
- the container in which to do the layout.- See Also:
-
toString
Returns a string representation of the state of this border layout.
-
addLayoutComponent(Component, Object)
.