IlvChartLayout (Rogue Wave JViews 9.2 API)

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

All Implemented Interfaces:

IlvServerSideLayout, LayoutManager, LayoutManager2, Serializable
```
public class IlvChartLayout
extends Object
implements LayoutManager2, Serializable, IlvServerSideLayout
```
A layout manager class arranging and resizing the container components to fit in 8 regions: north top, north bottom, south top, south bottom, center, west, east, and absolute. The west and east regions define three different places to place a component: west, north west, south west and east, north east, south east, respectively. Each region is identified by a corresponding constant : NORTH_TOP, NORTH_BOTTOM, SOUTH_BOTTOM, SOUTH_TOP, NORTH_WEST, WEST, SOUTH_WEST, NORTH_EAST, EAST, SOUTH_EAST, CENTER and ABSOLUTE.
The following figures show the different regions with an eastern component placed at NORTH_EAST :

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ABSOLUTE` The absolute layout constraint (within the chart using the component bounds).
`static String`	`CENTER` The center layout constraint (middle of the chart).
`static String`	`EAST` The east layout constraint (right side of the chart).
`static String`	`NORTH_BOTTOM` The north-bottom layout constraint (top of the chart, below the north-top component).
`static String`	`NORTH_EAST` The north-east layout constraint (right side and top of the chart).
`static String`	`NORTH_TOP` The north-top layout constraint (top of the chart).
`static String`	`NORTH_WEST` The north-west layout constraint (left side and top of the chart).
`static String`	`SOUTH_BOTTOM` The south-bottom layout constraint (bottom of the chart).
`static String`	`SOUTH_EAST` The south-east layout constraint (right side and bottom of the chart).
`static String`	`SOUTH_TOP` The south-top layout constraint (bottom of the chart, above the south-bottom component).
`static String`	`SOUTH_WEST` The south-west layout constraint (left side and bottom of the chart).
`static String`	`WEST` The west layout constraint (left side of the chart).

Fields inherited from interface ilog.views.chart.IlvServerSideLayout
BOUNDS_PROPERTY

Constructor Summary

Constructors
Constructor and Description

IlvChartLayout()
Creates a new IlvChartLayout object.

Constructors
Constructor and Description
`IlvChartLayout()` Creates a new `IlvChartLayout` object.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLayoutComponent(Component comp, Object constraints)` Adds the specified component to the layout, using the specified constraint object.
`void`	`addLayoutComponent(String c, Component comp)` Deprecated. Replaced by addLayoutComponent(Component, Object).
`Map<Component,Rectangle>`	`computeBounds(Container target, Rectangle rect)` Returns a `Map` of components bounding boxes expressed as `Rectangle`s.
`float`	`getLayoutAlignmentX(Container parent)` Returns the alignment along the x-axis.
`float`	`getLayoutAlignmentY(Container parent)` Returns the alignment along the y-axis.
`void`	`invalidateLayout(Container target)` Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
`void`	`layoutContainer(Container target)` Lays out the container argument using this layout.
`Dimension`	`maximumLayoutSize(Container target)` Returns the maximum dimensions for this layout given the components in the specified target container.
`Dimension`	`minimumLayoutSize(Container target)` Determines the minimum size of the target container using this layout manager.
`Dimension`	`preferredLayoutSize(Container target)` Determines the preferred size of the target container using this layout manager, based on the components in the container.
`void`	`removeLayoutComponent(Component comp)` Removes the specified component from this layout.

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

- Field Detail
  - WEST
```
public static final String WEST
```
    The west layout constraint (left side of the chart).
    
    See Also:
    
    Constant Field Values
  - EAST
```
public static final String EAST
```
    The east layout constraint (right side of the chart).
    
    See Also:
    
    Constant Field Values
  - NORTH_TOP
```
public static final String NORTH_TOP
```
    The north-top layout constraint (top of the chart).
    
    See Also:
    
    Constant Field Values
  - NORTH_BOTTOM
```
public static final String NORTH_BOTTOM
```
    The north-bottom layout constraint (top of the chart, below the north-top component).
    
    See Also:
    
    Constant Field Values
  - SOUTH_BOTTOM
```
public static final String SOUTH_BOTTOM
```
    The south-bottom layout constraint (bottom of the chart).
    
    See Also:
    
    Constant Field Values
  - SOUTH_TOP
```
public static final String SOUTH_TOP
```
    The south-top layout constraint (bottom of the chart, above the south-bottom component).
    
    See Also:
    
    Constant Field Values
  - NORTH_WEST
```
public static final String NORTH_WEST
```
    The north-west layout constraint (left side and top of the chart).
    
    See Also:
    
    Constant Field Values
  - NORTH_EAST
