Package com.luciad.gui.swing

Class TLcdOverlayLayout

java.lang.Object

com.luciad.gui.swing.TLcdOverlayLayout

All Implemented Interfaces:

LayoutManager, LayoutManager2

public class TLcdOverlayLayout
extends Object
implements LayoutManager2

Swing layout manager suitable for a Container panel overlaying a map. For JavaFX views, see TLcdOverlayPane.

You can add components to 10 distinct locations, and specify what should happen if multiple components are added to the same location.

To arrange components, use one of the following methods:

• Call the Container.add(Component, Object) method. You can pass a TLcdOverlayLayout.Location as constraints object. The default ResolveClash is TLcdOverlayLayout.ResolveClash.HORIZONTAL.
• Call one of the putConstraint(java.awt.Component, com.luciad.gui.swing.TLcdOverlayLayout.Location, com.luciad.gui.swing.TLcdOverlayLayout.ResolveClash) methods before adding the component to the container using an Container#add method without constraints parameter.

Below image shows the alignment for every single location with red spots which are the beginning of the this specific location.

Note: The implementation depends on the preferredSize of the Component. When this is not set, it will use a default Dimension equal to (50, 50). So it's important that getPreferredSize returns an appropriate value for any component you wish to add to a container with this LayoutManager.

Since:

9.1

See Also:

• TLcdOverlayLayout.Location
• TLcdOverlayLayout.ResolveClash

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TLcdOverlayLayout.Location	This enumeration identifies the different locations where components can be placed when added to the container.
static enum	TLcdOverlayLayout.ResolveClash	This enumeration can be used to indicate how the LayoutManager should handle multiple components added to the same location.

Constructor Summary

Constructors

Constructor	Description
TLcdOverlayLayout()	Default Constructor for TLcdOverlayLayout.

Method Summary

Modifier and Type	Method	Description
void	addLayoutComponent(Component aComponent, Object aConstraints)
void	addLayoutComponent(String aName, Component aComponent)	This implementation simply adds the component to the Location.NORTH_EAST.
float	getLayoutAlignmentX(Container aTarget)
float	getLayoutAlignmentY(Container aTarget)
void	invalidateLayout(Container aTarget)
void	layoutContainer(Container aParent)
Dimension	maximumLayoutSize(Container aTarget)
Dimension	minimumLayoutSize(Container aParent)
Dimension	preferredLayoutSize(Container aParent)
void	putConstraint(Component aComponent, TLcdOverlayLayout.Location aLocation, TLcdOverlayLayout.ResolveClash aResolveClash)	Specifies the location and clash resolution for the given object.
void	putConstraint(Component aComponent, TLcdOverlayLayout.Location aLocation, TLcdOverlayLayout.ResolveClash aResolveClash, int aXOffset, int aYOffset)	Specifies the location, clash resolution, and padding offsets for the given object.
void	removeLayoutComponent(Component aComponent)

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdOverlayLayout

public TLcdOverlayLayout()

Default Constructor for TLcdOverlayLayout.

Method Details

putConstraint

public void putConstraint(Component aComponent,
 TLcdOverlayLayout.Location aLocation,
 TLcdOverlayLayout.ResolveClash aResolveClash)

Specifies the location and clash resolution for the given object. A standard horizontal and vertical offset will be used (10 px by default).

If you call this method, do it before adding the object to the container, without specifying a constraint.

When resolving a clash at a specific location, the ResolveClash of the last component (according the container's child order) at the Location is used, .

Parameters:

aComponent - The component to be constrained.

aLocation - The location of the component.

aResolveClash - The ResolveClash constraint for the component.

See Also:

• putConstraint(java.awt.Component, com.luciad.gui.swing.TLcdOverlayLayout.Location, com.luciad.gui.swing.TLcdOverlayLayout.ResolveClash, int, int)

putConstraint

public void putConstraint(Component aComponent,
 TLcdOverlayLayout.Location aLocation,
 TLcdOverlayLayout.ResolveClash aResolveClash,
 int aXOffset,
 int aYOffset)

Specifies the location, clash resolution, and padding offsets for the given object. The offset parameters specify the distance between a component and his neighbour or the edge of the container.

If you call this method, do it before adding the object to the container, without specifying a constraint.

When resolving a clash at a specific location, the ResolveClash of the last component (according the container's child order) at the Location is used, .

Parameters:

aComponent - The component to be constrained.

aLocation - The location of the component.

aResolveClash - The ResolveClash constraint for the component.

aXOffset - The distance in pixels between the component and its left/right (depending on the Location) neighbour or the East/West edge of the container.

aYOffset - The distance in pixels between the component and its upper/lower (depending on the Location) neighbour or the North/South edge of the container.

addLayoutComponent

public void addLayoutComponent(String aName,
 Component aComponent)

This implementation simply adds the component to the Location.NORTH_EAST. Use the method Container.add(java.awt.Component, Object) in order to specify the location.

Specified by:

addLayoutComponent in interface LayoutManager

Throws:

UnsupportedOperationException - always

See Also:

• addLayoutComponent(java.awt.Component, Object)

addLayoutComponent

public void addLayoutComponent(Component aComponent,
 Object aConstraints)

This method will be called when you add a component to a container using the Container.add(java.awt.Component, Object) method. The constraints should be an instance of the TLcdOverlayLayout.Location Enumeration. If the passed object is null, NORTH_EAST will be set as the default Location. If the passed object is not an instance of Location, an IllegalArgumentException will be thrown. To set other constraints (ResolveClash, offsets) use the methods putConstraint(java.awt.Component, com.luciad.gui.swing.TLcdOverlayLayout.Location, com.luciad.gui.swing.TLcdOverlayLayout.ResolveClash) or putConstraint(java.awt.Component, com.luciad.gui.swing.TLcdOverlayLayout.Location, com.luciad.gui.swing.TLcdOverlayLayout.ResolveClash, int, int) .

Specified by:

addLayoutComponent in interface LayoutManager2

Parameters:

aComponent - The component to be added

aConstraints - An instance of TLcdOverlayLayout.Location that specifies the location of the component.

removeLayoutComponent

public void removeLayoutComponent(Component aComponent)

Specified by:

removeLayoutComponent in interface LayoutManager

maximumLayoutSize

public Dimension maximumLayoutSize(Container aTarget)

Specified by:

maximumLayoutSize in interface LayoutManager2

getLayoutAlignmentX

public float getLayoutAlignmentX(Container aTarget)

Specified by:

getLayoutAlignmentX in interface LayoutManager2

getLayoutAlignmentY

public float getLayoutAlignmentY(Container aTarget)

Specified by:

getLayoutAlignmentY in interface LayoutManager2

invalidateLayout

public void invalidateLayout(Container aTarget)

Specified by:

invalidateLayout in interface LayoutManager2

preferredLayoutSize

public Dimension preferredLayoutSize(Container aParent)

Specified by:

preferredLayoutSize in interface LayoutManager

minimumLayoutSize

public Dimension minimumLayoutSize(Container aParent)

Specified by:

minimumLayoutSize in interface LayoutManager

layoutContainer

public void layoutContainer(Container aParent)

Specified by:

layoutContainer in interface LayoutManager