net.mumie.mathletfactory.display.layout

Class SimpleGridLayout

java.lang.Object

net.mumie.mathletfactory.display.layout.SimpleGridLayout

All Implemented Interfaces:

java.awt.LayoutManager, java.awt.LayoutManager2

Direct Known Subclasses:

AnchorGridLayout

public class SimpleGridLayout
extends java.lang.Object
implements java.awt.LayoutManager2

SimpleGridLayout ermöglicht es Komponenten fast so flexibel wie ein GridBagLayout anzuordnen, ohne dabei dessen Komplexität zu haben.Für das Layout wird ein Gitter definiert auf dem die Komponenten angeordnet werden sollen. Viele Komponenten sollen ihre Größe in einer (in beiden) Richtung(en) nicht ändern. Dafür kann man eine Zeile (Spalte) als fix definieren. Zusätzlicher Platz der horizontal (vertikal) vorhanden ist, wird gleichmäßig auf alle übrigen Zeilen (Spalten) verteilt. Zu jeder Komponente muß ein SimpleGridConstraints angegeben werden, welches festlegt, an welcher Postion sich die obere linke Ecke der Komponente befindet und über wie viele Zeile (Spalten) sie sich ersteckt. Um das die Breite (Höhe) einer festen Zeile (Spalte) zu beeinflussen kann man Spacer einfügen.

Ein einfaches Beispiel:
Ein Dialog mit einer Liste. Rechts von der Liste am oberen Rand sollen 3 Buttons (Hinzufügen, Bearbeiten, Löschen) stehen und unten rechts unten 2 Buttons OK und abbrechen. Die Buttons sollen sich in der Größe nicht ändern und ihre relative Position (rechts oben bzw. rechts unten behalten). Die Liste soll den zur Verfügung stehenden Platz einnehmen.

 +------------+----+--------+
 | list  qq        |  add   |
 +                 +--------+
 |                 |  edit  |
 +                 +--------+
 |                 |  del   |
 +                 +--------+
 |                 |        |
 |                 |        |
 +------------+----+--------+
 |            | ok | cancel |
 +------------+----+--------+
 

Wir brauchen also ein 3x5 Gitter wobei die Zeile 1-3 sowie 5 und die Spalten 2-3 fixe Größe haben. Die Komponente mögen die oben eingezeichneten Namen haben. Der Container soll cont heißen:

 SimpleGridLayout layout = new SimpleGridLayout(3, 5);
 layout.fixColumns(2, 3);
 layout.fixRows(1, 3);
 layout.fixRow(5);
 cont.setLayout(layout);
 cont.add(list, new SimpleGridConstraints(1, 1, 2, 4));
 cont.add(add, new SimpleGridConstraints(3, 1));
 cont.add(edit, new SimpleGridConstraints(3, 2));
 cont.add(del, new SimpleGridConstraints(3, 3));
 cont.add(ok, new SimpleGridConstraints(2, 5));
 cont.add(cancel, new SimpleGridConstraints(3, 5));
 

Author:

Amsel

Document status:

finished

Constructor Summary

Constructors

