com.compdfkit.core.document

Class CPDFBackground

java.lang.Object

com.compdfkit.core.document.CPDFBackground

public class CPDFBackground
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFBackground.CPDFBackgroundAlign
static class	CPDFBackground.Type

Method Summary

Modifier and Type	Method and Description
void	clear() Removes the background.
int	getColor() Gets the color of the background.
CPDFBackground.CPDFBackgroundAlign	getHorizalign() Gets the horizontal alignment of the background.
float	getOpacity() Gets the opacity of the background.
java.lang.String	getPages() Gets the page range of the background by string, such as "0,3 or 5-7".
float	getRotation() Gets the rotation angle of the background.
float	getScale() Gets the scale of the background.
CPDFBackground.Type	getType() Gets the type of the background.
CPDFBackground.CPDFBackgroundAlign	getVertalign() Gets the vertical alignment of the background.
float	getXOffset() Gets the horizontal offset of the background.
float	getYOffset() Gets the vertical offset of the background.
boolean	isAllowsPrint() Gets whether to support the background to be printed.
boolean	isAllowsView() Gets whether to support the background to be displayed.
boolean	isValid() Whether CPDFBackground is valid.
void	release() Release CPDFBackground object
boolean	setAllowsPrint(boolean allow) Sets whether to support the background to be printed.
boolean	setAllowsView(boolean allow) Sets whether to support the background to be displayed.
boolean	setColor(int color) Sets the color of the background.
boolean	setHorizalign(CPDFBackground.CPDFBackgroundAlign align) Sets the horizontal alignment of the background.
boolean	setImage(android.graphics.Bitmap bitmap, CPDFImageScaleType scaleType) Sets the image of the background.
boolean	setImage(java.lang.String imgPath, java.lang.String maskPath, CPDFImageScaleType scaleType) Sets the image of the background.
boolean	setOpacity(float opacity) Sets the opacity of the background.
boolean	setPages(java.lang.String pages) Sets the page range of the background by string, such as "0,3 or 5-7".
boolean	setRotation(float rotation) Sets the rotation angle of the background.
boolean	setScale(float scale) Sets the scale of the background.
boolean	setType(CPDFBackground.Type type) Sets the type of the background.
boolean	setVertalign(CPDFBackground.CPDFBackgroundAlign align) Sets the vertical alignment of the background.
boolean	setXOffset(float offset) Sets the horizontal offset of the background.
boolean	setYOffset(float offset) Sets the vertical offset of the background.
void	update() Updates the background.

Methods inherited from class java.lang.Object

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

Method Detail

getType

public CPDFBackground.Type getType()

Gets the type of the background.

Returns:

the Type of the background

setType

public boolean setType(CPDFBackground.Type type)

Sets the type of the background.

Parameters:

type - the type of the background

Returns:

Whether the setting is successful

getOpacity

public float getOpacity()

Gets the opacity of the background.

Returns:

The opacity of the background

setOpacity

public boolean setOpacity(float opacity)

Sets the opacity of the background.

Parameters:

opacity - The opacity of the background.

Returns:

Whether the setting is successful

getScale

public float getScale()

Gets the scale of the background.

Returns:

The scale of the background

setScale

public boolean setScale(float scale)

Sets the scale of the background.

Parameters:

scale -

Returns:

Whether the setting is successful

getRotation

public float getRotation()

Gets the rotation angle of the background.

Returns:

The rotation

setRotation

public boolean setRotation(float rotation)

Sets the rotation angle of the background.

Parameters:

rotation - The rotation

Returns:

Whether the setting is successful

getHorizalign

public CPDFBackground.CPDFBackgroundAlign getHorizalign()

Gets the horizontal alignment of the background.

Returns:

Horizontal alignment

getVertalign

public CPDFBackground.CPDFBackgroundAlign getVertalign()

Gets the vertical alignment of the background.

Returns:

Vertical alignment

setHorizalign

public boolean setHorizalign(CPDFBackground.CPDFBackgroundAlign align)

Sets the horizontal alignment of the background.

Parameters:

align - Horizontal alignment

Returns:

Whether the setting is successful

setVertalign

public boolean setVertalign(CPDFBackground.CPDFBackgroundAlign align)

Sets the vertical alignment of the background.

Parameters:

align - Vertical alignment

Returns:

Whether the setting is successful

getXOffset

public float getXOffset()

Gets the horizontal offset of the background.

Returns:

Horizontal offset

getYOffset

public float getYOffset()

Gets the vertical offset of the background.

Returns:

Vertical offset

setXOffset

public boolean setXOffset(float offset)

Sets the horizontal offset of the background.

Parameters:

offset - Horizontal offset

Returns:

Whether the setting is successful

setYOffset

public boolean setYOffset(float offset)

Sets the vertical offset of the background.

Parameters:

offset - Vertical offset

Returns:

Whether the setting is successful

isAllowsView

public boolean isAllowsView()

Gets whether to support the background to be displayed.

Returns:

Whether to allow view.

isAllowsPrint

public boolean isAllowsPrint()

Gets whether to support the background to be printed.

Returns:

Whether to allow printing.

setAllowsView

public boolean setAllowsView(boolean allow)

Sets whether to support the background to be displayed.

Parameters:

allow - Whether to allow view.

Returns:

Whether the setting is successful

setAllowsPrint

public boolean setAllowsPrint(boolean allow)

Sets whether to support the background to be printed.

Parameters:

allow - Whether to allow printing.

Returns:

Whether the setting is successful

getPages

public java.lang.String getPages()

Gets the page range of the background by string, such as "0,3 or 5-7".

Returns:

page range

setPages

public boolean setPages(java.lang.String pages)

Sets the page range of the background by string, such as "0,3 or 5-7".

Parameters:

pages - page range

Returns:

Whether the setting is successful

setImage

public boolean setImage(java.lang.String imgPath,
                        java.lang.String maskPath,
                        CPDFImageScaleType scaleType)

Sets the image of the background.

Parameters:

imgPath - Image path

maskPath - Mask image path

scaleType - Scale type ,see CPDFImageScaleType

Returns:

Whether the setting is successful

setImage

public boolean setImage(android.graphics.Bitmap bitmap,
                        CPDFImageScaleType scaleType)

Sets the image of the background.

Parameters:

bitmap - Image bitmap

scaleType - Scale type ,see CPDFImageScaleType

Returns:

Whether the setting is successful

setColor

public boolean setColor(int color)

Sets the color of the background.

Parameters:

color - Color value (0x00000000~0xFFFFFFFF)

Returns:

Whether the setting is successful

getColor

public int getColor()

Gets the color of the background.

Returns:

Returns background color.

update

public void update()

Updates the background.

clear

public void clear()

Removes the background.

isValid

public boolean isValid()

Whether CPDFBackground is valid.

Returns:

Returns whether CPDFBackground object are valid.

release

public void release()

Release CPDFBackground object