ui::layout::BorderLayout Class Reference

Inheritance diagram for ui::layout::BorderLayout:

Inheritance graph
[legend]
Collaboration diagram for ui::layout::BorderLayout:

Collaboration graph
[legend]
List of all members.

Detailed Description

Defines a border layout. A border layout is a layout that has 5 areas, or placeholders, for Components. These areas can be specified by supplying a constraint. These constraints should be one of the following: These directions indicate where the placeholder is located.


Public Types

enum  LOCATIONS {
  NORTH, SOUTH, EAST, WEST,
  CENTER
}

Public Member Functions

void layoutContainer (Container *parent)
void addLayoutComponent (Component *comp, int constraint)
void removeLayoutComponent (Component *comp)
const util::Dimension preferredLayoutSize (const Container *parent) const
 BorderLayout ()
 BorderLayout (const BorderLayout &rhs)
BorderLayoutoperator= (const BorderLayout &rhs)
void swap (BorderLayout &rhs) throw ()
 BorderLayout (int hgap, int vgap)
 BorderLayout (bool fillCorners, int hgap, int vgap)
 BorderLayout (bool fillCorners)


Member Enumeration Documentation

enum ui::layout::BorderLayout::LOCATIONS
 

Defines placeholder locations.

Enumeration values:
NORTH  North position.
SOUTH  South position.
EAST  East position.
WEST  West position.
CENTER  Center position.


Constructor & Destructor Documentation

ui::layout::BorderLayout::BorderLayout  ) 
 

Default constructor.

ui::layout::BorderLayout::BorderLayout const BorderLayout rhs  ) 
 

Copy constructor.

ui::layout::BorderLayout::BorderLayout int  hgap,
int  vgap
 

Create a BorderLayout with given horizontal and vertical spacing.

Parameters:
hgap the horizontal spacing between Components.
vgap the vertical spacing between Components.


Member Function Documentation

void ui::layout::BorderLayout::layoutContainer Container parent  )  [virtual]
 

Lay out the given Container.

Parameters:
parent the Container to be laid out.

Reimplemented from ui::layout::LayoutManager.

void ui::layout::BorderLayout::addLayoutComponent Component comp,
int  constraint
[virtual]
 

Add's a component to the LayoutManager with given constraint. Note that any Component present at the constraints placeholder will be removed.

Parameters:
comp Component to add to this LayoutManager.
constraint Constraint to use while laying out the Components.
See also:
LOCATIONS

Reimplemented from ui::layout::LayoutManager.

void ui::layout::BorderLayout::removeLayoutComponent Component comp  )  [virtual]
 

Remove the given Component from the LayoutManager.

Parameters:
comp the Component to remove from the LayoutManager.

Reimplemented from ui::layout::LayoutManager.

const util::Dimension ui::layout::BorderLayout::preferredLayoutSize const Container parent  )  const [virtual]
 

Returns the preferred Dimension the Container likes to have. This is used to calculate the preferredSize. It is not guarenteed to be used, but it could happen (one happy customer).

Parameters:
container Container to calculate and return the preferredSize from.
Returns:
The preferred size for the given Container.

Reimplemented from ui::layout::LayoutManager.

BorderLayout & ui::layout::BorderLayout::operator= const BorderLayout rhs  ) 
 

Assignment operator.

void ui::layout::BorderLayout::swap BorderLayout rhs  )  throw ()
 

Swap this LayoutManager with another.


Generated on Mon Jun 20 19:42:00 2005 for UI by doxygen 1.3.1 using KingsTools