Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject

Field Summary

Modifier and Type	Field and Description
private static final String	BACKGROUND_COLOR
private static final String	BASELINE_SHIFT
private static final String	BBOX
private static final String	BLOCK_ALIGN
public static final String	BLOCK_ALIGN_AFTER BlockAlign: After: After edge of the last child’s allocation rectangle aligned with that of the table cell’s content rectangle.
public static final String	BLOCK_ALIGN_BEFORE BlockAlign: Before: Before edge of the first child’s allocation rectangle aligned with that of the table cell’s content rectangle.
public static final String	BLOCK_ALIGN_JUSTIFY BlockAlign: Justify: Children aligned with both the before and after edges of the table cell’s content rectangle.
public static final String	BLOCK_ALIGN_MIDDLE BlockAlign: Middle: Children centered within the table cell.
private static final String	BORDER_COLOR
private static final String	BORDER_STYLE
public static final String	BORDER_STYLE_DASHED BorderStyle: Dashed: The border is a series of short line segments.
public static final String	BORDER_STYLE_DOTTED BorderStyle: Dotted: The border is a series of dots.
public static final String	BORDER_STYLE_DOUBLE BorderStyle: Double: The border is two solid lines.
public static final String	BORDER_STYLE_GROOVE BorderStyle: Groove: The border looks as though it were carved into the canvas.
public static final String	BORDER_STYLE_HIDDEN BorderStyle: Hidden: Same as `BORDER_STYLE_NONE`, except in terms of border conflict resolution for table elements.
public static final String	BORDER_STYLE_INSET BorderStyle: Inset: The border makes the entire box look as though it were embedded in the canvas.
public static final String	BORDER_STYLE_NONE BorderStyle: None: No border.
public static final String	BORDER_STYLE_OUTSET BorderStyle: Outset: The border makes the entire box look as though it were coming out of the canvas (the opposite of `BORDER_STYLE_INSET`.
public static final String	BORDER_STYLE_RIDGE BorderStyle: Ridge: The border looks as though it were coming out of the canvas (the opposite of `BORDER_STYLE_GROOVE`).
public static final String	BORDER_STYLE_SOLID BorderStyle: Solid: The border is a single line segment.
private static final String	BORDER_THICKNESS
private static final String	COLOR
private static final String	COLUMN_COUNT
private static final String	COLUMN_GAP
private static final String	COLUMN_WIDTHS
private static final String	END_INDENT
private static final String	GLYPH_ORIENTATION_VERTICAL
public static final String	GLYPH_ORIENTATION_VERTICAL_180_DEGREES GlyphOrientationVertical: 180°
public static final String	GLYPH_ORIENTATION_VERTICAL_270_DEGREES GlyphOrientationVertical: 270°
public static final String	GLYPH_ORIENTATION_VERTICAL_360_DEGREES GlyphOrientationVertical: 360°
public static final String	GLYPH_ORIENTATION_VERTICAL_90_DEGREES GlyphOrientationVertical: 90°
public static final String	GLYPH_ORIENTATION_VERTICAL_AUTO GlyphOrientationVertical: Auto
public static final String	GLYPH_ORIENTATION_VERTICAL_MINUS_180_DEGREES GlyphOrientationVertical: -180°
public static final String	GLYPH_ORIENTATION_VERTICAL_MINUS_90_DEGREES GlyphOrientationVertical: -90°
public static final String	GLYPH_ORIENTATION_VERTICAL_ZERO_DEGREES GlyphOrientationVertical: 0°
private static final String	HEIGHT
public static final String	HEIGHT_AUTO Height: Auto
private static final String	INLINE_ALIGN
public static final String	INLINE_ALIGN_CENTER InlineAlign: Center: Each child centered within the table cell.
public static final String	INLINE_ALIGN_END InlineAlign: End: End edge of each child’s allocation rectangle aligned with that of the table cell’s content rectangle.
public static final String	INLINE_ALIGN_START InlineAlign: Start: Start edge of each child’s allocation rectangle aligned with that of the table cell’s content rectangle.
private static final String	LINE_HEIGHT
public static final String	LINE_HEIGHT_AUTO LineHeight: Auto: Adjustment for the value of BaselineShift shall not be made.
public static final String	LINE_HEIGHT_NORMAL LineHeight: NormalAdjust the line height to include any nonzero value specified for BaselineShift.
public static final String	OWNER_LAYOUT standard attribute owner: Layout
private static final String	PADDING
private static final String	PLACEMENT
public static final String	PLACEMENT_BEFORE Placement: Before: Placed so that the before edge of the element’s allocation rectangle coincides with that of the nearest enclosing reference area.
public static final String	PLACEMENT_BLOCK Placement: Block: Stacked in the block-progression direction within an enclosing reference area or parent BLSE.
public static final String	PLACEMENT_END Placement: End: Placed so that the end edge of the element’s allocation rectangle coincides with that of the nearest enclosing reference area.
public static final String	PLACEMENT_INLINE Placement: Inline: Packed in the inline-progression direction within an enclosing BLSE.
public static final String	PLACEMENT_START Placement: Start: Placed so that the start edge of the element’s allocation rectangle coincides with that of the nearest enclosing reference area.
private static final String	RUBY_ALIGN
public static final String	RUBY_ALIGN_CENTER RubyAlign: Center: The content shall be centered in the inline-progression direction.
public static final String	RUBY_ALIGN_DISTRIBUTE RubyAlign: Distribute: The content shall be expanded to fill the available width in the inline-progression direction.
public static final String	RUBY_ALIGN_END RubyAlign: End: The content shall be aligned on the end edge in the inline-progression direction.
public static final String	RUBY_ALIGN_JUSTIFY RubyAlign: Justify: The content shall be expanded to fill the available width in the inline-progression direction.
public static final String	RUBY_ALIGN_START RubyAlign: Start: The content shall be aligned on the start edge in the inline-progression direction.
private static final String	RUBY_POSITION
public static final String	RUBY_POSITION_AFTER RubyPosition: After: The RT content shall be aligned along the after edge of the element.
public static final String	RUBY_POSITION_BEFORE RubyPosition: Before: The RT content shall be aligned along the before edge of the element.
public static final String	RUBY_POSITION_INLINE RubyPosition: Inline: The RT and associated RP elements shall be formatted as a parenthesis comment, following the RB element.
public static final String	RUBY_POSITION_WARICHU RubyPosition: Warichu: The RT and associated RP elements shall be formatted as a warichu, following the RB element.
private static final String	SPACE_AFTER
private static final String	SPACE_BEFORE
private static final String	START_INDENT
private static final String	T_BORDER_STYLE
private static final String	T_PADDING
private static final String	TEXT_ALIGN
public static final String	TEXT_ALIGN_CENTER TextAlign: Center: Centered between the start and end edges.
public static final String	TEXT_ALIGN_END TextAlign: End: Aligned with the end edge.
public static final String	TEXT_ALIGN_JUSTIFY TextAlign: Justify: Aligned with both the start and end edges, with internal spacing within each line expanded, if necessary, to achieve such alignment.
public static final String	TEXT_ALIGN_START TextAlign: Start: Aligned with the start edge.
private static final String	TEXT_DECORATION_COLOR
private static final String	TEXT_DECORATION_THICKNESS
private static final String	TEXT_DECORATION_TYPE
public static final String	TEXT_DECORATION_TYPE_LINE_THROUGH TextDecorationType: LineThrough: A line through the middle of the text
public static final String	TEXT_DECORATION_TYPE_NONE TextDecorationType: None: No text decoration
public static final String	TEXT_DECORATION_TYPE_OVERLINE TextDecorationType: Overline: A line above the text
public static final String	TEXT_DECORATION_TYPE_UNDERLINE TextDecorationType: Underline: A line below the text
private static final String	TEXT_INDENT
private static final String	WIDTH
public static final String	WIDTH_AUTO Width: Auto
private static final String	WRITING_MODE
public static final String	WRITING_MODE_LRTB WritingMode: LrTb: Inline progression from left to right; block progression from top to bottom.
public static final String	WRITING_MODE_RLTB WritingMode: RlTb: Inline progression from right to left; block progression from top to bottom.
public static final String	WRITING_MODE_TBRL WritingMode: TbRl: Inline progression from top to bottom; block progression from right to left.

Inherited from org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject:: UNSPECIFIED

Access	Constructor and Description
public	PDLayoutAttributeObject() Default constructor.
public	PDLayoutAttributeObject(COSDictionary the dictionary dictionary) Creates a new Layout attribute object with a given dictionary.

Method Summary

Modifier and Type	Method and Description
public PDGamma	Returns: the background colour getBackgroundColor() Gets the background colour (BackgroundColor).
public float	Returns: the baseline shift getBaselineShift() Gets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift).
public PDRectangle	Returns: the bounding box. getBBox() Gets the bounding box.
public String	Returns: the block alignment getBlockAlign() Gets the alignment, in the block-progression direction, of content within the table cell (BlockAlign).
public Object	Returns: a single border colour (`PDGamma`) or four border colours (`PDFourColours`) getBorderColors() Gets the border colour (BorderColor).
public Object	Returns: the border styles (a String or an array of four Strings) getBorderStyle() Gets the border style (BorderStyle).
public Object	Returns: the border thickness (a Float or an array of four floats) getBorderThickness() Gets the border thickness (BorderThickness).
public PDGamma	Returns: the colour getColor() Gets the color to be used for drawing text and the default value for the colour of table borders and text decorations (Color).
public int	Returns: the column count getColumnCount() Gets the number of columns in the content of the grouping element (ColumnCount).
public Object	Returns: the column gap (FLoat or array of floats) getColumnGap() Gets the desired space between adjacent columns in the inline-progression direction (ColumnGap).
public Object	Returns: the column widths (Float or array of floats) getColumnWidths() Gets the desired width of the columns, measured in default user space units in the inline-progression direction (ColumnWidths).
public float	Returns: the end indent getEndIndent() Gets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).
public String	Returns: the vertical glyph orientation getGlyphOrientationVertical() Gets the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top (GlyphOrientationVertical).
public Object	Returns: the height (a Float or a String) getHeight() Gets the height of the element’s content rectangle in the block-progression direction (Height).
public String	Returns: the inline alignment getInlineAlign() Gets the alignment, in the inline-progression direction, of content within the table cell (InlineAlign).
public Object	Returns: the line height (a Float or a String) getLineHeight() Gets the element’s preferred height in the block-progression direction (LineHeight).
public Object	Returns: the padding (a Float or an array of float) getPadding() Gets the padding (Padding).
public String	Returns: the placement getPlacement() Gets the positioning of the element with respect to the enclosing reference area and other content (Placement).
public String	Returns: the ruby alignment getRubyAlign() Gets the justification of the lines within a ruby assembly (RubyAlign).
public String	Returns: the ruby position getRubyPosition() Gets the placement of the RT structure element relative to the RB element in a ruby assembly (RubyPosition).
public float	Returns: the space after getSpaceAfter() Gets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).
public float	Returns: the space before getSpaceBefore() Gets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).
public float	Returns: the start indent getStartIndent() Gets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).
public Object	Returns: the border style. getTBorderStyle() Gets the style of the border drawn on each edge of a table cell (TBorderStyle).
public String	Returns: the text alignment getTextAlign() Gets the alignment, in the inline-progression direction, of text and other content within lines of the BLSE (TextAlign).
public PDGamma	Returns: the text decoration colour getTextDecorationColor() Gets the colour to be used for drawing text decorations (TextDecorationColor).
public float	Returns: the text decoration thickness getTextDecorationThickness() Gets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).
public String	Returns: the type of text decoration getTextDecorationType() Gets the type of text decoration (TextDecorationType).
public float	Returns: the text indent getTextIndent() Gets the additional distance in the inline-progression direction from the start edge of the BLSE, as specified by StartIndent, to that of the first line of text (TextIndent).
public Object	Returns: the table padding (a Float or an array of float) getTPadding() Gets the offset to account for the separation between the table cell’s content rectangle and the surrounding border (TPadding).
public Object	Returns: the width (a Float or a String) getWidth() Gets the width of the element’s content rectangle in the inline-progression direction (Width).
public String	Returns: the writing mode getWritingMode() Gets the writing mode (WritingMode).
public void	setAllBorderColors(PDGamma the border colour borderColor) Sets the same border colour for all four sides (BorderColor).
public void	setAllBorderStyles(String the border style borderStyle) Sets the same border style for all four sides (BorderStyle).
public void	setAllBorderThicknesses(float the border thickness borderThickness) Sets the same border thickness for all four sides (BorderThickness).
public void	setAllBorderThicknesses(int the border thickness borderThickness) Sets the same border thickness for all four sides (BorderThickness).
public void	setAllColumnWidths(float the column width columnWidth) Sets the same column width for all columns (ColumnWidths).
public void	setAllColumnWidths(int the column width columnWidth) Sets the same column width for all columns (ColumnWidths).
public void	setAllPaddings(float the padding padding) Sets the same padding for all four sides (Padding).
public void	setAllPaddings(int the padding padding) Sets the same padding for all four sides (Padding).
public void	setAllTBorderStyles(String the table border style tBorderStyle) Sets the same table border style for all four sides (TBorderStyle).
public void	setAllTPaddings(float the table padding tPadding) Sets the same table padding for all four sides (TPadding).
public void	setAllTPaddings(int the table padding tPadding) Sets the same table padding for all four sides (TPadding).
public void	setBackgroundColor(PDGamma the background colour backgroundColor) Sets the background colour (BackgroundColor).
public void	setBaselineShift(float the baseline shift baselineShift) Sets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift).
public void	setBaselineShift(int the baseline shift baselineShift) Sets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift).
public void	setBBox(PDRectangle the bounding box bbox) Sets the bounding box.
public void	setBlockAlign(String the block alignment blockAlign) Sets the alignment, in the block-progression direction, of content within the table cell (BlockAlign).
public void	setBorderColors(PDFourColours the border colours borderColors) Sets the border colours for four sides separately (BorderColor).
public void	setBorderStyles(String[] the border styles (an array of four Strings) borderStyles) Sets the border styles for four sides separately (BorderStyle).
public void	setBorderThicknesses(float[] the border thickness (an array of four floats) borderThicknesses) Sets the border thicknesses for four sides separately (BorderThickness).
public void	setColor(PDGamma the colour color) Sets the color to be used for drawing text and the default value for the colour of table borders and text decorations (Color).
public void	setColumnCount(int the column count columnCount) Sets the number of columns in the content of the grouping element (ColumnCount).
public void	setColumnGap(float the column gap columnGap) Sets the desired space between all columns in the inline-progression direction (ColumnGap).
public void	setColumnGap(int the column gap columnGap) Sets the desired space between all columns in the inline-progression direction (ColumnGap).
public void	setColumnGaps(float[] the column gaps columnGaps) Sets the desired space between adjacent columns in the inline-progression direction (ColumnGap), the first element specifying the space between the first and second columns, the second specifying the space between the second and third columns, and so on.
public void	setColumnWidths(float[] the column widths columnWidths) Sets the column widths for the columns separately (ColumnWidths).
public void	setEndIndent(float the end indent endIndent) Sets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).
public void	setEndIndent(int the end indent endIndent) Sets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).
public void	setGlyphOrientationVertical(String the vertical glyph orientation glyphOrientationVertical) Sets the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top (GlyphOrientationVertical).
public void	setHeight(float the height height) Sets the height of the element’s content rectangle in the block-progression direction (Height).
public void	setHeight(int the height height) Sets the height of the element’s content rectangle in the block-progression direction (Height).
public void	setHeightAuto() Sets the height of the element’s content rectangle in the block-progression direction (Height) to `HEIGHT_AUTO`.
public void	setInlineAlign(String the inline alignment inlineAlign) Sets the alignment, in the inline-progression direction, of content within the table cell (InlineAlign).
public void	setLineHeight(float the line height lineHeight) Sets the element’s preferred height in the block-progression direction (LineHeight).
public void	setLineHeight(int the line height lineHeight) Sets the element’s preferred height in the block-progression direction (LineHeight).
public void	setLineHeightAuto() Sets the element’s preferred height in the block-progression direction (LineHeight) to `LINE_HEIGHT_AUTO`.
public void	setLineHeightNormal() Sets the element’s preferred height in the block-progression direction (LineHeight) to `LINE_HEIGHT_NORMAL`.
public void	setPaddings(float[] the paddings (an array of four floats) paddings) Sets the paddings for four sides separately (Padding).
public void	setPlacement(String the placement placement) Sets the positioning of the element with respect to the enclosing reference area and other content (Placement).
public void	setRubyAlign(String the ruby alignment rubyAlign) Sets the justification of the lines within a ruby assembly (RubyAlign).
public void	setRubyPosition(String the ruby position rubyPosition) Sets the placement of the RT structure element relative to the RB element in a ruby assembly (RubyPosition).
public void	setSpaceAfter(float the space after spaceAfter) Sets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).
public void	setSpaceAfter(int the space after spaceAfter) Sets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).
public void	setSpaceBefore(float the space before spaceBefore) Sets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).
public void	setSpaceBefore(int the space before spaceBefore) Sets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).
public void	setStartIndent(float the start indent startIndent) Sets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).
public void	setStartIndent(int the start indent startIndent) Sets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).
public void	setTBorderStyles(String[] the table border styles tBorderStyles) Sets the style of the border drawn on each edge of a table cell (TBorderStyle).
public void	setTextAlign(String the text alignment textIndent) Sets the alignment, in the inline-progression direction, of text and other content within lines of the BLSE (TextAlign).
public void	setTextDecorationColor(PDGamma the text decoration colour textDecorationColor) Sets the colour to be used for drawing text decorations (TextDecorationColor).
public void	setTextDecorationThickness(float the text decoration thickness textDecorationThickness) Sets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).
public void	setTextDecorationThickness(int the text decoration thickness textDecorationThickness) Sets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).
public void	setTextDecorationType(String the type of text decoration textDecorationType) Sets the type of text decoration (TextDecorationType).
public void	setTextIndent(float the text indent textIndent) Sets the additional distance in the inline-progression direction from the start edge of the BLSE, as specified by StartIndent, to that of the first line of text (TextIndent).
public void	setTextIndent(int the text indent textIndent) Sets the additional distance in the inline-progression direction from the start edge of the BLSE, as specified by StartIndent, to that of the first line of text (TextIndent).
public void	setTPaddings(float[] the table paddings (an array of four floats) tPaddings) Sets the table paddings for four sides separately (TPadding).
public void	setWidth(float the width width) Sets the width of the element’s content rectangle in the inline-progression direction (Width).
public void	setWidth(int the width width) Sets the width of the element’s content rectangle in the inline-progression direction (Width).
public void	setWidthAuto() Sets the width of the element’s content rectangle in the inline-progression direction (Width) to `WIDTH_AUTO`.
public void	setWritingMode(String the writing mode writingMode) Sets the writing mode (WritingMode).
public String	toString() Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString. Returns a string representation of the object.

public Class PDLayoutAttributeObject

Field Summary

Constructor Summary

Method Summary