com.spire.doc
Class Background

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.Background

All Implemented Interfaces:

IDocumentSerializable

public class Background
extends DocumentSerializable

Method Summary

java.lang.Object	fetchInheritedShapeAttr(int key)
java.lang.Object	fetchShapeAttr(int key)
java.awt.Color	getColor() Gets sets background color.
java.lang.Object	getDirectShapeAttr(int key)
java.lang.Object	getDirectShapeAttribute(int key) Reserved for system use.
BackgroundGradient	getGradient() Gets background gradient.
java.lang.Object	getInheritedShapeAttribute(int key) Reserved for system use.
java.awt.image.BufferedImage	getPicture() Gets background picture.
java.lang.Object	getShapeAttribute(int key) Reserved for system use.
BackgroundType	getType() Gets the type of background for document.
boolean	hasKey(int key)
void	removeShapeAttr(int key)
void	removeShapeAttribute(int key) Reserved for system use.
void	setColor(java.awt.Color value) Sets background color.
void	setPicture(java.awt.image.BufferedImage image) Sets background picture.
void	setPicture(java.io.InputStream imgStream) Sets the picture.
void	setPicture(java.lang.String imgFile) Sets the picture.
void	setShapeAttr(int key, java.lang.Object value) Reserved for system use.
void	setShapeAttribute(int key, java.lang.Object value) Reserved for system use.
void	setType(BackgroundType value) Sets the type of background for document.

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Method Detail

getType

public BackgroundType getType()

Gets the type of background for document.

Returns:

BackgroundType

setType

public void setType(BackgroundType value)

Sets the type of background for document.

Parameters:

value - BackgroundType

getPicture

public java.awt.image.BufferedImage getPicture()

Gets background picture.

Returns:

BufferedImage

setPicture

public void setPicture(java.awt.image.BufferedImage image)

Sets background picture.

Parameters:

image - BufferedImage

getColor

public java.awt.Color getColor()

Gets sets background color.

Returns:

java.awt.Color

setColor

public void setColor(java.awt.Color value)

Sets background color.

Parameters:

value - java.awt.Color

getGradient

public BackgroundGradient getGradient()

Gets background gradient.

Returns:

BackgroundGradient

getDirectShapeAttribute

public java.lang.Object getDirectShapeAttribute(int key)

Reserved for system use. IShapeAttrSource.

Parameters:

key -

Returns:

getInheritedShapeAttribute

public java.lang.Object getInheritedShapeAttribute(int key)

Reserved for system use. IShapeAttrSource.

Parameters:

key -

Returns:

getShapeAttribute

public java.lang.Object getShapeAttribute(int key)

Reserved for system use. IShapeAttrSource.

Parameters:

key -

Returns:

setShapeAttribute

public void setShapeAttribute(int key,
                              java.lang.Object value)

Reserved for system use. IShapeAttrSource.

Parameters:

key -

value -

setShapeAttr

public void setShapeAttr(int key,
                         java.lang.Object value)

Reserved for system use. IShapeAttrSource.

Parameters:

key -

value -

removeShapeAttribute

public void removeShapeAttribute(int key)

Reserved for system use. IShapeAttrSource.

Parameters:

key -

hasKey

public boolean hasKey(int key)

setPicture

public void setPicture(java.lang.String imgFile)

Sets the picture.

Parameters:

imgFile -

setPicture

public void setPicture(java.io.InputStream imgStream)

Sets the picture.

Parameters:

imgStream - InputStream

getDirectShapeAttr

public java.lang.Object getDirectShapeAttr(int key)

fetchInheritedShapeAttr

public java.lang.Object fetchInheritedShapeAttr(int key)

fetchShapeAttr

public java.lang.Object fetchShapeAttr(int key)

removeShapeAttr

public void removeShapeAttr(int key)