ImageTag (Jett 0.11.0 API)

java.lang.Object
- net.sf.jett.tag.BaseTag
- - net.sf.jett.tag.ImageTag

All Implemented Interfaces:

Tag
```
public class ImageTag
extends BaseTag
```
An ImageTag represents an image to be placed on the sheet. The rows and cols attributes, if specified, control how many Excel rows tall and columns wide the image is. If not specified, the image is sized according to its natural dimensions. The required pathname attribute is the name of the image file, to be loaded relative to the current working directory. The optional type attribute gives the image type, which defaults to "png".

Attributes:
- Inherits all attributes from BaseTag.
- rows (optional): int
- cols (optional): int
- pathname (required): String
- type (optional): String
  - png The image is a PNG. (default)
  - jpeg The image is a JPG.
  - dib The image is a device-independent bitmap (or a .bmp).
  - pict The image is a Mac PICT.
  - wmf The image is a Windows Metafile.
  - emf The image is an enhanced Windows Metafile.
Since:

0.10.0

Author:

Randy Gettman

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ATTR_COLS`	Attribute for specifying the number of columns wide the image will be.
`static java.lang.String`	`ATTR_PATHNAME`	Attribute for specifying the pathname of the image file, relative to the current working directory.
`static java.lang.String`	`ATTR_ROWS`	Attribute for specifying the number of rows tall the image will be.
`static java.lang.String`	`ATTR_TYPE`	Attribute for specifying the type of the image file.
`static java.lang.String`	`DEF_TYPE`	The default image type, "png".
`static java.lang.String`	`TYPE_DIB`	The type for a device independent image (or .bmp).
`static java.lang.String`	`TYPE_EMF`	The type for a Enhanced Windows Metafile image.
`static java.lang.String`	`TYPE_JPEG`	The type for a JPEG image.
`static java.lang.String`	`TYPE_PICT`	The type for a Mac PICT image.
`static java.lang.String`	`TYPE_PNG`	The type for a PNG image.
`static java.lang.String`	`TYPE_WMF`	The type for a Windows Metafile image.

Fields inherited from class net.sf.jett.tag.BaseTag
ATTR_ON_PROCESSED, SPEC_SEP

Constructor Summary

Constructors
Constructor Description

ImageTag()

Constructors
Constructor	Description
`ImageTag()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getName()`	Returns this `Tag's` name.
`java.util.List<java.lang.String>`	`getOptionalAttributes()`	Returns the `List` of optional attribute names.
`java.util.List<java.lang.String>`	`getRequiredAttributes()`	Returns the `List` of required attribute names.
`boolean`	`process()`	Loads the image data and scales it if necessary, with the top-left corner of the image at the top-left corner of this cell.
`void`	`validateAttributes()`	Validates the attributes for this `Tag`.

Methods inherited from class net.sf.jett.tag.BaseTag
checkAttributes, clearBlock, deleteBlock, getAttributes, getContext, getLocation, getParentTag, getWorkbookContext, isBodiless, processTag, removeBlock, setAttributes, setBodiless, setContext, setParentTag, setWorkbookContext

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

- Field Detail
  - ATTR_ROWS
```
public static final java.lang.String ATTR_ROWS
```
    Attribute for specifying the number of rows tall the image will be. If neither rows nor cols is specified, then the image's dimensions will be preserved from the original image file.
    
    See Also:
    
    Constant Field Values
  - ATTR_COLS
```
public static final java.lang.String ATTR_COLS
```
    Attribute for specifying the number of columns wide the image will be. If neither rows nor cols is specified, then the image's dimensions will be preserved from the original image file.
    
    See Also:
    
    Constant Field Values
  - ATTR_PATHNAME
```
public static final java.lang.String ATTR_PATHNAME
```
    Attribute for specifying the pathname of the image file, relative to the current working directory.
    
    See Also:
    
    Constant Field Values
  - ATTR_TYPE
```
public static final java.lang.String ATTR_TYPE
```
    Attribute for specifying the type of the image file. If not specified, this defaults to "png".
    
    See Also:
    
    Constant Field Values
  - TYPE_DIB
```
public static final java.lang.String TYPE_DIB
```
    The type for a device independent image (or .bmp).
    
    See Also:
    
    Constant Field Values
  - TYPE_EMF
```
public static final java.lang.String TYPE_EMF
```
    The type for a Enhanced Windows Metafile image.
    
    See Also:
    
    Constant Field Values
  - TYPE_JPEG
```
public static final java.lang.String TYPE_JPEG
```
    The type for a JPEG image.
    
    See Also:
    
    Constant Field Values
  - TYPE_PICT
```
public static final java.lang.String TYPE_PICT
```
    The type for a Mac PICT image.
    
    See Also:
    
    Constant Field Values
  - TYPE_PNG
```
public static final java.lang.String TYPE_PNG
```
    The type for a PNG image.
    
    See Also:
    
    Constant Field Values
  - TYPE_WMF
```
public static final java.lang.String TYPE_WMF
```
    The type for a Windows Metafile image.
    
    See Also:
    
    Constant Field Values
  - DEF_TYPE
```
public static final java.lang.String DEF_TYPE
```
    The default image type, "png".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageTag
```
public ImageTag()
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns this Tag's name.
    
    Returns:
    
    This Tag's name.
  - getRequiredAttributes
```
public java.util.List<java.lang.String> getRequiredAttributes()
```
    Returns the List of required attribute names.
    
    Overrides:
    
    getRequiredAttributes in class BaseTag
    
    Returns:
    
    The List of required attribute names.
  - getOptionalAttributes
```
public java.util.List<java.lang.String> getOptionalAttributes()
```
    Returns the List of optional attribute names.
    
    Overrides:
    
    getOptionalAttributes in class BaseTag
    
    Returns:
    
    The List of optional attribute names.
  - validateAttributes
```
public void validateAttributes()
                        throws TagParseException
```
    Validates the attributes for this Tag. The "rows" and "cols" attributes, if present, must be positive integers.
    
    Overrides:
    
    validateAttributes in class BaseTag
    
    Throws:
    
    TagParseException - If the attribute values are illegal or unacceptable.
  - process
```
public boolean process()
```
    Loads the image data and scales it if necessary, with the top-left corner of the image at the top-left corner of this cell.
    
    Specified by:
    
    process in class BaseTag
    
    Returns:
    
    Whether the first Cell in the Block associated with this Tag was processed.

Class ImageTag

Field Summary

Fields inherited from class net.sf.jett.tag.BaseTag

Constructor Summary

Method Summary

Methods inherited from class net.sf.jett.tag.BaseTag

Methods inherited from class java.lang.Object

Field Detail

ATTR_ROWS

ATTR_COLS

ATTR_PATHNAME

ATTR_TYPE

TYPE_DIB

TYPE_EMF

TYPE_JPEG

TYPE_PICT

TYPE_PNG

TYPE_WMF

DEF_TYPE

Constructor Detail

ImageTag

Method Detail

getName

getRequiredAttributes

getOptionalAttributes

validateAttributes

process