IlvLegendLayout (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.IlvLegendLayout

All Implemented Interfaces:

IlvServerSideLayout, LayoutManager, Serializable
```
public class IlvLegendLayout
extends Object
implements Serializable, IlvServerSideLayout
```
A LayoutManager class that arranges legend items. Depending on the legend position, this layout manager delegates the layout task to child layout managers.
The default layout policy is:
- When the legend is docked on top or at the bottom of an IlvChart, items are laid out as a grid, whose columns and rows are automatically computed to display all the legend items.
- When the legend is docked on the left or on the right of an IlvChart, legend items are laid out as a vertical flow, the column number of the flow being computed so that all items are visible.
- When the legend is floating, items are laid out as a one-column grid.
- When the legend has not been added to an IlvChart, items are laid out vertically as a one-column grid.
You can change this default behavior by creating LayoutManager instances of your choices by means of the corresponding factory methods.
Since:

JViews 5.5

See Also:

createNorthSouthLayout(), createEastWestLayout(), createFloatingLayout(), createDefaultLayout(), Serialized Form

Field Summary
- Fields inherited from interface ilog.views.chart.IlvServerSideLayout
  BOUNDS_PROPERTY

Constructor Summary

Constructors
Constructor and Description
`IlvLegendLayout(IlvLegend legend)` Creates a new `IlvLegendLayout` attached to the specified legend with default gap values of 5.
`IlvLegendLayout(IlvLegend legend, int hgap, int vgap)` Creates a new `IlvLegendLayout` attached to the specified legend with the specified gaps.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLayoutComponent(String str, Component component)` Adds the specified component to the layout, using the specified constraint.
`void`	`clearCaches()` Clears the caches of the layout delegates.
`Map<Component,Rectangle>`	`computeBounds(Container target, Rectangle rect)` Returns a `Map` of components bounding boxes expressed as `Rectangle`s.
`protected LayoutManager`	`createDefaultLayout()` Creates the `LayoutManager` instance used to lay out a legend that has not been added to a chart.
`protected LayoutManager`	`createEastWestLayout()` Creates the `LayoutManager` instance used to lay out a legend that has been docked on the east or the west side of a chart.
`protected LayoutManager`	`createFloatingLayout()` Creates the `LayoutManager` instance used to lay out a floating legend.
`protected LayoutManager`	`createNorthSouthLayout()` Creates the layout manager instance used to lay out a legend that has been docked on the north or the south side of a chart.
`protected LayoutManager`	`getDefaultLayout()` Returns the `LayoutManager` instance used to lay out a legend that has not been added to a chart.
`protected LayoutManager`	`getDelegate()`
`protected LayoutManager`	`getEastWestLayout()` Returns the `LayoutManager` instance used to lay out a legend that has been docked on the east or the west side of a chart.
`protected LayoutManager`	`getFloatingLayout()` Returns the `LayoutManager` instance used to lay out a floating legend.
`int`	`getFloatingLayoutDirection()` Returns the flow direction of the floating layout.
`int`	`getHGap()` Returns the horizontal gap.
`int`	`getHorizontalOrientation()` Returns the orientation used by a horizontal layout.
`IlvLegend`	`getLegend()` Returns the legend associates with this layout.
`protected LayoutManager`	`getNorthSouthLayout()` Returns the `LayoutManager` instance used to lay out a legend that has been docked on the north or the south side of a chart.
`int`	`getVerticalOrientation()` Returns the orientation used by a vertical layout.
`int`	`getVGap()` Returns the vertical gap.
`void`	`layoutContainer(Container target)` Lays out the container.
`Dimension`	`minimumLayoutSize(Container target)` Returns the minimum size needed to lay out the target container.
`Dimension`	`preferredLayoutSize(Container target)` Returns the preferred layout size of the container argument using this grid layout.
`void`	`removeLayoutComponent(Component component)` Removes the specified component from this layout.
`void`	`setFloatingLayoutDirection(int direction)` Sets the flow direction of the floating layout.
`void`	`setHGap(int hgap)` Sets the horizontal gap.
`void`	`setHorizontalOrientation(int orientation)` Sets the orientation used by a horizontal layout.
`void`	`setVerticalOrientation(int orientation)` Sets the orientation used by a vertical layout.
`void`	`setVGap(int vgap)` Sets the vertical gap.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvLegendLayout
```
public IlvLegendLayout(IlvLegend legend)
```
    Creates a new IlvLegendLayout attached to the specified legend with default gap values of 5.
  - IlvLegendLayout
```
public IlvLegendLayout(IlvLegend legend,
                       int hgap,
                       int vgap)
```
    Creates a new IlvLegendLayout attached to the specified legend with the specified gaps.
- Method Detail
  - getLegend
```
public IlvLegend getLegend()
```
    Returns the legend associates with this layout.
  - clearCaches
```
public void clearCaches()
```
    Clears the caches of the layout delegates.
    This method should be called whenever a parameter is changed that is used by one of the factory methods createNorthSouthLayout(), createEastWestLayout(), createFloatingLayout(), createDefaultLayout().
    
    Since:
    
    JViews 8.5
  - getFloatingLayoutDirection
```
public final int getFloatingLayoutDirection()
```
    Returns the flow direction of the floating layout.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setFloatingLayoutDirection(int)
  - setFloatingLayoutDirection
```
public void setFloatingLayoutDirection(int direction)
```
    Sets the flow direction of the floating layout.
    
    Parameters:
    
    direction - The direction of the flow. One of the SwingConstants.HORIZONTAL or SwingConstants.VERTICAL constants.
    
    Since:
    
    JViews 6.0
  - getHorizontalOrientation
```
public final int getHorizontalOrientation()
```
    Returns the orientation used by a horizontal layout.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    setHorizontalOrientation(int)
  - setHorizontalOrientation
```
public void setHorizontalOrientation(int orientation)
```
    Sets the orientation used by a horizontal layout.
    
    Parameters:
    
    orientation - The direction in which the items are layed out. One of the constants SwingConstants.TRAILING (meaning the usual writing direction) and SwingConstants.LEADING (meaning the opposite direction).
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    getHorizontalOrientation()
  - getVerticalOrientation
```
public final int getVerticalOrientation()
```
    Returns the orientation used by a vertical layout.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    setVerticalOrientation(int)
  - setVerticalOrientation
```
public void setVerticalOrientation(int orientation)
```
    Sets the orientation used by a vertical layout.
    
    Parameters:
    
    orientation - The direction in which the items are layed out. One of the constants SwingConstants.BOTTOM (meaning down from top to bottom) and SwingConstants.TOP (meaning up from bottom to top).
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    getVerticalOrientation()
  - getHGap
```
public int getHGap()
```
    Returns the horizontal gap.
  - setHGap
```
public void setHGap(int hgap)
```
    Sets the horizontal gap.
  - getVGap
```
public int getVGap()
```
    Returns the vertical gap.
  - setVGap
```
public void setVGap(int vgap)
```
    Sets the vertical gap.
  - getDefaultLayout
```
protected LayoutManager getDefaultLayout()
```
    Returns the LayoutManager instance used to lay out a legend that has not been added to a chart.
    
    See Also:
    
    createDefaultLayout()
  - createDefaultLayout
```
protected LayoutManager createDefaultLayout()
```
    Creates the LayoutManager instance used to lay out a legend that has not been added to a chart. The default implementation creates a GridLayout instance initialized with 1 column and 0 rows.
  - getNorthSouthLayout
```
protected LayoutManager getNorthSouthLayout()
```
    Returns the LayoutManager instance used to lay out a legend that has been docked on the north or the south side of a chart.
    
    See Also:
    
    createNorthSouthLayout()
  - createNorthSouthLayout
```
protected LayoutManager createNorthSouthLayout()
```
    Creates the layout manager instance used to lay out a legend that has been docked on the north or the south side of a chart. The default implementation returns a subclass of GridLayout.
  - getEastWestLayout
```
protected LayoutManager getEastWestLayout()
```
    Returns the LayoutManager instance used to lay out a legend that has been docked on the east or the west side of a chart.
    
    See Also:
    
    createEastWestLayout()
  - createEastWestLayout
```
protected LayoutManager createEastWestLayout()
```
    Creates the LayoutManager instance used to lay out a legend that has been docked on the east or the west side of a chart. The default implementation returns an IlvVerticalFlowLayout instance.
  - getFloatingLayout
```
protected LayoutManager getFloatingLayout()
```
    Returns the LayoutManager instance used to lay out a floating legend.
    
    See Also:
    
    createFloatingLayout()
  - createFloatingLayout
```
protected LayoutManager createFloatingLayout()
```
    Creates the LayoutManager instance used to lay out a floating legend. The default implementation returns a GridLayout instance initialized with 1 column and 0 rows.
  - getDelegate
```
protected final LayoutManager getDelegate()
```
  - layoutContainer
```
public void layoutContainer(Container target)
```
    Lays out the container.
    
    Specified by:
    
    layoutContainer in interface LayoutManager
    
    Parameters:
    
    target - The container to lay out.
  - preferredLayoutSize
```
public Dimension preferredLayoutSize(Container target)
```
    Returns the preferred layout size of the container argument using this grid layout.
    
    Specified by:
    
    preferredLayoutSize in interface LayoutManager
    
    Parameters:
    
    target - The component to lay out.
  - minimumLayoutSize
```
public Dimension minimumLayoutSize(Container target)
```
    Returns the minimum size needed to lay out the target container.
    
    Specified by:
    
    minimumLayoutSize in interface LayoutManager
    
    Parameters:
    
    target - The component to lay out.
  - addLayoutComponent
```
public void addLayoutComponent(String str,
                               Component component)
```
    Adds the specified component to the layout, using the specified constraint.
    
    Specified by:
    
    addLayoutComponent in interface LayoutManager
  - removeLayoutComponent
```
public void removeLayoutComponent(Component component)
```
    Removes the specified component from this layout.
    
    Specified by:
    
    removeLayoutComponent in interface LayoutManager
  - computeBounds
```
public Map<Component,Rectangle> computeBounds(Container target,
                                              Rectangle rect)
```
    Description copied from interface: IlvServerSideLayout
    
    Returns a Map of components bounding boxes expressed as Rectangles.
    
    Specified by:
    
    computeBounds in interface IlvServerSideLayout
    
    Parameters:
    
    target - The container of components.
    
    rect - The overall bounding rectangle.
    
    Returns:
    
    The Map of bounding boxes.

Class IlvLegendLayout

Field Summary

Fields inherited from interface ilog.views.chart.IlvServerSideLayout

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvLegendLayout

IlvLegendLayout

Method Detail

getLegend

clearCaches

getFloatingLayoutDirection

setFloatingLayoutDirection

getHorizontalOrientation

setHorizontalOrientation

getVerticalOrientation

setVerticalOrientation

getHGap

setHGap

getVGap

setVGap

getDefaultLayout

createDefaultLayout

getNorthSouthLayout

createNorthSouthLayout

getEastWestLayout

createEastWestLayout

getFloatingLayout

createFloatingLayout

getDelegate

layoutContainer

preferredLayoutSize

minimumLayoutSize

addLayoutComponent

removeLayoutComponent

computeBounds