Image5DLayout (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- ij.gui.ImageLayout
- - sc.fiji.i5d.gui.Image5DLayout

All Implemented Interfaces:

LayoutManager, LayoutManager2
```
public class Image5DLayout
extends ImageLayout
implements LayoutManager2
```
Extended ImageLayout: compatible with two scrollbars for z and t below the image and a channelControl panel to the right of the image.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CANVAS`
`protected Component`	`channel`
`static String`	`CHANNEL_SELECTOR`
`protected Rectangle`	`contentBounds`
`protected Component`	`frame`
`static String`	`FRAME_SELECTOR`
`protected int`	`hgap`
`protected Image5DCanvas`	`ic5d`
`protected Vector<Image5DCanvas>`	`imageCanvasses`
`protected Vector<Rectangle>`	`imageRectangles`
`protected int`	`nCanvassesX`
`protected int`	`nCanvassesY`
`protected Component`	`slice`
`static String`	`SLICE_SELECTOR`
`protected double`	`targetAspect`
`protected int`	`vgap`

Constructor Summary

Constructors
Constructor and Description

Image5DLayout(Image5DCanvas ic5d)
Creates a new ImageLayout with center alignment and 5 pixel horizontal and vertical gaps.

Constructors
Constructor and Description
`Image5DLayout(Image5DCanvas ic5d)` Creates a new ImageLayout with center alignment and 5 pixel horizontal and vertical gaps.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLayoutComponent(Component comp, Object constraints)`
`void`	`addLayoutComponent(String name, Component comp)`
`Rectangle`	`getCanvasBounds(int i)`
`protected void`	`getCanvasLayout()` Calculates the grid of Canvasses in the Window for tiled display
`Rectangle`	`getContentBounds()`
`protected int`	`getHorizontalControlsHeight()`
`protected int`	`getHorizontalCoreSize(int canvasWidth)`
`float`	`getLayoutAlignmentX(Container target)`
`float`	`getLayoutAlignmentY(Container target)`
`int`	`getNCanvasses()`
`protected int`	`getVerticalControlsWidth()`
`protected int`	`getVerticalCoreSize(int canvasHeight)`
`void`	`invalidateLayout(Container target)`
`void`	`layoutContainer(Container target)` Lays out the container.
`Dimension`	`maximumLayoutSize(Container target)`
`Dimension`	`minimumLayoutSize(Container target)` Returns the minimum dimensions for this layout.
`Dimension`	`preferredLayoutSize(Container target)` Returns the preferred dimensions for this layout.
`Dimension`	`preferredLayoutSize(Container target, int canvasWidth, int canvasHeight)` Returns the preferred dimensions for this layout given the specified target (ImageWindow), canvasWidth and canvasHeight.
`void`	`removeLayoutComponent(Component comp)`

Methods inherited from class ij.gui.ImageLayout
ignoreNonImageWidths

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

- Field Detail
  - hgap
```
protected int hgap
```
  - vgap
```
protected int vgap
```
  - ic5d
```
protected Image5DCanvas ic5d
```
  - imageCanvasses
```
protected Vector<Image5DCanvas> imageCanvasses
```
  - imageRectangles
```
protected Vector<Rectangle> imageRectangles
```
  - nCanvassesX
```
protected int nCanvassesX
```
  - nCanvassesY
```
protected int nCanvassesY
```
  - contentBounds
```
protected Rectangle contentBounds
```
  - targetAspect
```
protected double targetAspect
```
  - CANVAS
```
public static final String CANVAS
```
    See Also:
    
    Constant Field Values
  - SLICE_SELECTOR
```
public static final String SLICE_SELECTOR
```
    See Also:
    
    Constant Field Values
  - FRAME_SELECTOR
```
public static final String FRAME_SELECTOR
```
    See Also:
    
    Constant Field Values
  - CHANNEL_SELECTOR
```
public static final String CHANNEL_SELECTOR
```
    See Also:
    
    Constant Field Values
  - slice
```
protected Component slice
```
  - frame
```
protected Component frame
```
  - channel
```
protected Component channel
```
- Constructor Detail
  - Image5DLayout
```
public Image5DLayout(Image5DCanvas ic5d)
```
    Creates a new ImageLayout with center alignment and 5 pixel horizontal and vertical gaps.
- Method Detail
  - preferredLayoutSize
```
public Dimension preferredLayoutSize(Container target)
```
    Returns the preferred dimensions for this layout. This is called when pack() is called on the ImageWindow. (?)
    
    Specified by:
    
    preferredLayoutSize in interface LayoutManager
    
    Overrides:
    
    preferredLayoutSize in class ImageLayout
  - preferredLayoutSize
```
public Dimension preferredLayoutSize(Container target,
                                     int canvasWidth,
                                     int canvasHeight)
```
    Returns the preferred dimensions for this layout given the specified target (ImageWindow), canvasWidth and canvasHeight. This is called from Image5DCanvas.canEnlarge().
  - minimumLayoutSize
```
public Dimension minimumLayoutSize(Container target)
```
    Returns the minimum dimensions for this layout.
    
    Specified by:
    
    minimumLayoutSize in interface LayoutManager
    
    Overrides:
    
    minimumLayoutSize in class ImageLayout
  - layoutContainer
```
public void layoutContainer(Container target)
```
    Lays out the container. This is called when the window is resized manually or by zooming.
    
    Specified by:
    
    layoutContainer in interface LayoutManager
    
    Overrides:
    
    layoutContainer in class ImageLayout
  - addLayoutComponent
```
public void addLayoutComponent(Component comp,
                               Object constraints)
```
    Specified by:
    
    addLayoutComponent in interface LayoutManager2
  - addLayoutComponent
```
public void addLayoutComponent(String name,
                               Component comp)
```
    Specified by:
    
    addLayoutComponent in interface LayoutManager
    
    Overrides:
    
    addLayoutComponent in class ImageLayout
  - removeLayoutComponent
```
public void removeLayoutComponent(Component comp)
```
    Specified by:
    
    removeLayoutComponent in interface LayoutManager
    
    Overrides:
    
    removeLayoutComponent in class ImageLayout
  - maximumLayoutSize
```
public Dimension maximumLayoutSize(Container target)
```
    Specified by:
    
    maximumLayoutSize in interface LayoutManager2
  - getLayoutAlignmentX
```
public float getLayoutAlignmentX(Container target)
```
    Specified by:
    
    getLayoutAlignmentX in interface LayoutManager2
  - getLayoutAlignmentY
```
public float getLayoutAlignmentY(Container target)
```
    Specified by:
    
    getLayoutAlignmentY in interface LayoutManager2
  - invalidateLayout
```
public void invalidateLayout(Container target)
```
    Specified by:
    
    invalidateLayout in interface LayoutManager2
  - getHorizontalCoreSize
```
protected int getHorizontalCoreSize(int canvasWidth)
```
  - getVerticalCoreSize
```
protected int getVerticalCoreSize(int canvasHeight)
```
  - getHorizontalControlsHeight
```
protected int getHorizontalControlsHeight()
```
  - getVerticalControlsWidth
```
protected int getVerticalControlsWidth()
```
  - getCanvasLayout
```
protected void getCanvasLayout()
```
    Calculates the grid of Canvasses in the Window for tiled display
  - getCanvasBounds
```
public Rectangle getCanvasBounds(int i)
```
  - getNCanvasses
```
public int getNCanvasses()
```
  - getContentBounds
```
public Rectangle getContentBounds()
```

Class Image5DLayout

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ij.gui.ImageLayout

Methods inherited from class java.lang.Object

Field Detail

hgap

vgap

ic5d

imageCanvasses

imageRectangles

nCanvassesX

nCanvassesY

contentBounds

targetAspect

CANVAS

SLICE_SELECTOR

FRAME_SELECTOR

CHANNEL_SELECTOR

slice

frame

channel

Constructor Detail

Image5DLayout

Method Detail

preferredLayoutSize

preferredLayoutSize

minimumLayoutSize

layoutContainer

addLayoutComponent

addLayoutComponent

removeLayoutComponent

maximumLayoutSize

getLayoutAlignmentX

getLayoutAlignmentY

invalidateLayout

getHorizontalCoreSize

getVerticalCoreSize

getHorizontalControlsHeight

getVerticalControlsWidth

getCanvasLayout

getCanvasBounds

getNCanvasses

getContentBounds