oracle.javatools.columnlayout

Interface LayoutComponent

All Known Implementing Classes:

LayoutGap, LayoutLeaf, LayoutPanel, LayoutRow

public interface LayoutComponent

The LayoutComponent interface takes the component role in the composition pattern. Methods for manipulating children are left to implementations of the composite role.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToPanel(java.awt.Container container, int baseRow, int baseColumn, boolean[] rowConstraints, boolean[] columnConstraints, int rowSpan) Layout components need to be able to add themselves to UI containers with appropriate constraints.
void	areColumnsResizable(boolean[] columnConstraints, int baseColumn) This is the parallel of the areRowsResizable method but geometrically orthogonal to it.
void	areRowsResizable(boolean[] rowConstraints, int baseRow, int rowSpan) For each row it can either be fixed or resizable.
int	getColumnCount() How many columns does the LayoutComponent have?
int	getRowCount() How many rows does the LayoutComponent have?

Method Detail

getColumnCount

int getColumnCount()

How many columns does the LayoutComponent have?

getRowCount

int getRowCount()

How many rows does the LayoutComponent have?

areRowsResizable

void areRowsResizable(boolean[] rowConstraints,
                    int baseRow,
                    int rowSpan)

For each row it can either be fixed or resizable. The rowConstraints parameter is an out parameter, ie the result should be recorded in it. Implementations should OR their resizability into the appropriate place in the result. If the row span is larger than the number of rows the LayoutComponent has, it should ignore its last row. The row span should never be smaller than the layout component's row count. Note that if a row is already resizable in the result then it must not be changed to fixed.

Parameters:

rowConstraints - the out parameter

baseRow - the position to start from in the rowConstraints

rowSpan - the length of the rowConstraints which can be changed

Throws:

java.lang.IllegalArgumentException - if the row span is too small

areColumnsResizable

void areColumnsResizable(boolean[] columnConstraints,
                       int baseColumn)

This is the parallel of the areRowsResizable method but geometrically orthogonal to it. However a layout component will always know how many columns it spans.

addToPanel

void addToPanel(java.awt.Container container,
              int baseRow,
              int baseColumn,
              boolean[] rowConstraints,
              boolean[] columnConstraints,
              int rowSpan)

Layout components need to be able to add themselves to UI containers with appropriate constraints. Currently GridBagLayout is used.

Parameters:

container - the container to add to

baseRow - components must be added relative to this

baseColumn - components must be added relative to this

rowConstraints - whether each row is resizable or not, these are for the whole container

columnConstraints - same as rowConstraints but for columns

rowSpan - the number of rows which the LayoutComponent occupies this will be at least equal to the LayoutComponent's row count