com.hdcookbook.grin
Class MosaicSpec

java.lang.Object
  com.hdcookbook.grin.MosaicSpec

public class MosaicSpec
extends java.lang.Object

MosaicSpec provides a specification to the Mosaic builder about how to group images when building a image mosaic. This class is used only during the SEShow build time, in response to the "mosaics" entry, or to the deprecated "mosaic_hint" entry of the text-based show file.

Field Summary

java.lang.String[]	imagesToConsider The set of images to consider including.
java.lang.String[]	imagesToSkip The set of images to skip.
int	maxHeight
int	maxPixels
int	maxWidth
int	minWidth
java.lang.String	name
int	numWidths
boolean	takeAllImages If set true, this mosaic will accept all images used in shows that aren't part of another mosaic.

Constructor Summary

MosaicSpec(java.lang.String name)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

minWidth

public int minWidth

maxWidth

public int maxWidth

maxHeight

public int maxHeight

maxPixels

public int maxPixels

numWidths

public int numWidths

takeAllImages

public boolean takeAllImages

If set true, this mosaic will accept all images used in shows that aren't part of another mosaic.

imagesToConsider

public java.lang.String[] imagesToConsider

The set of images to consider including. Images are only included if they appear in a show. In order to include images that aren't used in a show (e.g. because they're used directly in an xlet), we make a synthetic SEShow with noShowFile set, and put FixedImage features in that show.

imagesToSkip

public java.lang.String[] imagesToSkip

The set of images to skip. These images will not appear in any mosaic, even though they might be used in a show.

Constructor Detail

MosaicSpec

public MosaicSpec(java.lang.String name)

Parameters:

name - The file name to put the mosaic in