Constructor and Description
SimpleGridLayout(java.awt.Container aContainer) Neues Layout mit 1x1 großem Grid.
SimpleGridLayout(int cols, int rows, java.awt.Container aContainer) Neues Layout mit cols x rows großem Grid.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutComponent(java.awt.Component comp, java.lang.Object constraints)
void	addLayoutComponent(java.lang.String name, java.awt.Component comp) Das Einfügen einer Komponente mit einem String als constraint ist nicht möglich.
int[]	calcColumnWidths(java.lang.Object[][] grid) Berechnet die Breite der fixen Spalten.
protected void	calcPositions(int[] positions, int length, int fixedNum) Berechnet für Zeilen (Spalten) die Anfangsposition der Komponenten in der jeweiligen Zeile, Spalte unter Berücksichtigung des angegebenen Komponentenabstand.
int[]	calcRowHeights(java.lang.Object[][] grid) Berechnet die Breite der fixen Zeile.
protected int	calcVarSizes(int[] sizes, int start, int length, int prefSize, java.util.Vector fixed) Berechnet die Größe der nicht fix gekennzeichneten Zeilen (Spalten)
protected void	checkContainer(java.awt.Container aContainer) Prüfen, ob der übergebene container mit dem Container des Layouts übereinstimmt.
protected java.lang.Object[][]	createGrid() Erzeugt ein 2dim Objectarray in dem alle Komponenten eingetragen werden, die eine horizontal oder vertikal genau eine Zelle belegen.
void	fixColumn(int column) Eine Spalte columnals unveränderlich in der Größe markieren Die Breite einer solchen Spalte richtet sich nach der preferredSize der breitesten Komponente in dieser Spalte.
void	fixColumns(int firstColumn, int lastColumn) Spalten firstColumn bis einschließlich lastColumn als fix markieren.
void	fixRow(int row) Eine Zeile rowals unveränderlich in der Größe markieren Die Höhe einer solchen zeile richtet sich nach der preferredSize der höchsten Komponente in dieser Zeile.
void	fixRows(int firstRow, int lastRow) Zeilen firstRow bis einschließlich lastRow als fix markieren.
int	getColumnCount() Anzahl der Spalten
int	getGap() Abstand Rand-Komponente bzw.
float	getLayoutAlignmentX(java.awt.Container target)
float	getLayoutAlignmentY(java.awt.Container target)
int	getRowCount() Anzahl der Zeilen.
void	invalidateLayout(java.awt.Container target)
boolean	isColumnFixed(int column) true, wenn die Spalte column als größenunveränderlich markiert wurde.
boolean	isRowFixed(int row) true, wenn die Zeile row als größenunveränderlich markiert wurde.
void	layoutContainer(java.awt.Container parent)
protected SimpleGridConstraints	lookupConstraint(java.awt.Component comp) SimpleGridConstraints zur Komponent comp suchen
java.awt.Dimension	maximumLayoutSize(java.awt.Container target)
java.awt.Dimension	minimumLayoutSize(java.awt.Container parent)
java.awt.Dimension	preferredLayoutSize(java.awt.Container parent)
void	removeLayoutComponent(java.awt.Component comp)
void	setColumnCount(int value) Anzahl der Spalten setzen.
protected void	setComponentBounds(java.awt.Component comp, int left, int top, int width, int height, SimpleGridConstraints constraints)
protected void	setContainer(java.awt.Container aContainer)
void	setGap(int value) Abstand Rand-Komponente bzw.
void	setRowCount(int value) Anzahl der Zeilen setzen.
protected int	sumSizes(int[] sizes, int maxVarSize) Alle Höhen (Breiten) der Zeilen (Spalten) aufsummieren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleGridLayout

public SimpleGridLayout(java.awt.Container aContainer)

Neues Layout mit 1x1 großem Grid. Das Layout gilt nur für den Container aContainer.

SimpleGridLayout

public SimpleGridLayout(int cols,
                int rows,
                java.awt.Container aContainer)

Neues Layout mit cols x rows großem Grid. Das Layout arbeit nur mit dem angegebenen Container und kann nicht von mehreren Containern gemeinsam genutzt werden.

Method Detail

setContainer

protected void setContainer(java.awt.Container aContainer)

checkContainer

protected void checkContainer(java.awt.Container aContainer)

Prüfen, ob der übergebene container mit dem Container des Layouts übereinstimmt.

lookupConstraint

protected SimpleGridConstraints lookupConstraint(java.awt.Component comp)

SimpleGridConstraints zur Komponent comp suchen

createGrid

protected java.lang.Object[][] createGrid()

Erzeugt ein 2dim Objectarray in dem alle Komponenten eingetragen werden, die eine horizontal oder vertikal genau eine Zelle belegen. Daraus wird die Größe der feste Zeilen (Spalten) ermittelt. Komponenten, die sich über mehrere Zeilen (Spalten) Spalten erstrecken, gehen in die Betrachtung nicht ein.

calcColumnWidths

public int[] calcColumnWidths(java.lang.Object[][] grid)

Berechnet die Breite der fixen Spalten. Das Ergebnis ist ein Array das so lang ist, wie das Gitter breit ist. An den Positionen der variable breiten Spalten steht eine -1 bei den fixen Spalten die preferredSize der breitesten Komponente.

calcRowHeights

public int[] calcRowHeights(java.lang.Object[][] grid)

Berechnet die Breite der fixen Zeile. Das Ergebnis ist ein Array das so lang ist, wie das Gitter hoch ist. An den Positionen der variable hohen Zeilen steht eine -1 bei den fixen Zeile die preferredSize der höchsten Komponente.

