Class PDLayoutAttributeObject
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
- All Implemented Interfaces:
COSObjectable
- Direct Known Subclasses:
PDExportFormatAttributeObject
A Layout attribute object.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private static final String
private static final String
private static final String
static final String
BlockAlign: After: After edge of the last child’s allocation rectangle aligned with that of the table cell’s content rectangle.static final String
BlockAlign: Before: Before edge of the first child’s allocation rectangle aligned with that of the table cell’s content rectangle.static final String
BlockAlign: Justify: Children aligned with both the before and after edges of the table cell’s content rectangle.static final String
BlockAlign: Middle: Children centered within the table cell.private static final String
private static final String
static final String
BorderStyle: Dashed: The border is a series of short line segments.static final String
BorderStyle: Dotted: The border is a series of dots.static final String
BorderStyle: Double: The border is two solid lines.static final String
BorderStyle: Groove: The border looks as though it were carved into the canvas.static final String
BorderStyle: Hidden: Same asBORDER_STYLE_NONE
, except in terms of border conflict resolution for table elements.static final String
BorderStyle: Inset: The border makes the entire box look as though it were embedded in the canvas.static final String
BorderStyle: None: No border.static final String
BorderStyle: Outset: The border makes the entire box look as though it were coming out of the canvas (the opposite ofBORDER_STYLE_INSET
.static final String
BorderStyle: Ridge: The border looks as though it were coming out of the canvas (the opposite ofBORDER_STYLE_GROOVE
).static final String
BorderStyle: Solid: The border is a single line segment.private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
static final String
GlyphOrientationVertical: 180°static final String
GlyphOrientationVertical: 270°static final String
GlyphOrientationVertical: 360°static final String
GlyphOrientationVertical: 90°static final String
GlyphOrientationVertical: Autostatic final String
GlyphOrientationVertical: -180°static final String
GlyphOrientationVertical: -90°static final String
GlyphOrientationVertical: 0°private static final String
static final String
Height: Autoprivate static final String
static final String
InlineAlign: Center: Each child centered within the table cell.static final String
InlineAlign: End: End edge of each child’s allocation rectangle aligned with that of the table cell’s content rectangle.static final String
InlineAlign: Start: Start edge of each child’s allocation rectangle aligned with that of the table cell’s content rectangle.private static final String
static final String
LineHeight: Auto: Adjustment for the value of BaselineShift shall not be made.static final String
LineHeight: NormalAdjust the line height to include any nonzero value specified for BaselineShift.static final String
standard attribute owner: Layoutprivate static final String
private static final String
static final String
Placement: Before: Placed so that the before edge of the element’s allocation rectangle coincides with that of the nearest enclosing reference area.static final String
Placement: Block: Stacked in the block-progression direction within an enclosing reference area or parent BLSE.static final String
Placement: End: Placed so that the end edge of the element’s allocation rectangle coincides with that of the nearest enclosing reference area.static final String
Placement: Inline: Packed in the inline-progression direction within an enclosing BLSE.static final String
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
static final String
RubyAlign: Center: The content shall be centered in the inline-progression direction.static final String
RubyAlign: Distribute: The content shall be expanded to fill the available width in the inline-progression direction.static final String
RubyAlign: End: The content shall be aligned on the end edge in the inline-progression direction.static final String
RubyAlign: Justify: The content shall be expanded to fill the available width in the inline-progression direction.static final String
RubyAlign: Start: The content shall be aligned on the start edge in the inline-progression direction.private static final String
static final String
RubyPosition: After: The RT content shall be aligned along the after edge of the element.static final String
RubyPosition: Before: The RT content shall be aligned along the before edge of the element.static final String
RubyPosition: Inline: The RT and associated RP elements shall be formatted as a parenthesis comment, following the RB element.static final String
RubyPosition: Warichu: The RT and associated RP elements shall be formatted as a warichu, following the RB element.private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
static final String
TextAlign: Center: Centered between the start and end edges.static final String
TextAlign: End: Aligned with the end edge.static final String
TextAlign: Justify: Aligned with both the start and end edges, with internal spacing within each line expanded, if necessary, to achieve such alignment.static final String
TextAlign: Start: Aligned with the start edge.private static final String
private static final String
private static final String
static final String
TextDecorationType: LineThrough: A line through the middle of the textstatic final String
TextDecorationType: None: No text decorationstatic final String
TextDecorationType: Overline: A line above the textstatic final String
TextDecorationType: Underline: A line below the textprivate static final String
private static final String
static final String
Width: Autoprivate static final String
static final String
WritingMode: LrTb: Inline progression from left to right; block progression from top to bottom.static final String
WritingMode: RlTb: Inline progression from right to left; block progression from top to bottom.static final String
WritingMode: TbRl: Inline progression from top to bottom; block progression from right to left.Fields inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
UNSPECIFIED
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.PDLayoutAttributeObject
(COSDictionary dictionary) Creates a new Layout attribute object with a given dictionary. -
Method Summary
Modifier and TypeMethodDescriptionGets the background colour (BackgroundColor).float
Gets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift).getBBox()
Gets the bounding box.Gets the alignment, in the block-progression direction, of content within the table cell (BlockAlign).Gets the border colour (BorderColor).Gets the border style (BorderStyle).Gets the border thickness (BorderThickness).getColor()
Gets the color to be used for drawing text and the default value for the colour of table borders and text decorations (Color).int
Gets the number of columns in the content of the grouping element (ColumnCount).Gets the desired space between adjacent columns in the inline-progression direction (ColumnGap).Gets the desired width of the columns, measured in default user space units in the inline-progression direction (ColumnWidths).float
Gets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).Gets the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top (GlyphOrientationVertical).Gets the height of the element’s content rectangle in the block-progression direction (Height).Gets the alignment, in the inline-progression direction, of content within the table cell (InlineAlign).Gets the element’s preferred height in the block-progression direction (LineHeight).Gets the padding (Padding).Gets the positioning of the element with respect to the enclosing reference area and other content (Placement).Gets the justification of the lines within a ruby assembly (RubyAlign).Gets the placement of the RT structure element relative to the RB element in a ruby assembly (RubyPosition).float
Gets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).float
Gets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).float
Gets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).Gets the style of the border drawn on each edge of a table cell (TBorderStyle).Gets the alignment, in the inline-progression direction, of text and other content within lines of the BLSE (TextAlign).Gets the colour to be used for drawing text decorations (TextDecorationColor).float
Gets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).Gets the type of text decoration (TextDecorationType).float
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).Gets the offset to account for the separation between the table cell’s content rectangle and the surrounding border (TPadding).getWidth()
Gets the width of the element’s content rectangle in the inline-progression direction (Width).Gets the writing mode (WritingMode).void
setAllBorderColors
(PDGamma borderColor) Sets the same border colour for all four sides (BorderColor).void
setAllBorderStyles
(String borderStyle) Sets the same border style for all four sides (BorderStyle).void
setAllBorderThicknesses
(float borderThickness) Sets the same border thickness for all four sides (BorderThickness).void
setAllBorderThicknesses
(int borderThickness) Sets the same border thickness for all four sides (BorderThickness).void
setAllColumnWidths
(float columnWidth) Sets the same column width for all columns (ColumnWidths).void
setAllColumnWidths
(int columnWidth) Sets the same column width for all columns (ColumnWidths).void
setAllPaddings
(float padding) Sets the same padding for all four sides (Padding).void
setAllPaddings
(int padding) Sets the same padding for all four sides (Padding).void
setAllTBorderStyles
(String tBorderStyle) Sets the same table border style for all four sides (TBorderStyle).void
setAllTPaddings
(float tPadding) Sets the same table padding for all four sides (TPadding).void
setAllTPaddings
(int tPadding) Sets the same table padding for all four sides (TPadding).void
setBackgroundColor
(PDGamma backgroundColor) Sets the background colour (BackgroundColor).void
setBaselineShift
(float baselineShift) Sets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift).void
setBaselineShift
(int baselineShift) Sets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift).void
setBBox
(PDRectangle bbox) Sets the bounding box.void
setBlockAlign
(String blockAlign) Sets the alignment, in the block-progression direction, of content within the table cell (BlockAlign).void
setBorderColors
(PDFourColours borderColors) Sets the border colours for four sides separately (BorderColor).void
setBorderStyles
(String[] borderStyles) Sets the border styles for four sides separately (BorderStyle).void
setBorderThicknesses
(float[] borderThicknesses) Sets the border thicknesses for four sides separately (BorderThickness).void
Sets the color to be used for drawing text and the default value for the colour of table borders and text decorations (Color).void
setColumnCount
(int columnCount) Sets the number of columns in the content of the grouping element (ColumnCount).void
setColumnGap
(float columnGap) Sets the desired space between all columns in the inline-progression direction (ColumnGap).void
setColumnGap
(int columnGap) Sets the desired space between all columns in the inline-progression direction (ColumnGap).void
setColumnGaps
(float[] 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.void
setColumnWidths
(float[] columnWidths) Sets the column widths for the columns separately (ColumnWidths).void
setEndIndent
(float endIndent) Sets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).void
setEndIndent
(int endIndent) Sets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).void
setGlyphOrientationVertical
(String glyphOrientationVertical) Sets the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top (GlyphOrientationVertical).void
setHeight
(float height) Sets the height of the element’s content rectangle in the block-progression direction (Height).void
setHeight
(int height) Sets the height of the element’s content rectangle in the block-progression direction (Height).void
Sets the height of the element’s content rectangle in the block-progression direction (Height) toHEIGHT_AUTO
.void
setInlineAlign
(String inlineAlign) Sets the alignment, in the inline-progression direction, of content within the table cell (InlineAlign).void
setLineHeight
(float lineHeight) Sets the element’s preferred height in the block-progression direction (LineHeight).void
setLineHeight
(int lineHeight) Sets the element’s preferred height in the block-progression direction (LineHeight).void
Sets the element’s preferred height in the block-progression direction (LineHeight) toLINE_HEIGHT_AUTO
.void
Sets the element’s preferred height in the block-progression direction (LineHeight) toLINE_HEIGHT_NORMAL
.void
setPaddings
(float[] paddings) Sets the paddings for four sides separately (Padding).void
setPlacement
(String placement) Sets the positioning of the element with respect to the enclosing reference area and other content (Placement).void
setRubyAlign
(String rubyAlign) Sets the justification of the lines within a ruby assembly (RubyAlign).void
setRubyPosition
(String rubyPosition) Sets the placement of the RT structure element relative to the RB element in a ruby assembly (RubyPosition).void
setSpaceAfter
(float spaceAfter) Sets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).void
setSpaceAfter
(int spaceAfter) Sets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).void
setSpaceBefore
(float spaceBefore) Sets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).void
setSpaceBefore
(int spaceBefore) Sets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).void
setStartIndent
(float startIndent) Sets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).void
setStartIndent
(int startIndent) Sets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).void
setTBorderStyles
(String[] tBorderStyles) Sets the style of the border drawn on each edge of a table cell (TBorderStyle).void
setTextAlign
(String textIndent) Sets the alignment, in the inline-progression direction, of text and other content within lines of the BLSE (TextAlign).void
setTextDecorationColor
(PDGamma textDecorationColor) Sets the colour to be used for drawing text decorations (TextDecorationColor).void
setTextDecorationThickness
(float textDecorationThickness) Sets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).void
setTextDecorationThickness
(int textDecorationThickness) Sets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).void
setTextDecorationType
(String textDecorationType) Sets the type of text decoration (TextDecorationType).void
setTextIndent
(float 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).void
setTextIndent
(int 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).void
setTPaddings
(float[] tPaddings) Sets the table paddings for four sides separately (TPadding).void
setWidth
(float width) Sets the width of the element’s content rectangle in the inline-progression direction (Width).void
setWidth
(int width) Sets the width of the element’s content rectangle in the inline-progression direction (Width).void
Sets the width of the element’s content rectangle in the inline-progression direction (Width) toWIDTH_AUTO
.void
setWritingMode
(String writingMode) Sets the writing mode (WritingMode).toString()
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
getArrayOfString, getColor, getColorOrFourColors, getInteger, getName, getName, getNameOrArrayOfName, getNumber, getNumber, getNumberOrArrayOfNumber, getNumberOrName, getString, isSpecified, setArrayOfName, setArrayOfNumber, setArrayOfString, setColor, setFourColors, setInteger, setName, setNumber, setNumber, setString
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
arrayToString, arrayToString, create, getOwner, isEmpty, notifyChanged, potentiallyNotifyChanged, setOwner, setStructureElement
Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
equals, getCOSObject, hashCode
-
Field Details
-
OWNER_LAYOUT
standard attribute owner: Layout- See Also:
-
PLACEMENT
- See Also:
-
WRITING_MODE
- See Also:
-
BACKGROUND_COLOR
- See Also:
-
BORDER_COLOR
- See Also:
-
BORDER_STYLE
- See Also:
-
BORDER_THICKNESS
- See Also:
-
PADDING
- See Also:
-
COLOR
- See Also:
-
SPACE_BEFORE
- See Also:
-
SPACE_AFTER
- See Also:
-
START_INDENT
- See Also:
-
END_INDENT
- See Also:
-
TEXT_INDENT
- See Also:
-
TEXT_ALIGN
- See Also:
-
BBOX
- See Also:
-
WIDTH
- See Also:
-
HEIGHT
- See Also:
-
BLOCK_ALIGN
- See Also:
-
INLINE_ALIGN
- See Also:
-
T_BORDER_STYLE
- See Also:
-
T_PADDING
- See Also:
-
BASELINE_SHIFT
- See Also:
-
LINE_HEIGHT
- See Also:
-
TEXT_DECORATION_COLOR
- See Also:
-
TEXT_DECORATION_THICKNESS
- See Also:
-
TEXT_DECORATION_TYPE
- See Also:
-
RUBY_ALIGN
- See Also:
-
RUBY_POSITION
- See Also:
-
GLYPH_ORIENTATION_VERTICAL
- See Also:
-
COLUMN_COUNT
- See Also:
-
COLUMN_GAP
- See Also:
-
COLUMN_WIDTHS
- See Also:
-
PLACEMENT_BLOCK
Placement: Block: Stacked in the block-progression direction within an enclosing reference area or parent BLSE.- See Also:
-
PLACEMENT_INLINE
Placement: Inline: Packed in the inline-progression direction within an enclosing BLSE.- See Also:
-
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. The element may float, if necessary, to achieve the specified placement. The element shall be treated as a block occupying the full extent of the enclosing reference area in the inline direction. Other content shall be stacked so as to begin at the after edge of the element’s allocation rectangle.- See Also:
-
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. The element may float, if necessary, to achieve the specified placement. Other content that would intrude into the element’s allocation rectangle shall be laid out as a runaround.- See Also:
-
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. The element may float, if necessary, to achieve the specified placement. Other content that would intrude into the element’s allocation rectangle shall be laid out as a runaround.- See Also:
-
WRITING_MODE_LRTB
WritingMode: LrTb: Inline progression from left to right; block progression from top to bottom. This is the typical writing mode for Western writing systems.- See Also:
-
WRITING_MODE_RLTB
WritingMode: RlTb: Inline progression from right to left; block progression from top to bottom. This is the typical writing mode for Arabic and Hebrew writing systems.- See Also:
-
WRITING_MODE_TBRL
WritingMode: TbRl: Inline progression from top to bottom; block progression from right to left. This is the typical writing mode for Chinese and Japanese writing systems.- See Also:
-
BORDER_STYLE_NONE
BorderStyle: None: No border. Forces the computed value of BorderThickness to be 0.- See Also:
-
BORDER_STYLE_HIDDEN
BorderStyle: Hidden: Same asBORDER_STYLE_NONE
, except in terms of border conflict resolution for table elements.- See Also:
-
BORDER_STYLE_DOTTED
BorderStyle: Dotted: The border is a series of dots.- See Also:
-
BORDER_STYLE_DASHED
BorderStyle: Dashed: The border is a series of short line segments.- See Also:
-
BORDER_STYLE_SOLID
BorderStyle: Solid: The border is a single line segment.- See Also:
-
BORDER_STYLE_DOUBLE
BorderStyle: Double: The border is two solid lines. The sum of the two lines and the space between them equals the value of BorderThickness.- See Also:
-
BORDER_STYLE_GROOVE
BorderStyle: Groove: The border looks as though it were carved into the canvas.- See Also:
-
BORDER_STYLE_RIDGE
BorderStyle: Ridge: The border looks as though it were coming out of the canvas (the opposite ofBORDER_STYLE_GROOVE
).- See Also:
-
BORDER_STYLE_INSET
BorderStyle: Inset: The border makes the entire box look as though it were embedded in the canvas.- See Also:
-
BORDER_STYLE_OUTSET
BorderStyle: Outset: The border makes the entire box look as though it were coming out of the canvas (the opposite ofBORDER_STYLE_INSET
.- See Also:
-
TEXT_ALIGN_START
TextAlign: Start: Aligned with the start edge.- See Also:
-
TEXT_ALIGN_CENTER
TextAlign: Center: Centered between the start and end edges.- See Also:
-
TEXT_ALIGN_END
TextAlign: End: Aligned with the end edge.- See Also:
-
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. The last (or only) line shall be aligned with the start edge only.- See Also:
-
WIDTH_AUTO
Width: Auto- See Also:
-
HEIGHT_AUTO
Height: Auto- See Also:
-
BLOCK_ALIGN_BEFORE
BlockAlign: Before: Before edge of the first child’s allocation rectangle aligned with that of the table cell’s content rectangle.- See Also:
-
BLOCK_ALIGN_MIDDLE
BlockAlign: Middle: Children centered within the table cell. The distance between the before edge of the first child’s allocation rectangle and that of the table cell’s content rectangle shall be the same as the distance between the after edge of the last child’s allocation rectangle and that of the table cell’s content rectangle.- See Also:
-
BLOCK_ALIGN_AFTER
BlockAlign: After: After edge of the last child’s allocation rectangle aligned with that of the table cell’s content rectangle.- See Also:
-
BLOCK_ALIGN_JUSTIFY
BlockAlign: Justify: Children aligned with both the before and after edges of the table cell’s content rectangle. The first child shall be placed as described forBLOCK_ALIGN_BEFORE
and the last child as described forBLOCK_ALIGN_AFTER
, with equal spacing between the children. If there is only one child, it shall be aligned with the before edge only, as forBLOCK_ALIGN_BEFORE
.- See Also:
-
INLINE_ALIGN_START
InlineAlign: Start: Start edge of each child’s allocation rectangle aligned with that of the table cell’s content rectangle.- See Also:
-
INLINE_ALIGN_CENTER
InlineAlign: Center: Each child centered within the table cell. The distance between the start edges of the child’s allocation rectangle and the table cell’s content rectangle shall be the same as the distance between their end edges.- See Also:
-
INLINE_ALIGN_END
InlineAlign: End: End edge of each child’s allocation rectangle aligned with that of the table cell’s content rectangle.- See Also:
-
LINE_HEIGHT_NORMAL
LineHeight: NormalAdjust the line height to include any nonzero value specified for BaselineShift.- See Also:
-
LINE_HEIGHT_AUTO
LineHeight: Auto: Adjustment for the value of BaselineShift shall not be made.- See Also:
-
TEXT_DECORATION_TYPE_NONE
TextDecorationType: None: No text decoration- See Also:
-
TEXT_DECORATION_TYPE_UNDERLINE
TextDecorationType: Underline: A line below the text- See Also:
-
TEXT_DECORATION_TYPE_OVERLINE
TextDecorationType: Overline: A line above the text- See Also:
-
TEXT_DECORATION_TYPE_LINE_THROUGH
TextDecorationType: LineThrough: A line through the middle of the text- See Also:
-
RUBY_ALIGN_START
RubyAlign: Start: The content shall be aligned on the start edge in the inline-progression direction.- See Also:
-
RUBY_ALIGN_CENTER
RubyAlign: Center: The content shall be centered in the inline-progression direction.- See Also:
-
RUBY_ALIGN_END
RubyAlign: End: The content shall be aligned on the end edge in the inline-progression direction.- See Also:
-
RUBY_ALIGN_JUSTIFY
RubyAlign: Justify: The content shall be expanded to fill the available width in the inline-progression direction.- See Also:
-
RUBY_ALIGN_DISTRIBUTE
RubyAlign: Distribute: The content shall be expanded to fill the available width in the inline-progression direction. However, space shall also be inserted at the start edge and end edge of the text. The spacing shall be distributed using a 1:2:1 (start:infix:end) ratio. It shall be changed to a 0:1:1 ratio if the ruby appears at the start of a text line or to a 1:1:0 ratio if the ruby appears at the end of the text line.- See Also:
-
RUBY_POSITION_BEFORE
RubyPosition: Before: The RT content shall be aligned along the before edge of the element.- See Also:
-
RUBY_POSITION_AFTER
RubyPosition: After: The RT content shall be aligned along the after edge of the element.- See Also:
-
RUBY_POSITION_WARICHU
RubyPosition: Warichu: The RT and associated RP elements shall be formatted as a warichu, following the RB element.- See Also:
-
RUBY_POSITION_INLINE
RubyPosition: Inline: The RT and associated RP elements shall be formatted as a parenthesis comment, following the RB element.- See Also:
-
GLYPH_ORIENTATION_VERTICAL_AUTO
GlyphOrientationVertical: Auto- See Also:
-
GLYPH_ORIENTATION_VERTICAL_MINUS_180_DEGREES
GlyphOrientationVertical: -180°- See Also:
-
GLYPH_ORIENTATION_VERTICAL_MINUS_90_DEGREES
GlyphOrientationVertical: -90°- See Also:
-
GLYPH_ORIENTATION_VERTICAL_ZERO_DEGREES
GlyphOrientationVertical: 0°- See Also:
-
GLYPH_ORIENTATION_VERTICAL_90_DEGREES
GlyphOrientationVertical: 90°- See Also:
-
GLYPH_ORIENTATION_VERTICAL_180_DEGREES
GlyphOrientationVertical: 180°- See Also:
-
GLYPH_ORIENTATION_VERTICAL_270_DEGREES
GlyphOrientationVertical: 270°- See Also:
-
GLYPH_ORIENTATION_VERTICAL_360_DEGREES
GlyphOrientationVertical: 360°- See Also:
-
-
Constructor Details
-
PDLayoutAttributeObject
public PDLayoutAttributeObject()Default constructor. -
PDLayoutAttributeObject
Creates a new Layout attribute object with a given dictionary.- Parameters:
dictionary
- the dictionary
-
-
Method Details
-
getPlacement
Gets the positioning of the element with respect to the enclosing reference area and other content (Placement). The default value isPLACEMENT_INLINE
.- Returns:
- the placement
-
setPlacement
Sets the positioning of the element with respect to the enclosing reference area and other content (Placement). The value should be one of:- Parameters:
placement
- the placement
-
getWritingMode
Gets the writing mode (WritingMode). The default value isWRITING_MODE_LRTB
.- Returns:
- the writing mode
-
setWritingMode
Sets the writing mode (WritingMode). The value should be one of:- Parameters:
writingMode
- the writing mode
-
getBackgroundColor
Gets the background colour (BackgroundColor).- Returns:
- the background colour
-
setBackgroundColor
Sets the background colour (BackgroundColor).- Parameters:
backgroundColor
- the background colour
-
getBorderColors
Gets the border colour (BorderColor).- Returns:
- a single border colour (
PDGamma
) or four border colours (PDFourColours
)
-
setAllBorderColors
Sets the same border colour for all four sides (BorderColor).- Parameters:
borderColor
- the border colour
-
setBorderColors
Sets the border colours for four sides separately (BorderColor).- Parameters:
borderColors
- the border colours
-
getBorderStyle
Gets the border style (BorderStyle). The default value isBORDER_STYLE_NONE
.- Returns:
- the border styles (a String or an array of four Strings)
-
setAllBorderStyles
Sets the same border style for all four sides (BorderStyle). The value should be one of:- Parameters:
borderStyle
- the border style
-
setBorderStyles
Sets the border styles for four sides separately (BorderStyle). The values should be of:- Parameters:
borderStyles
- the border styles (an array of four Strings)
-
getBorderThickness
Gets the border thickness (BorderThickness).- Returns:
- the border thickness (a Float or an array of four floats)
-
setAllBorderThicknesses
public void setAllBorderThicknesses(float borderThickness) Sets the same border thickness for all four sides (BorderThickness).- Parameters:
borderThickness
- the border thickness
-
setAllBorderThicknesses
public void setAllBorderThicknesses(int borderThickness) Sets the same border thickness for all four sides (BorderThickness).- Parameters:
borderThickness
- the border thickness
-
setBorderThicknesses
public void setBorderThicknesses(float[] borderThicknesses) Sets the border thicknesses for four sides separately (BorderThickness).- Parameters:
borderThicknesses
- the border thickness (an array of four floats)
-
getPadding
Gets the padding (Padding). The default value is 0.- Returns:
- the padding (a Float or an array of float)
-
setAllPaddings
public void setAllPaddings(float padding) Sets the same padding for all four sides (Padding).- Parameters:
padding
- the padding
-
setAllPaddings
public void setAllPaddings(int padding) Sets the same padding for all four sides (Padding).- Parameters:
padding
- the padding
-
setPaddings
public void setPaddings(float[] paddings) Sets the paddings for four sides separately (Padding).- Parameters:
paddings
- the paddings (an array of four floats)
-
getColor
Gets the color to be used for drawing text and the default value for the colour of table borders and text decorations (Color).- Returns:
- the colour
-
setColor
Sets the color to be used for drawing text and the default value for the colour of table borders and text decorations (Color).- Parameters:
color
- the colour
-
getSpaceBefore
public float getSpaceBefore()Gets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore). The default value is 0.- Returns:
- the space before
-
setSpaceBefore
public void setSpaceBefore(float spaceBefore) Sets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).- Parameters:
spaceBefore
- the space before
-
setSpaceBefore
public void setSpaceBefore(int spaceBefore) Sets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).- Parameters:
spaceBefore
- the space before
-
getSpaceAfter
public float getSpaceAfter()Gets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter). The default value is 0.- Returns:
- the space after
-
setSpaceAfter
public void setSpaceAfter(float spaceAfter) Sets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).- Parameters:
spaceAfter
- the space after
-
setSpaceAfter
public void setSpaceAfter(int spaceAfter) Sets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).- Parameters:
spaceAfter
- the space after
-
getStartIndent
public float getStartIndent()Gets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent). The default value is 0.- Returns:
- the start indent
-
setStartIndent
public void setStartIndent(float startIndent) Sets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).- Parameters:
startIndent
- the start indent
-
setStartIndent
public void setStartIndent(int startIndent) Sets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).- Parameters:
startIndent
- the start indent
-
getEndIndent
public float getEndIndent()Gets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent). The default value is 0.- Returns:
- the end indent
-
setEndIndent
public void setEndIndent(float endIndent) Sets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).- Parameters:
endIndent
- the end indent
-
setEndIndent
public void setEndIndent(int endIndent) Sets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).- Parameters:
endIndent
- the end indent
-
getTextIndent
public float 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). The default value is 0.- Returns:
- the text indent
-
setTextIndent
public void setTextIndent(float 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).- Parameters:
textIndent
- the text indent
-
setTextIndent
public void setTextIndent(int 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).- Parameters:
textIndent
- the text indent
-
getTextAlign
Gets the alignment, in the inline-progression direction, of text and other content within lines of the BLSE (TextAlign). The default value isTEXT_ALIGN_START
.- Returns:
- the text alignment
-
setTextAlign
Sets the alignment, in the inline-progression direction, of text and other content within lines of the BLSE (TextAlign). The value should be one of:- Parameters:
textIndent
- the text alignment
-
getBBox
Gets the bounding box.- Returns:
- the bounding box.
-
setBBox
Sets the bounding box.- Parameters:
bbox
- the bounding box
-
getWidth
Gets the width of the element’s content rectangle in the inline-progression direction (Width). The default value isWIDTH_AUTO
.- Returns:
- the width (a Float or a String)
-
setWidthAuto
public void setWidthAuto()Sets the width of the element’s content rectangle in the inline-progression direction (Width) toWIDTH_AUTO
. -
setWidth
public void setWidth(float width) Sets the width of the element’s content rectangle in the inline-progression direction (Width).- Parameters:
width
- the width
-
setWidth
public void setWidth(int width) Sets the width of the element’s content rectangle in the inline-progression direction (Width).- Parameters:
width
- the width
-
getHeight
Gets the height of the element’s content rectangle in the block-progression direction (Height). The default value isHEIGHT_AUTO
.- Returns:
- the height (a Float or a String)
-
setHeightAuto
public void setHeightAuto()Sets the height of the element’s content rectangle in the block-progression direction (Height) toHEIGHT_AUTO
. -
setHeight
public void setHeight(float height) Sets the height of the element’s content rectangle in the block-progression direction (Height).- Parameters:
height
- the height
-
setHeight
public void setHeight(int height) Sets the height of the element’s content rectangle in the block-progression direction (Height).- Parameters:
height
- the height
-
getBlockAlign
Gets the alignment, in the block-progression direction, of content within the table cell (BlockAlign). The default value isBLOCK_ALIGN_BEFORE
.- Returns:
- the block alignment
-
setBlockAlign
Sets the alignment, in the block-progression direction, of content within the table cell (BlockAlign). The value should be one of:- Parameters:
blockAlign
- the block alignment
-
getInlineAlign
Gets the alignment, in the inline-progression direction, of content within the table cell (InlineAlign). The default value isINLINE_ALIGN_START
.- Returns:
- the inline alignment
-
setInlineAlign
Sets the alignment, in the inline-progression direction, of content within the table cell (InlineAlign). The value should be one of- Parameters:
inlineAlign
- the inline alignment
-
getTBorderStyle
Gets the style of the border drawn on each edge of a table cell (TBorderStyle).- Returns:
- the border style.
-
setAllTBorderStyles
Sets the same table border style for all four sides (TBorderStyle). The value should be one of:- Parameters:
tBorderStyle
- the table border style
-
setTBorderStyles
Sets the style of the border drawn on each edge of a table cell (TBorderStyle). The values should be of:- Parameters:
tBorderStyles
- an array of border styles.
-
getTPadding
Gets the offset to account for the separation between the table cell’s content rectangle and the surrounding border (TPadding). The default value is 0.- Returns:
- the table padding (a Float or an array of float)
-
setAllTPaddings
public void setAllTPaddings(float tPadding) Sets the same table padding for all four sides (TPadding).- Parameters:
tPadding
- the table padding
-
setAllTPaddings
public void setAllTPaddings(int tPadding) Sets the same table padding for all four sides (TPadding).- Parameters:
tPadding
- the table padding
-
setTPaddings
public void setTPaddings(float[] tPaddings) Sets the table paddings for four sides separately (TPadding).- Parameters:
tPaddings
- the table paddings (an array of four floats)
-
getBaselineShift
public float getBaselineShift()Gets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift). The default value is 0.- Returns:
- the baseline shift
-
setBaselineShift
public void setBaselineShift(float baselineShift) Sets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift).- Parameters:
baselineShift
- the baseline shift
-
setBaselineShift
public void setBaselineShift(int baselineShift) Sets the distance by which the element’s baseline shall be shifted relative to that of its parent element (BaselineShift).- Parameters:
baselineShift
- the baseline shift
-
getLineHeight
Gets the element’s preferred height in the block-progression direction (LineHeight). The default value isLINE_HEIGHT_NORMAL
.- Returns:
- the line height (a Float or a String)
-
setLineHeightNormal
public void setLineHeightNormal()Sets the element’s preferred height in the block-progression direction (LineHeight) toLINE_HEIGHT_NORMAL
. -
setLineHeightAuto
public void setLineHeightAuto()Sets the element’s preferred height in the block-progression direction (LineHeight) toLINE_HEIGHT_AUTO
. -
setLineHeight
public void setLineHeight(float lineHeight) Sets the element’s preferred height in the block-progression direction (LineHeight).- Parameters:
lineHeight
- the line height
-
setLineHeight
public void setLineHeight(int lineHeight) Sets the element’s preferred height in the block-progression direction (LineHeight).- Parameters:
lineHeight
- the line height
-
getTextDecorationColor
Gets the colour to be used for drawing text decorations (TextDecorationColor).- Returns:
- the text decoration colour
-
setTextDecorationColor
Sets the colour to be used for drawing text decorations (TextDecorationColor).- Parameters:
textDecorationColor
- the text decoration colour
-
getTextDecorationThickness
public float getTextDecorationThickness()Gets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).- Returns:
- the text decoration thickness
-
setTextDecorationThickness
public void setTextDecorationThickness(float textDecorationThickness) Sets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).- Parameters:
textDecorationThickness
- the text decoration thickness
-
setTextDecorationThickness
public void setTextDecorationThickness(int textDecorationThickness) Sets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).- Parameters:
textDecorationThickness
- the text decoration thickness
-
getTextDecorationType
Gets the type of text decoration (TextDecorationType). The default value isTEXT_DECORATION_TYPE_NONE
.- Returns:
- the type of text decoration
-
setTextDecorationType
Sets the type of text decoration (TextDecorationType). The value should be one of:- Parameters:
textDecorationType
- the type of text decoration
-
getRubyAlign
Gets the justification of the lines within a ruby assembly (RubyAlign). The default value isRUBY_ALIGN_DISTRIBUTE
.- Returns:
- the ruby alignment
-
setRubyAlign
Sets the justification of the lines within a ruby assembly (RubyAlign). The value should be one of:- Parameters:
rubyAlign
- the ruby alignment
-
getRubyPosition
Gets the placement of the RT structure element relative to the RB element in a ruby assembly (RubyPosition). The default value isRUBY_POSITION_BEFORE
.- Returns:
- the ruby position
-
setRubyPosition
Sets the placement of the RT structure element relative to the RB element in a ruby assembly (RubyPosition). The value should be one of:- Parameters:
rubyPosition
- the ruby position
-
getGlyphOrientationVertical
Gets the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top (GlyphOrientationVertical). The default value isGLYPH_ORIENTATION_VERTICAL_AUTO
.- Returns:
- the vertical glyph orientation
-
setGlyphOrientationVertical
Sets the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top (GlyphOrientationVertical). The value should be one of:GLYPH_ORIENTATION_VERTICAL_AUTO
,GLYPH_ORIENTATION_VERTICAL_MINUS_180_DEGREES
,GLYPH_ORIENTATION_VERTICAL_MINUS_90_DEGREES
,GLYPH_ORIENTATION_VERTICAL_ZERO_DEGREES
,GLYPH_ORIENTATION_VERTICAL_90_DEGREES
,GLYPH_ORIENTATION_VERTICAL_180_DEGREES
,GLYPH_ORIENTATION_VERTICAL_270_DEGREES
,GLYPH_ORIENTATION_VERTICAL_360_DEGREES
.
- Parameters:
glyphOrientationVertical
- the vertical glyph orientation
-
getColumnCount
public int getColumnCount()Gets the number of columns in the content of the grouping element (ColumnCount). The default value is 1.- Returns:
- the column count
-
setColumnCount
public void setColumnCount(int columnCount) Sets the number of columns in the content of the grouping element (ColumnCount).- Parameters:
columnCount
- the column count
-
getColumnGap
Gets the desired space between adjacent columns in the inline-progression direction (ColumnGap).- Returns:
- the column gap (FLoat or array of floats)
-
setColumnGap
public void setColumnGap(float columnGap) Sets the desired space between all columns in the inline-progression direction (ColumnGap).- Parameters:
columnGap
- the column gap
-
setColumnGap
public void setColumnGap(int columnGap) Sets the desired space between all columns in the inline-progression direction (ColumnGap).- Parameters:
columnGap
- the column gap
-
setColumnGaps
public void setColumnGaps(float[] 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.- Parameters:
columnGaps
- the column gaps
-
getColumnWidths
Gets the desired width of the columns, measured in default user space units in the inline-progression direction (ColumnWidths).- Returns:
- the column widths (Float or array of floats)
-
setAllColumnWidths
public void setAllColumnWidths(float columnWidth) Sets the same column width for all columns (ColumnWidths).- Parameters:
columnWidth
- the column width
-
setAllColumnWidths
public void setAllColumnWidths(int columnWidth) Sets the same column width for all columns (ColumnWidths).- Parameters:
columnWidth
- the column width
-
setColumnWidths
public void setColumnWidths(float[] columnWidths) Sets the column widths for the columns separately (ColumnWidths).- Parameters:
columnWidths
- the column widths
-
toString
- Overrides:
toString
in classPDAttributeObject
-