rebuild.graphics.tiff.tags
Class PlanarConfigurationTag

java.lang.Object
  extended by rebuild.graphics.tiff.Tag
      extended by rebuild.graphics.tiff.tags.ShortTag
          extended by rebuild.graphics.tiff.tags.PlanarConfigurationTag

public final class PlanarConfigurationTag
extends ShortTag

How the components of each pixel are stored.

Since:
BBX 1.0.1

Field Summary
static short CHUNKY
          The component values for each pixel are stored contiguously.
static short PLANAR
          The components are stored in separate component planes.
 
Fields inherited from class rebuild.graphics.tiff.Tag
count, data, dataType, value
 
Constructor Summary
PlanarConfigurationTag()
          Create a new PlanarConfiguration tag.
PlanarConfigurationTag(short format)
          Create a new PlanarConfiguration tag.
 
Method Summary
 short getPlanarFormat()
          Get the current planar format value.
static short getTagTypeValue()
          Get the Tag's type.
 boolean hasDefault()
          Get if this Tag can have a default value, often defined by a parameter-less constructor.
 boolean isDefault()
          Get if this Tag's current value is the default value.
 void setCount(int count)
          There is always only 1 element.
 void setValue(int format)
          Set the planar format value to use.
 
Methods inherited from class rebuild.graphics.tiff.tags.ShortTag
extraData, getShort, setDataType, setExtraData, setShort, setupForBigTIFF, writeData
 
Methods inherited from class rebuild.graphics.tiff.Tag
equals, getBigCount, getBigValue, getCount, getDataType, getExtraData, getIfExtraDataExists, getTagType, getValue, hashCode, setCount, setValue, toString, write, write, write, write, writeBig
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CHUNKY

public static final short CHUNKY
The component values for each pixel are stored contiguously. For example, for RGB data, the data is stored as RGBRGBRGB.

See Also:
Constant Field Values

PLANAR

public static final short PLANAR
The components are stored in separate component planes. For example, RGB data is stored with the Red components in one component plane, the Green in another, and the Blue in another.

See Also:
Constant Field Values
Constructor Detail

PlanarConfigurationTag

public PlanarConfigurationTag()
Create a new PlanarConfiguration tag.


PlanarConfigurationTag

public PlanarConfigurationTag(short format)
Create a new PlanarConfiguration tag.

Parameters:
format - The format value to use.
Method Detail

getTagTypeValue

public static short getTagTypeValue()
Get the Tag's type.

Returns:
The Tag's type.

setCount

public void setCount(int count)
There is always only 1 element.

Overrides:
setCount in class ShortTag
Parameters:
count - The number of Writer.SHORT contained in the tag. If the number is bigger than the current count then it will add 0 Writer.SHORT, else it will remove the Writer.SHORT.
See Also:
setCount

setValue

public void setValue(int format)
Set the planar format value to use.

Overrides:
setValue in class Tag
Parameters:
format - The format to use.
See Also:
getValue

getPlanarFormat

public short getPlanarFormat()
Get the current planar format value.

Returns:
The planar format that this tag is set to.

hasDefault

public boolean hasDefault()
Get if this Tag can have a default value, often defined by a parameter-less constructor.

Overrides:
hasDefault in class ShortTag
Returns:
true if the Tag has a default value, false if otherwise. Default is false.

isDefault

public boolean isDefault()
Get if this Tag's current value is the default value. This is ignored if Tag.hasDefault() returns false.

Overrides:
isDefault in class ShortTag
Returns:
true if the Tag's value is the default value, false if otherwise.