Package com.independentsoft.office.odf.styles

# Class FillImage

java.lang.Object
com.independentsoft.office.odf.styles.FillImage

public class FillImage extends Object
Represents a link to a bitmap resource.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `FillImage()`
  Instantiates a new fill image.
  `FillImage​(InternalXMLStreamReader reader)`
  Instantiates a new fill image.
  `FillImage​(String filePath)`
  Instantiates a new fill image.
  `FillImage​(String fileName, byte[] buffer)`
  Instantiates a new fill image.
  `FillImage​(String fileName, InputStream inputStream)`
  Instantiates a new fill image.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `FillImage`
  `clone()`
  Creates a new object that is a deep copy of the current instance.
  `String`
  `getActuate()`
  Default value for this attribute is onLoad.
  `byte[]`
  `getBuffer()`
  Gets an array of bytes of the image.
  `String`
  `getDisplayName()`
  Gets the name of the fill image.
  `String`
  `getFileName()`
  Gets the file name for the image.
  `String`
  `getFilter()`
  Gets the filter name for the image.
  `Size`
  `getHeight()`
  Gets the height of a linked image.
  `InputStream`
  `getInputStream()`
  Gets the input stream.
  `String`
  `getLocation()`
  Gets the image.
  `String`
  `getName()`
  Gets the name.
  `String`
  `getShow()`
  Default value for this attribute is embed.
  `String`
  `getType()`
  Always has the value simple.
  `Size`
  `getWidth()`
  Gets the width of a linked image.
  `void`
  `load​(String filePath)`
  Load.
  `void`
  `load​(String fileName, byte[] buffer)`
  Load.
  `void`
  `load​(String fileName, InputStream inputStream)`
  Load.
  `void`
  `save​(OutputStream outputStream)`
  Save.
  `void`
  `save​(String filePath)`
  Save.
  `void`
  `save​(String filePath, boolean overwrite)`
  Save.
  `void`
  `setActuate​(String actuate)`
  Default value for this attribute is onLoad.
  `void`
  `setBuffer​(byte[] buffer)`
  Sets an array of bytes of the image.
  `void`
  `setDisplayName​(String displayName)`
  Sets the name of the fill image.
  `void`
  `setFileName​(String fileName)`
  Sets the file name for the image.
  `void`
  `setFilter​(String filter)`
  Sets the filter name for the image.
  `void`
  `setHeight​(Size height)`
  Sets the height of a linked image.
  `void`
  `setLocation​(String location)`
  Sets the image.
  `void`
  `setName​(String name)`
  Sets the name.
  `void`
  `setShow​(String show)`
  Default value for this attribute is embed.
  `void`
  `setType​(String type)`
  Always has the value simple.
  `void`
  `setWidth​(Size width)`
  Sets the width of a linked image.
  `String`
  `toString()`
  Converts the value of the current FillImage object to its equivalent string representation.

  ### Methods inherited from class java.lang.Object

  `equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### FillImage

    public FillImage()
    Instantiates a new fill image.

  - ### FillImage

    public FillImage​(InternalXMLStreamReader reader) throws XMLStreamException
    Instantiates a new fill image.
    Parameters:
      `reader` - the reader
    Throws:
      `XMLStreamException` - the xML stream exception

  - ### FillImage

    public FillImage​(String filePath) throws IOException
    Instantiates a new fill image.
    Parameters:
      `filePath` - the file path
    Throws:
      `IOException` - Signals that an I/O exception has occurred.

  - ### FillImage

    public FillImage​(String fileName, InputStream inputStream) throws IOException
    Instantiates a new fill image.
    Parameters:
      `fileName` - the file name
      `inputStream` - the input stream
    Throws:
      `IOException` - Signals that an I/O exception has occurred.

  - ### FillImage

    public FillImage​(String fileName, byte[] buffer)
    Instantiates a new fill image.
    Parameters:
      `fileName` - the file name
      `buffer` - the buffer

- ## Method Details

  - ### load

    public void load​(String filePath) throws IOException
    Load.
    Parameters:
      `filePath` - the file path
    Throws:
      `IOException` - Signals that an I/O exception has occurred.

  - ### load

    public void load​(String fileName, InputStream inputStream) throws IOException
    Load.
    Parameters:
      `fileName` - the file name
      `inputStream` - the input stream
    Throws:
      `IOException` - Signals that an I/O exception has occurred.

  - ### load

    public void load​(String fileName, byte[] buffer)
    Load.
    Parameters:
      `fileName` - the file name
      `buffer` - the buffer

  - ### save

    public void save​(String filePath) throws IOException
    Save.
    Parameters:
      `filePath` - the file path
    Throws:
      `IOException` - Signals that an I/O exception has occurred.

  - ### save

    public void save​(String filePath, boolean overwrite) throws IOException
    Save.
    Parameters:
      `filePath` - the file path
      `overwrite` - the overwrite
    Throws:
      `IOException` - Signals that an I/O exception has occurred.

  - ### save

    public void save​(OutputStream outputStream) throws IOException
    Save.
    Parameters:
      `outputStream` - the output stream
    Throws:
      `IOException` - Signals that an I/O exception has occurred.

  - ### getInputStream

    public InputStream getInputStream()
    Gets the input stream.
    Returns:
      the input stream

  - ### clone

    public FillImage clone()
    Creates a new object that is a deep copy of the current instance.
    Overrides:
      `clone` in class `Object`
    Returns:
      A new object that is a copy of this instance.

  - ### toString

    public String toString()
    Converts the value of the current FillImage object to its equivalent string representation.
    Overrides:
      `toString` in class `Object`
    Returns:
      the string

  - ### getName

    public String getName()
    Gets the name.
    Returns:
      the name

  - ### setName

    public void setName​(String name)
    Sets the name.
    Parameters:
      `name` - the new name

  - ### getDisplayName

    public String getDisplayName()
    Gets the name of the fill image.
    Returns:
      the display name

  - ### setDisplayName

    public void setDisplayName​(String displayName)
    Sets the name of the fill image.
    Parameters:
      `displayName` - the new display name

  - ### getLocation

    public String getLocation()
    Gets the image.
    Returns:
      the location

  - ### setLocation

    public void setLocation​(String location)
    Sets the image.
    Parameters:
      `location` - the new location

  - ### getType

    public String getType()
    Always has the value simple.
    Returns:
      the type

  - ### setType

    public void setType​(String type)
    Always has the value simple.
    Parameters:
      `type` - the new type

  - ### getShow

    public String getShow()
    Default value for this attribute is embed.
    Returns:
      the show

  - ### setShow

    public void setShow​(String show)
    Default value for this attribute is embed.
    Parameters:
      `show` - the new show

  - ### getActuate

    public String getActuate()
    Default value for this attribute is onLoad.
    Returns:
      the actuate

  - ### setActuate

    public void setActuate​(String actuate)
    Default value for this attribute is onLoad.
    Parameters:
      `actuate` - the new actuate

  - ### getWidth

    public Size getWidth()
    Gets the width of a linked image.
    Returns:
      the width

  - ### setWidth

    public void setWidth​(Size width)
    Sets the width of a linked image.
    Parameters:
      `width` - the new width

  - ### getHeight

    public Size getHeight()
    Gets the height of a linked image.
    Returns:
      the height

  - ### setHeight

    public void setHeight​(Size height)
    Sets the height of a linked image.
    Parameters:
      `height` - the new height

  - ### getFilter

    public String getFilter()
    Gets the filter name for the image.
    Returns:
      the filter

  - ### setFilter

    public void setFilter​(String filter)
    Sets the filter name for the image.
    Parameters:
      `filter` - the new filter

  - ### getFileName

    public String getFileName()
    Gets the file name for the image.
    Returns:
      the file name

  - ### setFileName

    public void setFileName​(String fileName)
    Sets the file name for the image.
    Parameters:
      `fileName` - the new file name

  - ### getBuffer

    public byte[] getBuffer()
    Gets an array of bytes of the image.
    Returns:
      the buffer

  - ### setBuffer

    public void setBuffer​(byte[] buffer)
    Sets an array of bytes of the image.
    Parameters:
      `buffer` - the new buffer