Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf

public Class PDFourColours

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSArray, .COSBase, .COSNull, org.apache.pdfbox.pdmodel.common.COSObjectable, org.apache.pdfbox.pdmodel.graphics.color.PDGamma
An object for four colours.
Author
Johannes Koch

Field Summary

Modifier and TypeField and Description
private final COSArray
array

Constructor Summary

AccessConstructor and Description
public
PDFourColours()

public
PDFourColours(COSArray array)

Method Summary

Modifier and TypeMethod and Description
public PDGamma

Returns:

the colour for the after edge
getAfterColour()

Gets the colour for the after edge.

public PDGamma

Returns:

the colour for the before edge
getBeforeColour()

Gets the colour for the before edge.

private PDGamma

Returns:

the colour
getColourByIndex(int
edge index
index)

Gets the colour by edge index.

public COSBase
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public PDGamma

Returns:

the colour for the end edge
getEndColour()

Gets the colour for the end edge.

public PDGamma

Returns:

the colour for the start edge
getStartColour()

Gets the colour for the start edge.

public void
setAfterColour(PDGamma
the colour for the after edge
colour)

Sets the colour for the after edge.

public void
setBeforeColour(PDGamma
the colour for the before edge
colour)

Sets the colour for the before edge.

private void
setColourByIndex(int
the edge index
index, PDGamma
the colour
colour)

Sets the colour by edge index.

public void
setEndColour(PDGamma
the colour for the end edge
colour)

Sets the colour for the end edge.

public void
setStartColour(PDGamma
the colour for the start edge
colour)

Sets the colour for the start edge.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

arrayback to summary
private final COSArray array

Constructor Detail

PDFourColoursback to summary
public PDFourColours()
PDFourColoursback to summary
public PDFourColours(COSArray array)

Method Detail

getAfterColourback to summary
public PDGamma getAfterColour()

Gets the colour for the after edge.

Returns:PDGamma

the colour for the after edge

getBeforeColourback to summary
public PDGamma getBeforeColour()

Gets the colour for the before edge.

Returns:PDGamma

the colour for the before edge

getColourByIndexback to summary
private PDGamma getColourByIndex(int index)

Gets the colour by edge index.

Parameters
index:int

edge index

Returns:PDGamma

the colour

getCOSObjectback to summary
public COSBase getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Doc from org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSBase

The cos object that matches this Java object.

Annotations
@Override
getEndColourback to summary
public PDGamma getEndColour()

Gets the colour for the end edge.

Returns:PDGamma

the colour for the end edge

getStartColourback to summary
public PDGamma getStartColour()

Gets the colour for the start edge.

Returns:PDGamma

the colour for the start edge

setAfterColourback to summary
public void setAfterColour(PDGamma colour)

Sets the colour for the after edge.

Parameters
colour:PDGamma

the colour for the after edge

setBeforeColourback to summary
public void setBeforeColour(PDGamma colour)

Sets the colour for the before edge.

Parameters
colour:PDGamma

the colour for the before edge

setColourByIndexback to summary
private void setColourByIndex(int index, PDGamma colour)

Sets the colour by edge index.

Parameters
index:int

the edge index

colour:PDGamma

the colour

setEndColourback to summary
public void setEndColour(PDGamma colour)

Sets the colour for the end edge.

Parameters
colour:PDGamma

the colour for the end edge

setStartColourback to summary
public void setStartColour(PDGamma colour)

Sets the colour for the start edge.

Parameters
colour:PDGamma

the colour for the start edge