Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.cf.PatternFormatting

Field Summary

Modifier and Type	Field and Description
public static final short	ALT_BARS Wide dots
public static final short	BIG_SPOTS Large spots
public static final short	BRICKS Brick-like layout
public static final short	DIAMONDS Diamonds
private int	field_15_pattern_style
private int	field_16_pattern_color_indexes
private static final BitField	fillPatternStyle
public static final short	FINE_DOTS Small fine dots
public static final short	LEAST_DOTS Least Dots
public static final short	LESS_DOTS Less Dots
public static final short	NO_FILL No background
private static final BitField	patternBackgroundColorIndex
private static final BitField	patternColorIndex
public static final short	SOLID_FOREGROUND Solidly filled
public static final short	SPARSE_DOTS Sparse dots
public static final short	SQUARES Squares
public static final short	THICK_BACKWARD_DIAG Thick backward facing diagonals
public static final short	THICK_FORWARD_DIAG Thick forward facing diagonals
public static final short	THICK_HORZ_BANDS Thick horizontal bands
public static final short	THICK_VERT_BANDS Thick vertical bands
public static final short	THIN_BACKWARD_DIAG Thin backward diagonal
public static final short	THIN_FORWARD_DIAG Thin forward diagonal
public static final short	THIN_HORZ_BANDS Thin horizontal bands
public static final short	THIN_VERT_BANDS Thin vertical bands

Constructor Summary

Access	Constructor and Description
public	PatternFormatting()
public	PatternFormatting(PatternFormatting other)
public	PatternFormatting(LittleEndianInput in)

Method Summary

Modifier and Type	Method and Description
public PatternFormatting	copy() Implements org.apache.poi.common.Duplicatable.copy.
public int	getDataLength()
public int	Returns: get the background fill color getFillBackgroundColor()
public int	Returns: get the foreground fill color getFillForegroundColor()
public int	Returns: fill pattern getFillPattern()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public void	serialize(LittleEndianOutput out)
public void	setFillBackgroundColor(int bg) set the background fill color.
public void	setFillForegroundColor(int fg) set the foreground fill color
public void	setFillPattern(int fill pattern fp) setting fill pattern
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

ALT_BARS	back to summary
public static final short ALT_BARS Wide dots

BIG_SPOTS	back to summary
public static final short BIG_SPOTS Large spots

BRICKS	back to summary
public static final short BRICKS Brick-like layout

DIAMONDS	back to summary
public static final short DIAMONDS Diamonds

field_15_pattern_style	back to summary
private int field_15_pattern_style

field_16_pattern_color_indexes	back to summary
private int field_16_pattern_color_indexes

fillPatternStyle	back to summary
private static final BitField fillPatternStyle

FINE_DOTS	back to summary
public static final short FINE_DOTS Small fine dots

LEAST_DOTS	back to summary
public static final short LEAST_DOTS Least Dots

LESS_DOTS	back to summary
public static final short LESS_DOTS Less Dots

NO_FILL	back to summary
public static final short NO_FILL No background

patternBackgroundColorIndex	back to summary
private static final BitField patternBackgroundColorIndex

patternColorIndex	back to summary
private static final BitField patternColorIndex

SOLID_FOREGROUND	back to summary
public static final short SOLID_FOREGROUND Solidly filled

SPARSE_DOTS	back to summary
public static final short SPARSE_DOTS Sparse dots

SQUARES	back to summary
public static final short SQUARES Squares

THICK_BACKWARD_DIAG	back to summary
public static final short THICK_BACKWARD_DIAG Thick backward facing diagonals

THICK_FORWARD_DIAG	back to summary
public static final short THICK_FORWARD_DIAG Thick forward facing diagonals

THICK_HORZ_BANDS	back to summary
public static final short THICK_HORZ_BANDS Thick horizontal bands

THICK_VERT_BANDS	back to summary
public static final short THICK_VERT_BANDS Thick vertical bands

THIN_BACKWARD_DIAG	back to summary
public static final short THIN_BACKWARD_DIAG Thin backward diagonal

THIN_FORWARD_DIAG	back to summary
public static final short THIN_FORWARD_DIAG Thin forward diagonal

THIN_HORZ_BANDS	back to summary
public static final short THIN_HORZ_BANDS Thin horizontal bands

THIN_VERT_BANDS	back to summary
public static final short THIN_VERT_BANDS Thin vertical bands

Constructor Detail

PatternFormatting	back to summary
public PatternFormatting()

PatternFormatting	back to summary
public PatternFormatting(PatternFormatting other)

PatternFormatting	back to summary
public PatternFormatting(LittleEndianInput in)

Method Detail

copy	back to summary
public PatternFormatting copy() Implements org.apache.poi.common.Duplicatable.copy. Returns:PatternFormatting Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance

copy

back to summary

public PatternFormatting copy()

Implements org.apache.poi.common.Duplicatable.copy.

Returns:PatternFormatting

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

getDataLength	back to summary
public int getDataLength()

getFillBackgroundColor	back to summary
public int getFillBackgroundColor() Returns:int get the background fill color See Also `org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)`

getFillForegroundColor	back to summary
public int getFillForegroundColor() Returns:int get the foreground fill color See Also `org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)`

getFillPattern	back to summary
public int getFillPattern() Returns:int fill pattern

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

serialize	back to summary
public void serialize(LittleEndianOutput out)

setFillBackgroundColor	back to summary
public void setFillBackgroundColor(int bg) set the background fill color.

setFillForegroundColor	back to summary
public void setFillForegroundColor(int fg) set the foreground fill color

setFillPattern back to summary

setFillPattern	back to summary
public void setFillPattern(int fp) setting fill pattern Parameters fp:int fill pattern See Also `NO_FILL`, `SOLID_FOREGROUND`, `FINE_DOTS`, `ALT_BARS`, `SPARSE_DOTS`, `THICK_HORZ_BANDS`, `THICK_VERT_BANDS`, `THICK_BACKWARD_DIAG`, `THICK_FORWARD_DIAG`, `BIG_SPOTS`, `BRICKS`, `THIN_HORZ_BANDS`, `THIN_VERT_BANDS`, `THIN_BACKWARD_DIAG`, `THIN_FORWARD_DIAG`, `SQUARES`, `DIAMONDS`

public void setFillPattern(int fp)

setting fill pattern

Parameters

fp:int: fill pattern

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object