```
public static final String NORTH_EAST
```
    The north-east layout constraint (right side and top of the chart).
    
    See Also:
    
    Constant Field Values
  - SOUTH_WEST
```
public static final String SOUTH_WEST
```
    The south-west layout constraint (left side and bottom of the chart).
    
    See Also:
    
    Constant Field Values
  - SOUTH_EAST
```
public static final String SOUTH_EAST
```
    The south-east layout constraint (right side and bottom of the chart).
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE
```
public static final String ABSOLUTE
```
    The absolute layout constraint (within the chart using the component bounds).
    
    See Also:
    
    Constant Field Values
  - CENTER
```
public static final String CENTER
```
    The center layout constraint (middle of the chart).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvChartLayout
```
public IlvChartLayout()
```
    Creates a new IlvChartLayout object.
- Method Detail
  - addLayoutComponent
```
public void addLayoutComponent(Component comp,
                               Object constraints)
```
    Adds the specified component to the layout, using the specified constraint object. For chart layout, the constraint object must be one of the constraint constants defined by the IlvChartLayout class. A null constraint means an absolute layout and is not taken into account by the layout manager.
    
    Specified by:
    
    addLayoutComponent in interface LayoutManager2
  - addLayoutComponent
```
@Deprecated
public void addLayoutComponent(String c,
                                           Component comp)
```
    Deprecated. Replaced by addLayoutComponent(Component, Object).
    
    Adds the specified component to the layout, using the specified constraint object. For chart layout, the constraint object must be one of the constraint constants defined by the IlvChartLayout class. A null constraint means an absolute layout and is not taken into account by the layout manager.
    
    Specified by:
    
    addLayoutComponent in interface LayoutManager
    
    Deprecated Since:
    
    JViews 5.0
  - removeLayoutComponent
```
public void removeLayoutComponent(Component comp)
```
    Removes the specified component from this layout. This method is called when a container calls its remove or removeAll methods.
    
    Specified by:
    
    removeLayoutComponent in interface LayoutManager
    
    Parameters:
    
    comp - The component to remove.
  - layoutContainer
```
public void layoutContainer(Container target)
```
    Lays out the container argument using this layout.
    This method actually reshapes the components in the specified container in order to satisfy the constraints of this IlvChartLayout object. The NORTH_TOP and NORTH_BOTTOM components (if any) are placed at the top of the container. The SOUTH_TOP and then SOUTH_BOTTOM components (if any) are placed at the bottom of the container. Then the east (EAST, SOUTH_EAST, NORTH_EAST) and the west (WEST, SOUTH_WEST, NORTH_WEST) components (if any) are placed on the right and left, respectively. Finally, the CENTER component is added in the middle.
    
    Specified by:
    
    layoutContainer 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.
  - preferredLayoutSize
```
public Dimension preferredLayoutSize(Container target)
```
    Determines the preferred size of the target container using this layout manager, based on the components in the container.
    
    Specified by:
    
    preferredLayoutSize in interface LayoutManager
  - minimumLayoutSize
```
public Dimension minimumLayoutSize(Container target)
```
    Determines the minimum size of the target container using this layout manager.
    
    Specified by:
    
    minimumLayoutSize in interface LayoutManager
  - maximumLayoutSize
```
public Dimension maximumLayoutSize(Container target)
```
    Returns the maximum dimensions for this layout given the components in the specified target container.
    
    Specified by:
    
    maximumLayoutSize in interface LayoutManager2
  - getLayoutAlignmentX
```
public float getLayoutAlignmentX(Container parent)
```
    Returns the alignment along the x-axis.
    
    Specified by:
    
    getLayoutAlignmentX in interface LayoutManager2
  - getLayoutAlignmentY
```
public float getLayoutAlignmentY(Container parent)
```
    Returns the alignment along the y-axis.
    
    Specified by:
    
    getLayoutAlignmentY in interface LayoutManager2
  - invalidateLayout
```
public void invalidateLayout(Container target)
```
    Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
    
    Specified by:
    
    invalidateLayout in interface LayoutManager2

Class IlvChartLayout

Field Summary

Fields inherited from interface ilog.views.chart.IlvServerSideLayout

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WEST

EAST

NORTH_TOP

NORTH_BOTTOM

SOUTH_BOTTOM

SOUTH_TOP

NORTH_WEST

NORTH_EAST

SOUTH_WEST

SOUTH_EAST

ABSOLUTE

CENTER

Constructor Detail

IlvChartLayout

Method Detail

addLayoutComponent

addLayoutComponent

removeLayoutComponent

layoutContainer

computeBounds

preferredLayoutSize

minimumLayoutSize

maximumLayoutSize

getLayoutAlignmentX

getLayoutAlignmentY

invalidateLayout