org.apache.wicket.extensions.markup.html.tree.table

Class ColumnLocation

java.lang.Object

org.apache.wicket.extensions.markup.html.tree.table.ColumnLocation

All Implemented Interfaces:

Serializable, org.apache.wicket.util.io.IClusterable

public class ColumnLocation
extends Object
implements org.apache.wicket.util.io.IClusterable

This class represents location of a column in tree table.

First attribute of location is alignment. Alignment specifies, whether the column is located on the left side of the table, on the right side, or in the middle. Columns in the middle of the table take all space between columns on the left and columns on the right.

Next two attributes are size and unit:

• For columns aligned to the left and to the right, the size represents the actual width of the column, according to chosen unit. Possible units for left and right aligned columns are PX, EM and PERCENT.
• For columns in the middle, the only valid unit is PROPORTIONAL. These columns take all available space between columns on the left and columns on the right. How this space is divided between middle columns is determined by the size. In this case the size can be understand as weight. Columns with bigger size take more space than columns with smaller size. For example, if there are three columns and their sizes are 2, 1, 1, the first column takes 50% of the space and the second two columns take 25% each.

Author:

Matej Knopp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnLocation.Alignment Alignment of the column.
static class	ColumnLocation.Unit Units.

Constructor Summary

Constructors

Constructor and Description
ColumnLocation(ColumnLocation.Alignment alignment, int size, ColumnLocation.Unit unit) Constructs the ColumnLocation object.

Method Summary

Methods

Modifier and Type	Method and Description
ColumnLocation.Alignment	getAlignment() Returns the alignment of this column.
int	getSize() Returns the size of this column.
ColumnLocation.Unit	getUnit() Returns the unit of a column.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnLocation

public ColumnLocation(ColumnLocation.Alignment alignment,
              int size,
              ColumnLocation.Unit unit)

Constructs the ColumnLocation object.

Parameters:

alignment - The column alignment

size - The column size in expressed in the provided unit

unit - The unit that the size argument is expressed in

Throws:

IllegalArgumentException - if the unit does not matche the alignment

Method Detail

getAlignment

public ColumnLocation.Alignment getAlignment()

Returns the alignment of this column.

Returns:

The alignment of this column

getSize

public int getSize()

Returns the size of this column.

Returns:

The size of this column

getUnit

public ColumnLocation.Unit getUnit()

Returns the unit of a column.

Returns:

The unit of this column