com.wordpress.tipsforjava.swing
[Java] Class OverlapLayout

java.lang.Object
  com.wordpress.tipsforjava.swing.OverlapLayout

All Implemented Interfaces:

LayoutManager2, Serializable

public class OverlapLayout
extends Object

The OverlapLayout class is a layout manager that lays out a container's components in an overlapping fashion. A component can be painted "above" or "below" the previous component in the container. Like the GridLayout, each component is sized to the largest width and height of any component in the container. The amount of overlap is controlled by specifying the overlap postion of each component. You can simulate, left-to-right, right-to-left, top-to-bottom, bottom-to-top and diagonal layouts. As well you can "stack" components completely on top of one another. In this case the components are sized to the space available in the container. A main usage for this layout might be in the creation of "card games". A few features have been added that might be handy in these cases: a) a "popup" feature - when a component is selected in can "popup" from its regular location so it visibly stands out. To accomplish this some extra space must be reserved in the container for the popup. This is done by using the setPopupInsets method which allow you to control the popup direction. In addition you can add/remove a simple constraint to the component. POP_UP will popup the component. POP_DOWN or null will paint the component in its regular location. b) when a component is made "invisible" you can reserve its location in the container so all the other components don't shift. Note: this layout is achieved by changing the ZOrder of components in the container. It will not work for all components as some compnents will always paint themselves on the top of others. This seems to happen with components like JButton as rollover effects are painted when a mouse moves over the components.

Authors:

Rob Camick

Darryl Burke

MINIMUM

private static final int MINIMUM

POP_DOWN

public static Boolean POP_DOWN

POP_UP

public static Boolean POP_UP

PREFERRED

private static final int PREFERRED

components

private List components

constraints

private HashMap constraints

includeInvisible

private boolean includeInvisible

maximumSize

private Dimension maximumSize

overlapAbove

private boolean overlapAbove

overlapPosition

private Point overlapPosition

popupInsets

private Insets popupInsets

OverlapLayout

public OverlapLayout()

Convenience constructor to provide for "stacking" of components. Each component will be stacked above the previous component and sized to fill the space of the parent container.

OverlapLayout

public OverlapLayout(Point overlapPosition)

Convenience constructor. Each component will overlap above the previous component.

Parameters:

overlapPosition - a Point defining the relative amount of overlap

OverlapLayout

public OverlapLayout(Point overlapPosition, boolean overlapAbove)

Create an overlapping layout.

Parameters:

overlapPosition - a Point defining the relative amount of overlap

overlayAbove - when true components are painted above the previous component, otherwise they are painted below.

addLayoutComponent

public void addLayoutComponent(String name, Component comp)

Adds the specified component with the specified name to the layout.

Parameters:

name - the name of the component

comp - the component to be added

addLayoutComponent

public void addLayoutComponent(Component component, Object constraint)

convertIndex

public int convertIndex(int index)

When components are overlapped above the ZOrder of each component is changed resulting in the components position in the container being changed. For example when you add a component to the end of the container it will be moved to the beginning. If you then try to access the component using Component.componentAt(), you will get the first component, not the last. This method will convert the index to you access the proper component.

Parameters:

index - the index to convert

getConstraints

public Boolean getConstraints(Component component)

Gets the constraints for the specified component.

Parameters:

component - the component to be queried

Returns:

the constraint for the specified component, or null if component is null or is not present in this layout

getDimension

private Dimension getDimension(Component component, int type)

getLayoutAlignmentX

public float getLayoutAlignmentX(Container parent)

Returns the alignment along the x axis. Use center alignment.

getLayoutAlignmentY

public float getLayoutAlignmentY(Container parent)

Returns the alignment along the y axis. Use center alignment.

getLayoutSize

private Dimension getLayoutSize(Container parent, int type)

getOverlapPosition

public Point getOverlapPosition()

Get the overlapping position of each component

returns:

the Point representing the overlapped position

getPopupInsets

public Insets getPopupInsets()

Get the popup insets

returns:

the popup insets

invalidateLayout

public void invalidateLayout(Container target)

Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

isIncludeInvisible

public boolean isIncludeInvisible()

Get the include invisible property

returns:

the include invisible property

layoutContainer

public void layoutContainer(Container parent)

Lays out the specified container using this layout.

Parameters:

target - the container in which to do the layout

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)

There is no maximum.

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)

Determine the minimum size on the Container

Parameters:

target - the container in which to do the layout

Returns:

the minimum dimensions needed to lay out the subcomponents of the specified container

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)

Determine the preferred size on the Container

Parameters:

parent - the container in which to do the layout

Returns:

the preferred dimensions to lay out the subcomponents of the specified container

removeLayoutComponent

public void removeLayoutComponent(Component component)

Removes the specified component from the layout.

Parameters:

comp - the component to be removed

setIncludeInvisible

public void setIncludeInvisible(boolean includeInvisible)

Controls whether spaces should reserved for invisible components in the container

Parameters:

includeInvisible - when true, space is reserved otherwise the component is not included in the layout sizing

setOverlapPosition

public void setOverlapPosition(Point overlapPosition)

Specify the position where the overlapped component should be painted.

Parameters:

overlapPosition - the position where the next component is painted

setPopupInsets

public void setPopupInsets(Insets popupInsets)

Define extra space to be reserved by the container. This will allow components to be "popped up" if required. Generally space would only be reserved on one side of the container.

Parameters:

popupInsets - Insets defining extra space for a particular side of the container.

toString

public String toString()

Returns the string representation of this column layout's values.

Returns:

a string representation of this grid layout

Groovy Documentation