de.javagl.common.ui.layout

Class AspectLayout

java.lang.Object

de.javagl.common.ui.layout.AspectLayout

All Implemented Interfaces:

LayoutManager

public final class AspectLayout
extends Object
implements LayoutManager

An implementation of the LayoutManager interface, for containers that contain components that should be as large as possible under the constraint that a given aspect ratio (width/height) is maintained for each of them.

Constructor Summary

Constructors

Constructor and Description
AspectLayout(double aspect) Creates a new AspectLayout for the given aspect.
AspectLayout(double aspect, double alignment) Creates a new AspectLayout for the given aspect and alignment.

Method Summary

Modifier and Type	Method and Description
void	addLayoutComponent(String name, Component comp)
void	layoutContainer(Container parent)
Dimension	minimumLayoutSize(Container parent)
Dimension	preferredLayoutSize(Container parent)
void	removeLayoutComponent(Component comp)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AspectLayout

public AspectLayout(double aspect)

Creates a new AspectLayout for the given aspect. This is equivalent to calling AspectLayout(double, double) with an alignment of 0.5.

Parameters:

aspect - The aspect for the contained component

AspectLayout

public AspectLayout(double aspect,
                    double alignment)

Creates a new AspectLayout for the given aspect and alignment.

The layout will maintain the given aspect ratio for all its child components, arranging the child components in a grid so that as little space as possible is wasted.

If there is any excess space for the grid cells, the components will be aligned in their cells based on the given alignment value. The alignment is a value in [0,1], where a value of 0.0 means that the components are aligned at the left/top of their grid cell, 0.5 that they are centered, and 1.0 means that they are aligned at the bottom/right of their grid cell.

Parameters:

aspect - The aspect for the contained component

alignment - The alignment for the contained component

Method Detail

layoutContainer

public void layoutContainer(Container parent)

Specified by:

layoutContainer in interface LayoutManager

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)

Specified by:

minimumLayoutSize in interface LayoutManager

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)

Specified by:

preferredLayoutSize in interface LayoutManager

addLayoutComponent

public void addLayoutComponent(String name,
                               Component comp)

Specified by:

addLayoutComponent in interface LayoutManager

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Specified by:

removeLayoutComponent in interface LayoutManager

toString

public String toString()

Overrides:

toString in class Object