calcPositions

protected void calcPositions(int[] positions,
                 int length,
                 int fixedNum)

Berechnet für Zeilen (Spalten) die Anfangsposition der Komponenten in der jeweiligen Zeile, Spalte unter Berücksichtigung des angegebenen Komponentenabstand.

getColumnCount

public int getColumnCount()

Anzahl der Spalten

setColumnCount

public void setColumnCount(int value)

Anzahl der Spalten setzen. Die Spaltenzahl muß mindestens eins sein. Andernfalls wird eine IllegalArgumentException geworfen.

getRowCount

public int getRowCount()

Anzahl der Zeilen.

setRowCount

public void setRowCount(int value)

Anzahl der Zeilen setzen. Die Zeilenzahl muß mindestens eins sein. Andernfalls wird eine IllegalArgumentException geworfen.

getGap

public int getGap()

Abstand Rand-Komponente bzw. Komponente-Komponente lesen

setGap

public void setGap(int value)

Abstand Rand-Komponente bzw. Komponente-Komponente setzen. Der Abstand darf nicht kleiner 0 werden. Andernfalls wird eine IllegalArgumentException geworfen.

fixColumn

public void fixColumn(int column)

Eine Spalte columnals unveränderlich in der Größe markieren Die Breite einer solchen Spalte richtet sich nach der preferredSize der breitesten Komponente in dieser Spalte.

fixColumns

public void fixColumns(int firstColumn,
              int lastColumn)

Spalten firstColumn bis einschließlich lastColumn als fix markieren.

isColumnFixed

public boolean isColumnFixed(int column)

true, wenn die Spalte column als größenunveränderlich markiert wurde.

fixRow

public void fixRow(int row)

Eine Zeile rowals unveränderlich in der Größe markieren Die Höhe einer solchen zeile richtet sich nach der preferredSize der höchsten Komponente in dieser Zeile.

fixRows

public void fixRows(int firstRow,
           int lastRow)

Zeilen firstRow bis einschließlich lastRow als fix markieren.

isRowFixed

public boolean isRowFixed(int row)

true, wenn die Zeile row als größenunveränderlich markiert wurde.

addLayoutComponent

public void addLayoutComponent(java.lang.String name,
                      java.awt.Component comp)

Das Einfügen einer Komponente mit einem String als constraint ist nicht möglich. Es wird eine IllegalArgumentException geworfen.

Specified by:

addLayoutComponent in interface java.awt.LayoutManager

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component comp)

Specified by:

removeLayoutComponent in interface java.awt.LayoutManager

calcVarSizes

protected int calcVarSizes(int[] sizes,
               int start,
               int length,
               int prefSize,
               java.util.Vector fixed)

Berechnet die Größe der nicht fix gekennzeichneten Zeilen (Spalten)

sumSizes

protected int sumSizes(int[] sizes,
           int maxVarSize)

Alle Höhen (Breiten) der Zeilen (Spalten) aufsummieren

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container parent)

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

minimumLayoutSize

public java.awt.Dimension minimumLayoutSize(java.awt.Container parent)

Specified by:

minimumLayoutSize in interface java.awt.LayoutManager

setComponentBounds

protected void setComponentBounds(java.awt.Component comp,
                      int left,
                      int top,
                      int width,
                      int height,
                      SimpleGridConstraints constraints)

layoutContainer

public void layoutContainer(java.awt.Container parent)

Specified by:

layoutContainer in interface java.awt.LayoutManager

addLayoutComponent

public void addLayoutComponent(java.awt.Component comp,
                      java.lang.Object constraints)

Specified by:

addLayoutComponent in interface java.awt.LayoutManager2

maximumLayoutSize

public java.awt.Dimension maximumLayoutSize(java.awt.Container target)

Specified by:

maximumLayoutSize in interface java.awt.LayoutManager2

getLayoutAlignmentX

public float getLayoutAlignmentX(java.awt.Container target)

Specified by:

getLayoutAlignmentX in interface java.awt.LayoutManager2

getLayoutAlignmentY

public float getLayoutAlignmentY(java.awt.Container target)

Specified by:

getLayoutAlignmentY in interface java.awt.LayoutManager2

invalidateLayout

public void invalidateLayout(java.awt.Container target)

Specified by:

invalidateLayout in interface java.awt.LayoutManager2