Foxit PDF SDK
com.foxit.sdk.addon.layoutrecognition.LRStructureElement Class Reference
Inheritance diagram for com.foxit.sdk.addon.layoutrecognition.LRStructureElement:
com.foxit.sdk.addon.layoutrecognition.LRElement com.foxit.sdk.common.Base

Public Member Functions

 LRStructureElement ()
 Constructor.
 
 LRStructureElement (LRStructureElement other)
 Constructor, with another structure element object. More...
 
 LRStructureElement (LRElement element)
 Constructor, with parent class object. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
long getAttributeValueARGB (int type, int index) throws com.foxit.sdk.PDFException
 Get an ARGB value (specified by index) for specified attribute type. More...
 
int getAttributeValueCount (int type) throws com.foxit.sdk.PDFException
 Get value count of a specified attribute type. More...
 
LRStructureElement getAttributeValueElement (int type, int index) throws com.foxit.sdk.PDFException
 Get an structure element object (specified by index) for specified attribute type. More...
 
int getAttributeValueEnum (int type, int index) throws com.foxit.sdk.PDFException
 Get an enum value (specified by index) for specified attribute type. More...
 
float getAttributeValueFloat (int type, int index) throws com.foxit.sdk.PDFException
 Get a float value (specified by index) for specified attribute type. More...
 
int getAttributeValueInt32 (int type, int index) throws com.foxit.sdk.PDFException
 Get an integer value (specified by index) for specified attribute type. More...
 
String getAttributeValueString (int type, int index) throws com.foxit.sdk.PDFException
 Get a string value (specified by index) for specified attribute type. More...
 
int getAttributeValueType (int type) throws com.foxit.sdk.PDFException
 Get attribute value type for a specified attribute type. More...
 
RectF getBBox () throws com.foxit.sdk.PDFException
 Get bounding box. More...
 
LRElement getChild (int index) throws com.foxit.sdk.PDFException
 Get a child element by index. More...
 
int getChildCount () throws com.foxit.sdk.PDFException
 Get the count of children elements. More...
 
LRStructureElement getParentElement () throws com.foxit.sdk.PDFException
 Get the parent element. More...
 
int getSupportedAttribute (int index) throws com.foxit.sdk.PDFException
 Get a supported attribute type by index. More...
 
int getSupportedAttributeCount () throws com.foxit.sdk.PDFException
 Get supported attribute count. More...
 
- Public Member Functions inherited from com.foxit.sdk.addon.layoutrecognition.LRElement
 LRElement ()
 Constructor.
 
 LRElement (LRElement other)
 Constructor, with another base element object. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
int getElementType ()
 Get element type. More...
 
boolean isContentElement () throws com.foxit.sdk.PDFException
 Check whether current object is content element or not. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
boolean isGraphicsObjectElement () throws com.foxit.sdk.PDFException
 Check whether current object is graphics object element or not. More...
 
boolean isStructureElement () throws com.foxit.sdk.PDFException
 Check whether current object is structure element or not. More...
 
String stringifyType () throws com.foxit.sdk.PDFException
 Convert type (enum value) of current element to a short and memorable string (text) representation. More...
 
- Public Member Functions inherited from com.foxit.sdk.common.Base
synchronized void delete ()
 Clean up related resources immediately. More...
 

Static Public Member Functions

static boolean isArrayAttributeValueType (int type)
 Check whether input attribute value type represents an array. More...
 
static int parseAttributeType (String type_string)
 Parse a string representation for attribute type and retrieve the enum value for this attribute type. More...
 
static String stringifyAttributeType (int type)
 Convert the enum value of a specified attribute type to a short and memorable string (text) representation. More...
 
static String stringifyEnumVariant (int type)
 Convert the enum value of a specified attribute value enum to a short and memorable string (text) representation. More...
 
- Static Public Member Functions inherited from com.foxit.sdk.addon.layoutrecognition.LRElement
static String stringifyElementType (int type)
 Convert enum value of a specified element type to a short and memorable string (text) representation. More...
 

Static Public Attributes

static final int e_AttributeTypeABox = 0x414c4258
 (Reserved) Attribute type: ABox. More...
 
static final int e_AttributeTypeAttached = 0x41545448
 Attribute type: Attached, which specifies the edges of the page, if any, to which the artifact is logically attached. More...
 
static final int e_AttributeTypeBackgroundColor = 0x424b4743
 Attribute type: BackgroundColor, which represents the color to be used to fill the background of a table cell or any element's content rectangle. More...
 
static final int e_AttributeTypeBaselineShift = 0x42534846
 Attribute type: BaselineShift, which means the distance by which the element's baseline is shifted relative to that of its parent element. More...
 
static final int e_AttributeTypeBBox = 0x42424f58
 Attribute type: BBox, which represents the element's bounding box (the rectangle that completely encloses its visible content). More...
 
static final int e_AttributeTypeBlockAlign = 0x42414c4e
 Attribute type: BlockAlign, which represents the alignment, in the block-progression direction, of content within the table cell. More...
 
static final int e_AttributeTypeBorderColor = 0x42445243
 Attribute type: BorderColor, which represents the color of the border drawn on the edges of a table cell or any element's content rectangle. More...
 
static final int e_AttributeTypeBorderStyle = 0x42445253
 Attribute type: BorderStyle, which represents the style of an element's border. More...
 
static final int e_AttributeTypeBorderThickness = 0x42445254
 Attribute type: BorderThickness, which represents the thickness of the border drawn on the edges of a table cell or any element's content rectangle. More...
 
static final int e_AttributeTypeColor = 0x434f4c52
 Attribute type: Color, which represents the color to be used for drawing text and the default value for the color of table borders and text decorations. More...
 
static final int e_AttributeTypeColSpan = 0x4353504e
 Attribute type only for Table: ColSpan, which represents the number of columns in the enclosing table that are spanned by the cell. More...
 
static final int e_AttributeTypeColumnCount = 0x434c434e
 Attribute type: ColumnCount, which represents the number of columns in the content of the grouping element. More...
 
static final int e_AttributeTypeColumnGap = 0x434c4750
 Attribute type: ColumnGap, which represents the desired space between adjacent columns, measured in the inline- progression direction. More...
 
static final int e_AttributeTypeColumnWidths = 0x434c5744
 Attribute type: ColumnWidths, which represents the desired width of the columns, measured in the inline-progression direction. More...
 
static final int e_AttributeTypeDestination = 0x44455354
 Attribute type: Destination (PDF 2.0), which provides a means to access content. More...
 
static final int e_AttributeTypeDirection = 0x44495245
 (Reserved) Attribute type: Direction. More...
 
static final int e_AttributeTypeEndIndent = 0x45494e44
 Attribute type: EndIndent, which represents the distance from the end edge of the BLSE to that of the reference area. More...
 
static final int e_AttributeTypeFieldChecked = 0x43484b44
 Attribute type only for PrintField: checked, which represents the state of a radio button or check box field. More...
 
static final int e_AttributeTypeFieldDesc = 0x46445343
 Attribute type only for PrintField: Desc, which represents the alternate name of the field, similar to the value supplied in the TU entry of the field dictionary for interactive fields. More...
 
static final int e_AttributeTypeFieldRole = 0x46524f4c
 Attribute type only for PrintField: Role, which represents the type of form field represented by this graphic. More...
 
static final int e_AttributeTypeGlyphOrientationVertical = 0x474f5654
 Attribute type: GlyphOrientationVertical, which specifies the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top. More...
 
static final int e_AttributeTypeHeight = 0x48474854
 Attribute type: Height, which represents the height of the element's content rectangle. More...
 
static final int e_AttributeTypeInlineAlign = 0x49414c4e
 Attribute type: InlineAlign, which represents the alignment, in the inline-progression direction, of content within the table cell. More...
 
static final int e_AttributeTypeInvalid = 0x0
 Attribute type: invalid.
 
static final int e_AttributeTypeLineHeight = 0x4c484754
 Attribute type: LineHeight, which means the element's preferred height, in the block-progression direction. More...
 
static final int e_AttributeTypeListNumbering = 0x4c4e554d
 Attribute type only for List: ListNumbering, which represents the numbering system to be used to generate the content of the Lbl (Label) elements in an autonumbered list, or the symbol used to identify each item in an unnumbered list. More...
 
static final int e_AttributeTypePadding = 0x50414447
 Attribute type: Padding, which specifies an offset to account for the separation between the element's content rectangle and the surrounding border. More...
 
static final int e_AttributeTypePlacement = 0x504c4143
 Attribute type: Placement, which means the positioning of the element with respect to the enclosing reference area and other content. More...
 
static final int e_AttributeTypeRole = 0x524f4c45
 Attribute type: role, which means strings of structure element meaning and standard type it maps to. More...
 
static final int e_AttributeTypeRotation = 0x524f5441
 Attribute type: Rotation. More...
 
static final int e_AttributeTypeRowSpan = 0x5253504e
 Attribute type only for Table: RowSpan, which represents the number of rows in the enclosing table that are spanned by the cell. More...
 
static final int e_AttributeTypeRubyAlign = 0x5242414c
 Attribute type: RubyAlign, which represents the justification of the lines within a ruby assembly. More...
 
static final int e_AttributeTypeRubyPosition = 0x52425053
 Attribute type: RubyPosition, which represents the placement of the RT structure element relative to the RB element in a ruby assembly. More...
 
static final int e_AttributeTypeShort = 0x53484f52
 Attribute type: Short (PDF 2.0), which contains a short form of the content of a TH structure element's content. More...
 
static final int e_AttributeTypeSpaceAfter = 0x53504146
 Attribute type: SpaceAfter, which represents the amount of extra space following the after edge of the BLSE. More...
 
static final int e_AttributeTypeSpaceBefore = 0x53504246
 Attribute type: SpaceBefore, which represents the amount of extra space preceding the before edge of the BLSE. More...
 
static final int e_AttributeTypeStartIndent = 0x53494e44
 Attribute type: StartIndent, which represents the distance from the start edge of the reference area to that of the BLSE. More...
 
static final int e_AttributeTypeSubType = 0x53554254
 Attribute type: Subtype, which means the subtype of annotation or artifact. More...
 
static final int e_AttributeTypeTableHeaders = 0x54484453
 (Currently, unsupported) Attribute type only for Table: Headers, which represents an array of element identifiers. More...
 
static final int e_AttributeTypeTableHeaderScope = 0x54485343
 Attribute type only for Table: Scope, which indicates whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it. More...
 
static final int e_AttributeTypeTableSummary = 0x5442534d
 Attribute type only for Table: Summary, which represents a summary of the table's purpose and structure, for use in non- visual rendering such as speech or braille. More...
 
static final int e_AttributeTypeTBorderStyle = 0x54424453
 Attribute type: TBorderStyle, which represents the style of the border drawn on each edge of a table cell. More...
 
static final int e_AttributeTypeTextAlign = 0x54414c4e
 Attribute type: TextAlign, which represents the alignment of text and other content within lines of the BLSE. More...
 
static final int e_AttributeTypeTextDecorationColor = 0x5444434c
 Attribute type: TextDecorationColor, which represents the color to be used for drawing text decorations. More...
 
static final int e_AttributeTypeTextDecorationThickness = 0x54445448
 Attribute type: TextDecorationThickness, which represents the thickness of each line drawn as part of the text decoration. More...
 
static final int e_AttributeTypeTextDecorationType = 0x54445459
 Attribute type: TextDecorationType, which represents the text decoration, if any, to be applied to the element's text. More...
 
static final int e_AttributeTypeTextIndent = 0x54494e44
 Attribute type: TextIndent, which represents the additional distance from the start edge of the BLSE, as specified by com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeStartIndent , to that of the first line of text. More...
 
static final int e_AttributeTypeTPadding = 0x54504144
 Attribute type: TPadding, which specifies an offset to account for the separation between the table cell's content rectangle and the surrounding border. More...
 
static final int e_AttributeTypeVersion = 0x5645534e
 (Reserved) Attribute type: Version, which represents schema version of layout recognition engine. More...
 
static final int e_AttributeTypeWidth = 0x57445448
 Attribute type: Width, which represents the width of the element's content rectangle. More...
 
static final int e_AttributeTypeWritingMode = 0x574d4f44
 Attribute type: WritingMode, which means the directions of layout progression for packing of ILSEs (inline progression) and stacking of BLSEs (block progression). More...
 
static final int e_AttributeValueEnumAfter = 0x41465445
 Enum value: After, which means the alignment for attribute BlockAlign or the placement for attribute RubyPosition. More...
 
static final int e_AttributeValueEnumAuto = 0x4155544f
 Enum value: Auto. More...
 
static final int e_AttributeValueEnumBackground = 0x424b474e
 Enum value: Background, which means background artifacts. Background artifacts typically serve as a background for content shown either on top of or placed adjacent to that background. More...
 
static final int e_AttributeValueEnumBates = 0x42415445
 Enum value: Bates (PDF2.0).
 
static final int e_AttributeValueEnumBefore = 0x42454652
 Enum value: Before, which means the placement for attributes Placement/RubyPosition or alignment for attribute BlockAlign. More...
 
static final int e_AttributeValueEnumBlock = 0x424c434b
 Enum value: Block, which means to be stacked in the block-progression direction within an enclosing reference area or parent BLSE. More...
 
static final int e_AttributeValueEnumBoth = 0x424f5448
 Enum value: Row, which means both row and column of a table. More...
 
static final int e_AttributeValueEnumBottom = 0x42544f4d
 Enum value: Bottom, which means bottom edge of the page. More...
 
static final int e_AttributeValueEnumCB = 0x43420000
 Enum value: cb, which means check box. More...
 
static final int e_AttributeValueEnumCenter = 0x434e5452
 Enum value: Center, which means the alignment for attributes TextAlign/InlineAlign/RubyAlign. More...
 
static final int e_AttributeValueEnumCircle = 0x4352434c
 Enum value: Circle, which means open circular bullet. More...
 
static final int e_AttributeValueEnumColumn = 0x434c4d4e
 Enum value: Row, which means column of a table. More...
 
static final int e_AttributeValueEnumDashed = 0x44534844
 Enum value: Dashed, which means the border is a series of short line segments. More...
 
static final int e_AttributeValueEnumDecimal = 0x44434d4c
 Enum value: Decimal, which means decimal arabic numerals (1-9, 10-99, ...). More...
 
static final int e_AttributeValueEnumDisc = 0x44495343
 Enum value: Disc, which means solid circular bullet. More...
 
static final int e_AttributeValueEnumDistribute = 0x44535442
 Enum value: Distribute, which means the content is to be expanded to fill the available width in the inline-progression direction. More...
 
static final int e_AttributeValueEnumDotted = 0x444f5444
 Enum value: Dotten, which means the border is a series of dots. More...
 
static final int e_AttributeValueEnumDouble = 0x44424c45
 Enum value: Double, which means the border is two solid lines. More...
 
static final int e_AttributeValueEnumEnd = 0x454e4400
 Enum value: End, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign. More...
 
static final int e_AttributeValueEnumFloat = 0x464c4f54
 Enum value: float.
 
static final int e_AttributeValueEnumFooter = 0x464f4f54
 Enum value: Footer.
 
static final int e_AttributeValueEnumGroove = 0x41525459
 Enum value: Groove, which means the border looks as though it were carved into the canvas. More...
 
static final int e_AttributeValueEnumHeader = 0x48454144
 Enum value: Header.
 
static final int e_AttributeValueEnumHidden = 0x4849444e
 Enum value: Hidden, which is same as None except in terms of border conflict resolution for table elements. More...
 
static final int e_AttributeValueEnumInline = 0x494e4c4e
 Enum value: Inline, which means the placement for attributes Placement/RubyPosition. More...
 
static final int e_AttributeValueEnumInset = 0x494e5354
 Enum value: Inset, which means the border makes the entire box look as though it were embedded in the canvas. More...
 
static final int e_AttributeValueEnumInvalid = 0x0
 Invalid enum value.
 
static final int e_AttributeValueEnumJustify = 0x4a535459
 Enum value: Justify, which means the alignment for attributes TextAlign/BlockAlign/RubyAlign. More...
 
static final int e_AttributeValueEnumLayout = 0x4c41594f
 Enum value: Layout, which means layout artifacts. Purely cosmetic typographical or design elements such as footnote rules or background screens. More...
 
static final int e_AttributeValueEnumLeft = 0x4c454654
 Enum value: Left, which means left edge of the page. More...
 
static final int e_AttributeValueEnumLineThrough = 0x4c4e5448
 Enum value: LineThrough, which means a line through the middle of the text. More...
 
static final int e_AttributeValueEnumLowerAlpha = 0x4c57414c
 Enum value: LowerAlpha, which means lowercase letters (a, b, c, ...). More...
 
static final int e_AttributeValueEnumLowerRoman = 0x4c57524d
 Enum value: LowerRoman, which means lowercase roman numerals (i, ii, iii, iv, ...). More...
 
static final int e_AttributeValueEnumLrTb = 0x4c525442
 Enum value: LtTb, which means inline progression from left to right; block progression from top to bottom. More...
 
static final int e_AttributeValueEnumMiddle = 0x4d49444c
 Enum value: Middle, which means children are centered within the table cell. More...
 
static final int e_AttributeValueEnumNeutral = 0x4e555452
 Enum value: neutral, which means the state is neutral. More...
 
static final int e_AttributeValueEnumNone = 0x4e4f4e45
 Enum value: None, which means no such attribute. More...
 
static final int e_AttributeValueEnumNormal = 0x4e524d4c
 Enum value: Normal, which means to adjust the line height to include any nonzero value specified for attribute BaselineShift . More...
 
static final int e_AttributeValueEnumOff = 0x4f464600
 Enum value: off, which means the state is off. More...
 
static final int e_AttributeValueEnumOn = 0x4f4e0000
 Enum value: on, which means the state is on. More...
 
static final int e_AttributeValueEnumOrdered = 0x4f524445
 Enum value: Ordered (PDF 2.0), which means ordered lists with unspecified numbering. More...
 
static final int e_AttributeValueEnumOther = 0x4f544845
 Enum value: Other (PDF 2.0). More...
 
static final int e_AttributeValueEnumOutset = 0x4f545354
 Enum value: Outset, which means the border makes the entire box look as though it were coming out of the canvas (the opposite of Inset). More...
 
static final int e_AttributeValueEnumOverline = 0x4f564c4e
 Enum value: Overline, which means a line above the text. More...
 
static final int e_AttributeValueEnumPage = 0x50414745
 Enum value: Page, which means page artifacts. Production aids extraneous to the document itself, such as cut marks and color bars. More...
 
static final int e_AttributeValueEnumPageNum = 0x504e554d
 Enum value: PageNum (PDF2.0).
 
static final int e_AttributeValueEnumPagination = 0x5041474e
 Enum value: Pagination, which means pagination artifacts. Ancillary page features such as running heads and folios (page numbers). More...
 
static final int e_AttributeValueEnumPB = 0x50440000
 Enum value: pb, which means push button. More...
 
static final int e_AttributeValueEnumRB = 0x52420000
 Enum value: rb, which means radio button. More...
 
static final int e_AttributeValueEnumRidge = 0x52444745
 Enum value: Ridge, which means the border looks as though it were coming out of the canvas (the opposite of Groove). More...
 
static final int e_AttributeValueEnumRight = 0x52474854
 Enum value: Right, which means right edge of the page. More...
 
static final int e_AttributeValueEnumRlTb = 0x524c5442
 Enum value: RlTb, which means inline progression from right to left; block progression from top to bottom. More...
 
static final int e_AttributeValueEnumRow = 0x524f5700
 Enum value: Row, which means row of a table. More...
 
static final int e_AttributeValueEnumSolid = 0x534f4c44
 Enum value: Solid, which means the border is a single line segment. More...
 
static final int e_AttributeValueEnumSquare = 0x53515552
 Enum value: Square, which means solid square bullet. More...
 
static final int e_AttributeValueEnumStart = 0x53545254
 Enum value: Start, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign. More...
 
static final int e_AttributeValueEnumTbLr = 0x54424c52
 Enum value: TbLr (PDF 2.0), which means inline progression from top to bottom; block progression from left to right. More...
 
static final int e_AttributeValueEnumTbRl = 0x5442524c
 Enum value: TbRl, which means inline progression from top to bottom; block progression from right to left. More...
 
static final int e_AttributeValueEnumTop = 0x544f5000
 Enum value: Top, which means top edge of the page. More...
 
static final int e_AttributeValueEnumTV = 0x54560000
 Enum value: tv, which means text-value field. More...
 
static final int e_AttributeValueEnumUnderline = 0x55444c4e
 Enum value: Underline, which means a line below the text. More...
 
static final int e_AttributeValueEnumUnordered = 0x554e4f52
 Enum value: Unordered (PDF 2.0), which means unordered list with unspecified bullets. More...
 
static final int e_AttributeValueEnumUpperAlpha = 0x5550414c
 Enum value: UpperAlpha, which means uppercase letters (A, B, C, ...). More...
 
static final int e_AttributeValueEnumUpperRoman = 0x5550524d
 Enum value: UpperRoman, which means uppercase roman numerals (I, II, III, IV, ...). More...
 
static final int e_AttributeValueEnumWarichu = 0x57415249
 Enum value: Warichu, which means the RT and associated RP elements are to be formatted as a warichu, following the RB element. More...
 
static final int e_AttributeValueEnumWatermark = 0x57544d4b
 Enum value: Watermark.
 
static final int e_AttributeValueTypeARGB = 0x4
 Value type: ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24).
 
static final int e_AttributeValueTypeARGBArray = 0x104
 Value type: an array of ARGB values.
 
static final int e_AttributeValueTypeElement = 0x6
 Value type: element.
 
static final int e_AttributeValueTypeElementArray = 0x106
 Value type: an array of elements.
 
static final int e_AttributeValueTypeEmpty = 0x0
 Empty value type.
 
static final int e_AttributeValueTypeEnum = 0x1
 Value type: enum.
 
static final int e_AttributeValueTypeEnumArray = 0x101
 Value type: an array of enum values.
 
static final int e_AttributeValueTypeFloat = 0x3
 Value type: float.
 
static final int e_AttributeValueTypeFloatArray = 0x103
 Value type: an array of float values.
 
static final int e_AttributeValueTypeInt32 = 0x2
 Value type: 32-bit signed integer.
 
static final int e_AttributeValueTypeInt32Array = 0x102
 Value type: an array of integer values.
 
static final int e_AttributeValueTypeWStr = 0x5
 Value type: wide string.
 
static final int e_AttributeValueTypeWStrArray = 0x105
 Value type: an array of wide strings.
 
- Static Public Attributes inherited from com.foxit.sdk.addon.layoutrecognition.LRElement
static final int e_ElementTypeAnnot = 0x0307
 Structure element type: Annot, which means "Annotation" and represents an association between a portion of the ILSE's content and a corresponding PDF annotation.
 
static final int e_ElementTypeAnnotContent = 0xC000000E
 Structure element type: AnnotContent, which means annotation content element.
 
static final int e_ElementTypeAnnotObject = 0x8000000E
 Structure element type: AnnotObject, which means annotation object element.
 
static final int e_ElementTypeArt = 0x0101
 Structure element type: Art, which means "Article" and represents a relatively self-contained body of text constituting a single narrative or exposition.
 
static final int e_ElementTypeArtifact = 0x1000
 Structure element type: Artifact, which includes other Pagination, Layout, Page and Background artifacts.
 
static final int e_ElementTypeAside = 0x0108
 Structure element type: Aside (PDF 2.0), which represents content that is distinct from other content within its parent structure element.
 
static final int e_ElementTypeBibEntry = 0x0304
 Structure element type: BibEntry, which means "Bibliography entry" and represents a reference identifying the external source of some cited content.
 
static final int e_ElementTypeBlockQuote = 0x0103
 Structure element type: BlockQuote, which means "Block quotation" and represents a portion of text consisting of one or more paragraphs attributed to someone other than the author of the surrounding text.
 
static final int e_ElementTypeCaption = 0x0104
 Structure element type: Caption, which represents a brief portion of text describing a table or figure.
 
static final int e_ElementTypeCode = 0x0305
 Structure element type: Code, which represents a fragment of computer program text.
 
static final int e_ElementTypeComplexContent = 0xC000000D
 Structure element type: ComplexContent, which means complex content element.
 
static final int e_ElementTypeContainerObject = 0x8000000C
 Structure element type: ContainerObject, which means container object element.
 
static final int e_ElementTypeDiv = 0x0100
 Structure element type: Div, which means "Division" and represents a generic block-level element or group of elements.
 
static final int e_ElementTypeDocument = 0x0000
 Structure element type: Document, which represents a complete document.
 
static final int e_ElementTypeDocumentFragment = 0x0001
 Structure element type: DocumentFragment (PDF 2.0), which represents a part of an original complete document.
 
static final int e_ElementTypeEm = 0x030F
 Structure element type: Em (PDF 2.0), which means "Emphasis" and represents content for the purpose of emphasis.
 
static final int e_ElementTypeFENote = 0x010A
 Structure element type: FENote (PDF 2.0), which is used to markup footnotes and endnotes.
 
static final int e_ElementTypeFigure = 0x0400
 Structure element type: Figure, which represents an item of graphical content.
 
static final int e_ElementTypeForm = 0x0402
 Structure element type: Form, which represents a widget annotation representing an interactive form field.
 
static final int e_ElementTypeFormObject = 0x80000005
 Structure element type: FormObject, which means form XObject graphics object element.
 
static final int e_ElementTypeFormula = 0x0401
 Structure element type: Formula, which represents a mathematical formula.
 
static final int e_ElementTypeHeading = 0x0201
 Structure element type: H, which means "Heading" and represents a label for a subdivision of a document's content. It should be the first child of the division that it heads.
 
static final int e_ElementTypeHeading1 = 0x0202
 Structure element type: H1, which represents heading with level 1.
 
static final int e_ElementTypeHeading2 = 0x0203
 Structure element type: H2, which represents heading with level 2.
 
static final int e_ElementTypeHeading3 = 0x0204
 Structure element type: H3, which represents heading with level 3.
 
static final int e_ElementTypeHeading4 = 0x0205
 Structure element type: H4, which represents heading with level 4.
 
static final int e_ElementTypeHeading5 = 0x0206
 Structure element type: H5, which represents heading with level 5.
 
static final int e_ElementTypeHeading6 = 0x0207
 Structure element type: H6, which represents heading with level 6.
 
static final int e_ElementTypeHeadingN = 0x0208
 Structure element type: Hn (PDF 2.0), which represents heading with level 7 or more.
 
static final int e_ElementTypeImageContent = 0xC0000003
 Structure element type: ImageContent, which means image content element.
 
static final int e_ElementTypeImageObject = 0x80000003
 Structure element type: ImageObject, which means image graphics object element.
 
static final int e_ElementTypeIndex = 0x0107
 Structure element type: Index, which represents a sequence of entries containing identifying text accompanied by reference elements that point out occurrences of the specified text in the main body of a document.
 
static final int e_ElementTypeLink = 0x0306
 Structure element type: Link, which represents an association between a portion of the ILSE's content and a corresponding link annotation or annotations.
 
static final int e_ElementTypeList = 0x0209
 Structure element type: L, which means "List" and represents a sequence of items of like meaning and importance.
 
static final int e_ElementTypeListBody = 0x020C
 Structure element type: LBody, which means "List body" and reprsents the descriptive content of a list item.
 
static final int e_ElementTypeListItem = 0x020A
 Structure element type: LI, which means "List item" and represents an individual member of a list.
 
static final int e_ElementTypeListLabel = 0x020B
 Structure element type: Lbl, which means "Label" and represents a name or number that distinguishes a given item from others in the same list or other group of like items.
 
static final int e_ElementTypeNonStruct = 0x010F
 Structure element type: NonStruct, which means "Nonstructural element" and represents a grouping element having no inherent structural significance; it serves solely for grouping purposes.
 
static final int e_ElementTypeNote = 0x0302
 Structure element type: Note, which represents an item of explanatory text, such as a footnote or an endnote, that is referred to from within the body of the document.
 
static final int e_ElementTypePageObject = 0x8000000F
 Structure element type: PageObject, which means page object element.
 
static final int e_ElementTypeParagraph = 0x0200
 Structure element type: P, which means "Paragraph" and represents a low-level division of text.
 
static final int e_ElementTypePart = 0x0002
 Structure element type: Part, which represents a large-scale division of a document.
 
static final int e_ElementTypePathContent = 0xC0000002
 Structure element type: PathContent, which means path content element.
 
static final int e_ElementTypePathObject = 0x80000002
 Structure element type: PathObject, which means path graphics object element.
 
static final int e_ElementTypePrivate = 0x0110
 Structure element type: Private, which means "Private element" and represents a grouping element containing private content belonging to the application producing it.
 
static final int e_ElementTypeQuote = 0x0301
 Structure element type: Quote, which means "Quotation" and represents an inline portion of text attributed to someone other than the author of the surrounding text.
 
static final int e_ElementTypeReference = 0x0303
 Structure element type: Reference, which represents a citation to content elsewhere in the document.
 
static final int e_ElementTypeRuby = 0x0308
 Structure element type: Ruby, which represents the wrapper around the entire ruby assembly.
 
static final int e_ElementTypeRubyAnnot = 0x030A
 Structure element type: RT, which means "Ruby annotation text" and represents the smaller-size text that is placed adjacent to the ruby base text.
 
static final int e_ElementTypeRubyBase = 0x0309
 Structure element type: RB, which means "Ruby base text" and represents the full-size text to which the ruby annotation is applied.
 
static final int e_ElementTypeRubyPunc = 0x030B
 Structure element type: RP, which means "Ruby punctuation" and represents punctuation surrounding the ruby annotation text.
 
static final int e_ElementTypeSect = 0x0102
 Structure element type: Sect, which means "Section" and represents a container for grouping related content elements.
 
static final int e_ElementTypeShadingContent = 0xC0000004
 Structure element type: ShadingContent, which means shading content element.
 
static final int e_ElementTypeShadingObject = 0x80000004
 Structure element type: ShadingObject, which means shading graphics object element.
 
static final int e_ElementTypeSpan = 0x0300
 Structure element type: Span, which represents a generic inline portion of text having no particular inherent characteristics.
 
static final int e_ElementTypeStrong = 0x0310
 Structure element type: Strong (PDF 2.0), which represents content for the purpose of strong importance, seriousness or urgency for its contents.
 
static final int e_ElementTypeSub = 0x0311
 Structure element type: Sub (PDF 2.0), which means "Sub-division of a block level element" and represents content typically perceived as a sub-division inside a block level structure element.
 
static final int e_ElementTypeTable = 0x020D
 Structure element type: Table, which represents a two-dimensional layout of rectangular data cells, possibly having a complex substructure.
 
static final int e_ElementTypeTableBodyGroup = 0x0212
 Structure element type: TBody, which means "Table body row group" and represents a group of rows that constitute the main body portion of a table.
 
static final int e_ElementTypeTableDataCell = 0x0210
 Structure element type: TD, which means "Table data cell" and represents a table cell containing data that is part of the table's content.
 
static final int e_ElementTypeTableFootGroup = 0x0213
 Structure element type: TFoot, which means "Table footer row group" and represents a group of rows that constitute the footer of a table.
 
static final int e_ElementTypeTableHeaderCell = 0x020F
 Structure element type: TH, which means "Table header cell" and represents a table cell containing header text describing one or more rows or columns of the table.
 
static final int e_ElementTypeTableHeaderGroup = 0x0211
 Structure element type: THead, which means "Table header row group" and represents a group of rows that constitute the header of a table.
 
static final int e_ElementTypeTableRow = 0x020E
 Structure element type: TR, which means "Table row" and represents a row of headings or data in a table.
 
static final int e_ElementTypeTextContent = 0xC0000001
 Structure element type: TextContent, which means text content element.
 
static final int e_ElementTypeTextObject = 0x80000001
 Structure element type: TextObject, which means text graphics object element.
 
static final int e_ElementTypeTitle = 0x0109
 Structure element type: Title (PDF 2.0), which represents content that is usually referred to as the title of a document or high-level devision of content.
 
static final int e_ElementTypeTOC = 0x0105
 Structure element type: TOC, which means "Table of contents" and represents a list made up of table of contents item entries and/or other nested table of contents entries.
 
static final int e_ElementTypeTOCI = 0x0106
 Structure element type: TOCI, which means "Table of contents item" and represents an individual member of a table of contents.
 
static final int e_ElementTypeWarichu = 0x030C
 Structure element type: Warichu, which represents the wrapper around the entire warichu assembly.
 
static final int e_ElementTypeWarichuPunc = 0x030E
 Structure element type: WP, which means "Warichu punctuation" and represents the punctuation that surrounds the WT text.
 
static final int e_ElementTypeWarichuText = 0x030D
 Structure element type: WT, which means "Warichu text" and represents the smaller-size text of a warichu comment that is formatted into two lines and placed between surrounding WP elements.
 

Detailed Description

This class represents a structure element. A structure element can be used to construct a tree, like graphics structure element, paragraph structure element, span structure element and so on.

Constructor & Destructor Documentation

◆ LRStructureElement() [1/2]

com.foxit.sdk.addon.layoutrecognition.LRStructureElement.LRStructureElement ( LRStructureElement  other)

Constructor, with another structure element object.

Parameters
[in]otherAnother structure element object.

◆ LRStructureElement() [2/2]

com.foxit.sdk.addon.layoutrecognition.LRStructureElement.LRStructureElement ( LRElement  element)

Constructor, with parent class object.

Parameters
[in]elementParent class object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.addon.layoutrecognition.LRStructureElement.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ getAttributeValueARGB()

long com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getAttributeValueARGB ( int  type,
int  index 
) throws com.foxit.sdk.PDFException

Get an ARGB value (specified by index) for specified attribute type.

This function is available for attributes whose value type is com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeARGB or com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeARGBArray . For other value type, this function will return 0.

Parameters
[in]typeAttribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole and this should be one of these values.
[in]indexIndex to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.getAttributeValueCount .
Returns
ARGB value.

◆ getAttributeValueCount()

int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getAttributeValueCount ( int  type) throws com.foxit.sdk.PDFException

Get value count of a specified attribute type.

  • When the value type of an attribute type represents an array, this function returns the size of the array.

  • When the value type of an attribute type does not represent an array, this function will alway return 1.

Parameters
[in]typeAttribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole and this should be one of these values.
Returns
Value count of a specified attribute type.

◆ getAttributeValueElement()

LRStructureElement com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getAttributeValueElement ( int  type,
int  index 
) throws com.foxit.sdk.PDFException

Get an structure element object (specified by index) for specified attribute type.

This function is available for attributes whose value type is com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeElement or com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeElementArray . For other value type, this function will return a structure element whose function LRStructureElement::IsEmpty returns true.

Parameters
[in]typeAttribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole and this should be one of these values.
[in]indexIndex to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.getAttributeValueCount .
Returns
A structure element.

◆ getAttributeValueEnum()

int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getAttributeValueEnum ( int  type,
int  index 
) throws com.foxit.sdk.PDFException

Get an enum value (specified by index) for specified attribute type.

This function is available for attributes whose value type is com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeEnum or com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeEnumArray . For other value type, this function will return com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumInvalid .

Parameters
[in]typeAttribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole and this should be one of these values.
[in]indexIndex to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.getAttributeValueCount .
Returns
An enum value. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumInvalid and this would be one of these values.

◆ getAttributeValueFloat()

float com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getAttributeValueFloat ( int  type,
int  index 
) throws com.foxit.sdk.PDFException

Get a float value (specified by index) for specified attribute type.

This function is available for attributes whose value type is com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeFloat or com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeFloatArray . For other value type, this function will return 0.0.

Parameters
[in]typeAttribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole and this should be one of these values.
[in]indexIndex to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.getAttributeValueCount .
Returns
Float value.

◆ getAttributeValueInt32()

int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getAttributeValueInt32 ( int  type,
int  index 
) throws com.foxit.sdk.PDFException

Get an integer value (specified by index) for specified attribute type.

This function is available for attributes whose value type is com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeInt32 or com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeInt32Array . For other value type, this function will return 0.

Parameters
[in]typeAttribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole and this should be one of these values.
[in]indexIndex to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.getAttributeValueCount .
Returns
Integer value.

◆ getAttributeValueString()

String com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getAttributeValueString ( int  type,
int  index 
) throws com.foxit.sdk.PDFException

Get a string value (specified by index) for specified attribute type.

This function is available for attributes whose value type is com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeWStr or com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeWStrArray . For other value type, this function will return an empty string.

Parameters
[in]typeAttribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole and this should be one of these values.
[in]indexIndex to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.getAttributeValueCount .
Returns
Wide string value.

◆ getAttributeValueType()

int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getAttributeValueType ( int  type) throws com.foxit.sdk.PDFException

Get attribute value type for a specified attribute type.

Parameters
[in]typeAttribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole and this should be one of these values.
Returns
Value type for the specified attribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeEmpty and this would be one of these values.

◆ getBBox()

RectF com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getBBox ( ) throws com.foxit.sdk.PDFException

Get bounding box.

Returns
Bounding box.

◆ getChild()

LRElement com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getChild ( int  index) throws com.foxit.sdk.PDFException

Get a child element by index.

Parameters
[in]indexIndex of a child element to be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.getChildCount .
Returns
A child element.

◆ getChildCount()

int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getChildCount ( ) throws com.foxit.sdk.PDFException

Get the count of children elements.

Returns
Count of children elements.

◆ getParentElement()

LRStructureElement com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getParentElement ( ) throws com.foxit.sdk.PDFException

Get the parent element.

Returns
Parent element. If function LRStructureElement::IsEmpty for the returned object returns true, that means current element does not have a parent element.

◆ getSupportedAttribute()

int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getSupportedAttribute ( int  index) throws com.foxit.sdk.PDFException

Get a supported attribute type by index.

Parameters
[in]indexIndex for a supported attribute whose type is to be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.getSupportedAttributeCount .
Returns
Attribute type of the attribute specified by index.

◆ getSupportedAttributeCount()

int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.getSupportedAttributeCount ( ) throws com.foxit.sdk.PDFException

Get supported attribute count.

Returns
Count of supported attribute.

◆ isArrayAttributeValueType()

static boolean com.foxit.sdk.addon.layoutrecognition.LRStructureElement.isArrayAttributeValueType ( int  type)
static

Check whether input attribute value type represents an array.

Parameters
[in]typeAttribute value type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueTypeEmpty and this should be one of these values.
Returns
true means input type represents an array, while false means input type does not represent an array.

◆ parseAttributeType()

static int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.parseAttributeType ( String  type_string)
static

Parse a string representation for attribute type and retrieve the enum value for this attribute type.

Parameters
[in]type_stringA string representation for a structure element attribute type.
Returns
Enum value for attribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeInvalid and this would be one of these values.

◆ stringifyAttributeType()

static String com.foxit.sdk.addon.layoutrecognition.LRStructureElement.stringifyAttributeType ( int  type)
static

Convert the enum value of a specified attribute type to a short and memorable string (text) representation.

Parameters
[in]typeEnum value of a specified attribute type. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeInvalid and this should be one of these values.
Returns
A string that represents the short and memorable string representation for specified type. If there is no short and memorable string representation, or input type is com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeInvalid or an invalid enum value, this function would return an empty string.

◆ stringifyEnumVariant()

static String com.foxit.sdk.addon.layoutrecognition.LRStructureElement.stringifyEnumVariant ( int  type)
static

Convert the enum value of a specified attribute value enum to a short and memorable string (text) representation.

Parameters
[in]typeEnum value of a specified attribute value enum. Please refer to values starting from com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumInvalid and this should be one of these values.
Returns
A string that represents the short and memorable string representation for specified enum. If there is no short and memorable string representation, or input enum value is com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumInvalid or an invalid enum value, this function would return an empty string.

Member Data Documentation

◆ e_AttributeTypeABox

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeABox = 0x414c4258
static

(Reserved) Attribute type: ABox.

Note
Value type for this attribute type is an array of four numbers.

◆ e_AttributeTypeAttached

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeAttached = 0x41545448
static

◆ e_AttributeTypeBackgroundColor

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBackgroundColor = 0x424b4743
static

Attribute type: BackgroundColor, which represents the color to be used to fill the background of a table cell or any element's content rectangle.

Note
Value type for this attribute type is RGB color.

◆ e_AttributeTypeBaselineShift

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBaselineShift = 0x42534846
static

Attribute type: BaselineShift, which means the distance by which the element's baseline is shifted relative to that of its parent element.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeBBox

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBBox = 0x42424f58
static

Attribute type: BBox, which represents the element's bounding box (the rectangle that completely encloses its visible content).

Note
Value type for this attribute type is an array of four numbers in [PDF coordinate system] (com.foxit.sdk.pdf.PDFPage) giving the coordinates of the left, bottom, right, and top edges of the elements's bounding box.

◆ e_AttributeTypeBlockAlign

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBlockAlign = 0x42414c4e
static

◆ e_AttributeTypeBorderColor

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderColor = 0x42445243
static

Attribute type: BorderColor, which represents the color of the border drawn on the edges of a table cell or any element's content rectangle.

Note
Value type for this attribute type is RGB color or an array of RGB color values.

◆ e_AttributeTypeBorderStyle

◆ e_AttributeTypeBorderThickness

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderThickness = 0x42445254
static

Attribute type: BorderThickness, which represents the thickness of the border drawn on the edges of a table cell or any element's content rectangle.

Note
Value type for this attribute type is number (for all four edges) or an array of four numbers (for one edge of the border, in the order of the before, after, start, and end edge).

◆ e_AttributeTypeColor

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeColor = 0x434f4c52
static

Attribute type: Color, which represents the color to be used for drawing text and the default value for the color of table borders and text decorations.

Note
Value type for this attribute type is RGB color.

◆ e_AttributeTypeColSpan

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeColSpan = 0x4353504e
static

Attribute type only for Table: ColSpan, which represents the number of columns in the enclosing table that are spanned by the cell.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeColumnCount

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeColumnCount = 0x434c434e
static

Attribute type: ColumnCount, which represents the number of columns in the content of the grouping element.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeColumnGap

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeColumnGap = 0x434c4750
static

Attribute type: ColumnGap, which represents the desired space between adjacent columns, measured in the inline- progression direction.

Note
Value type for this attribute type can be number (for all columns) or an array of numbers. When the value type is array:
  • if the array contains (ColumnCount-1) numbers, these numbers represent the space between the first and second columns, the second and third columns, and so on, respectively.

  • if there are fewer than (ColumnCount-1) numbers, the last element specifies all remaining spaces; excess array elements are ignored.

◆ e_AttributeTypeColumnWidths

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeColumnWidths = 0x434c5744
static

Attribute type: ColumnWidths, which represents the desired width of the columns, measured in the inline-progression direction.

Note
Value type for this attribute type can be number (for all columns) or an array of numbers. When the value type is array:
  • if the array contains ColumnCount numbers, these numbers represent the width of each column, in order.

  • if there are fewer than ColumnCount numbers, the last element specifies all remaining widths; excess array elements are ignored.

◆ e_AttributeTypeDestination

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeDestination = 0x44455354
static

Attribute type: Destination (PDF 2.0), which provides a means to access content.

Note
Value type for this attribute type is an array of zero or stirngs with ID.

◆ e_AttributeTypeDirection

◆ e_AttributeTypeEndIndent

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeEndIndent = 0x45494e44
static

Attribute type: EndIndent, which represents the distance from the end edge of the BLSE to that of the reference area.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeFieldChecked

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldChecked = 0x43484b44
static

Attribute type only for PrintField: checked, which represents the state of a radio button or check box field.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ e_AttributeTypeFieldDesc

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldDesc = 0x46445343
static

Attribute type only for PrintField: Desc, which represents the alternate name of the field, similar to the value supplied in the TU entry of the field dictionary for interactive fields.

Note
Value type for this attribute type is string.

◆ e_AttributeTypeFieldRole

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldRole = 0x46524f4c
static

◆ e_AttributeTypeGlyphOrientationVertical

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeGlyphOrientationVertical = 0x474f5654
static

Attribute type: GlyphOrientationVertical, which specifies the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top.

Note
Value type for this attribute type is number (which should be one of specified numbers -90, 0, 90, 180, and 270) or enum (which should be value com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumAuto ).

◆ e_AttributeTypeHeight

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeHeight = 0x48474854
static

Attribute type: Height, which represents the height of the element's content rectangle.

Note
Value type for this attribute type is number or enum value com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumAuto .

◆ e_AttributeTypeInlineAlign

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeInlineAlign = 0x49414c4e
static

Attribute type: InlineAlign, which represents the alignment, in the inline-progression direction, of content within the table cell.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ e_AttributeTypeLineHeight

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeLineHeight = 0x4c484754
static

Attribute type: LineHeight, which means the element's preferred height, in the block-progression direction.

Note
Value type for this attribute type can be number or enum. Valid enum values are:

◆ e_AttributeTypeListNumbering

◆ e_AttributeTypePadding

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypePadding = 0x50414447
static

Attribute type: Padding, which specifies an offset to account for the separation between the element's content rectangle and the surrounding border.

Note
Value type for this attribute type is number (for all four sides) or an array of four numbers (for the before, after, start, and end edge).

◆ e_AttributeTypePlacement

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypePlacement = 0x504c4143
static

◆ e_AttributeTypeRole

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRole = 0x524f4c45
static

Attribute type: role, which means strings of structure element meaning and standard type it maps to.

Note
Value type for this attribute type is string.

◆ e_AttributeTypeRotation

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRotation = 0x524f5441
static

Attribute type: Rotation.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeRowSpan

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRowSpan = 0x5253504e
static

Attribute type only for Table: RowSpan, which represents the number of rows in the enclosing table that are spanned by the cell.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeRubyAlign

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyAlign = 0x5242414c
static

◆ e_AttributeTypeRubyPosition

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyPosition = 0x52425053
static

◆ e_AttributeTypeShort

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeShort = 0x53484f52
static

Attribute type: Short (PDF 2.0), which contains a short form of the content of a TH structure element's content.

Note
Value type for this attribute type is string.

◆ e_AttributeTypeSpaceAfter

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeSpaceAfter = 0x53504146
static

Attribute type: SpaceAfter, which represents the amount of extra space following the after edge of the BLSE.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeSpaceBefore

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeSpaceBefore = 0x53504246
static

Attribute type: SpaceBefore, which represents the amount of extra space preceding the before edge of the BLSE.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeStartIndent

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeStartIndent = 0x53494e44
static

Attribute type: StartIndent, which represents the distance from the start edge of the reference area to that of the BLSE.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeSubType

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeSubType = 0x53554254
static

◆ e_AttributeTypeTableHeaders

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTableHeaders = 0x54484453
static

(Currently, unsupported) Attribute type only for Table: Headers, which represents an array of element identifiers.

Note
Value type for this attribute type is an array of strings.

◆ e_AttributeTypeTableHeaderScope

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTableHeaderScope = 0x54485343
static

Attribute type only for Table: Scope, which indicates whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it.

Note
Value type for this attribute type is enum. Valid enum values are:

◆ e_AttributeTypeTableSummary

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTableSummary = 0x5442534d
static

Attribute type only for Table: Summary, which represents a summary of the table's purpose and structure, for use in non- visual rendering such as speech or braille.

Note
Value type for this attribute type is string.

◆ e_AttributeTypeTBorderStyle

◆ e_AttributeTypeTextAlign

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextAlign = 0x54414c4e
static

◆ e_AttributeTypeTextDecorationColor

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextDecorationColor = 0x5444434c
static

Attribute type: TextDecorationColor, which represents the color to be used for drawing text decorations.

Note
Value type for this attribute type is RGB color.

◆ e_AttributeTypeTextDecorationThickness

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextDecorationThickness = 0x54445448
static

Attribute type: TextDecorationThickness, which represents the thickness of each line drawn as part of the text decoration.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeTextDecorationType

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextDecorationType = 0x54445459
static

◆ e_AttributeTypeTextIndent

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextIndent = 0x54494e44
static

Attribute type: TextIndent, which represents the additional distance from the start edge of the BLSE, as specified by com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeStartIndent , to that of the first line of text.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeTPadding

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTPadding = 0x54504144
static

Attribute type: TPadding, which specifies an offset to account for the separation between the table cell's content rectangle and the surrounding border.

Note
Value type for this attribute type is number (for all four edges of the table cell) or an array of four numbers (for the before edge, after edge, start edge, and end edge of the content rectangle).

◆ e_AttributeTypeVersion

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeVersion = 0x5645534e
static

(Reserved) Attribute type: Version, which represents schema version of layout recognition engine.

Note
Value type for this attribute type is number.

◆ e_AttributeTypeWidth

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeWidth = 0x57445448
static

Attribute type: Width, which represents the width of the element's content rectangle.

Note
Value type for this attribute type is number or enum value com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumAuto .

◆ e_AttributeTypeWritingMode

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeWritingMode = 0x574d4f44
static

Attribute type: WritingMode, which means the directions of layout progression for packing of ILSEs (inline progression) and stacking of BLSEs (block progression).

Note
Value type for this attribute type is enum. Valid enum values are:

◆ e_AttributeValueEnumAfter

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumAfter = 0x41465445
static

Enum value: After, which means the alignment for attribute BlockAlign or the placement for attribute RubyPosition.

  • For attribute BlockAlign, this means after edge of the last child's allocation rectangle aligned with that of the table cell's content rectangle.

  • For attribute RubyPosition, this means the RT content is to be aligned along the after edge of the element.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBlockAlign , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyPosition .

◆ e_AttributeValueEnumAuto

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumAuto = 0x4155544f
static

Enum value: Auto.

  • For attribute Width and Height, this indicates that no specific value and the value will be determined automatically.

  • For attribute LineHeight, this means not to adjust for the value of BaselineShift.

  • For attribute GlyphOrientationVertical, this specifies a default orientation for text depending on whether it is fullwidth(as wide as it is high).

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeWidth , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeHeight , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeLineHeight , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeGlyphOrientationVertical .

◆ e_AttributeValueEnumBackground

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumBackground = 0x424b474e
static

Enum value: Background, which means background artifacts. Background artifacts typically serve as a background for content shown either on top of or placed adjacent to that background.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeSubType .

◆ e_AttributeValueEnumBefore

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumBefore = 0x42454652
static

Enum value: Before, which means the placement for attributes Placement/RubyPosition or alignment for attribute BlockAlign.

  • For attribute Placement, this means to be placed so that the before edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.

  • For attribute BlockAlign, this means before edge of the first child's allocation rectangle aligned with that of the table cell's content rectangle.

  • For attribute RubyPosition, this means the placement of the RT structure element relative to the RB element in a ruby assembly.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypePlacement , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBlockAlign , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyPosition .

◆ e_AttributeValueEnumBlock

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumBlock = 0x424c434b
static

Enum value: Block, which means to be stacked in the block-progression direction within an enclosing reference area or parent BLSE.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypePlacement .

◆ e_AttributeValueEnumBoth

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumBoth = 0x424f5448
static

Enum value: Row, which means both row and column of a table.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTableHeaderScope .

◆ e_AttributeValueEnumBottom

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumBottom = 0x42544f4d
static

Enum value: Bottom, which means bottom edge of the page.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeAttached .

◆ e_AttributeValueEnumCB

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumCB = 0x43420000
static

Enum value: cb, which means check box.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldRole .

◆ e_AttributeValueEnumCenter

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumCenter = 0x434e5452
static

Enum value: Center, which means the alignment for attributes TextAlign/InlineAlign/RubyAlign.

  • For attribute TextAlign, this means to be centered between the start and end edges.

  • For attribute InlineAlign, this means that each child centered within the table cell.

  • For attribute RubyAlign, this means that the content is to be centered in the inline-progression direction

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextAlign , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeInlineAlign , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyAlign .

◆ e_AttributeValueEnumCircle

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumCircle = 0x4352434c
static

Enum value: Circle, which means open circular bullet.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumColumn

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumColumn = 0x434c4d4e
static

Enum value: Row, which means column of a table.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTableHeaderScope .

◆ e_AttributeValueEnumDashed

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumDashed = 0x44534844
static

Enum value: Dashed, which means the border is a series of short line segments.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumDecimal

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumDecimal = 0x44434d4c
static

Enum value: Decimal, which means decimal arabic numerals (1-9, 10-99, ...).

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumDisc

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumDisc = 0x44495343
static

Enum value: Disc, which means solid circular bullet.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumDistribute

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumDistribute = 0x44535442
static

Enum value: Distribute, which means the content is to be expanded to fill the available width in the inline-progression direction.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyAlign .

◆ e_AttributeValueEnumDotted

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumDotted = 0x444f5444
static

Enum value: Dotten, which means the border is a series of dots.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumDouble

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumDouble = 0x44424c45
static

Enum value: Double, which means the border is two solid lines.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumEnd

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumEnd = 0x454e4400
static

Enum value: End, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign.

  • For attribute Placement, this means to be placed so that the end edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.

  • For attribute TextAlign, this means to be aligned with the end edge.

  • For attribute InlineAlign, this means end edge of each child's allocation rectangle aligned with that of the table cell's content rectangle.

  • For attribute RubyAlign, this means that the content is to be aligned on the end edge in the inlineprogression direction.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypePlacement , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextAlign , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeInlineAlign , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyAlign .

◆ e_AttributeValueEnumGroove

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumGroove = 0x41525459
static

Enum value: Groove, which means the border looks as though it were carved into the canvas.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumHidden

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumHidden = 0x4849444e
static

Enum value: Hidden, which is same as None except in terms of border conflict resolution for table elements.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumInline

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumInline = 0x494e4c4e
static

Enum value: Inline, which means the placement for attributes Placement/RubyPosition.

  • For attribute Placement, this means to be packed in the inline-progression direction within an enclosing BLSE.

  • For attribute RubyPosition, this means that the RT and associated RP elements are to be formatted as a parenthesis comment, following the RB element

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypePlacement , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyPosition .

◆ e_AttributeValueEnumInset

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumInset = 0x494e5354
static

Enum value: Inset, which means the border makes the entire box look as though it were embedded in the canvas.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumJustify

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumJustify = 0x4a535459
static

Enum value: Justify, which means the alignment for attributes TextAlign/BlockAlign/RubyAlign.

  • For attribute TextAlign, this means to be aligned with both the start and end edges, with internal spacing within each line expanded, if necessary, to achieve such alignment.

  • For attribute BlockAlign, this means that children are aligned with both the before and after edges of the table cell's content rectangle.

  • For attribute RubyAlign, this means that the content is to be centered in the inline-progression direction

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextAlign , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBlockAlign , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyAlign .

◆ e_AttributeValueEnumLayout

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumLayout = 0x4c41594f
static

Enum value: Layout, which means layout artifacts. Purely cosmetic typographical or design elements such as footnote rules or background screens.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeSubType .

◆ e_AttributeValueEnumLeft

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumLeft = 0x4c454654
static

Enum value: Left, which means left edge of the page.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeAttached .

◆ e_AttributeValueEnumLineThrough

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumLineThrough = 0x4c4e5448
static

Enum value: LineThrough, which means a line through the middle of the text.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextDecorationType .

◆ e_AttributeValueEnumLowerAlpha

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumLowerAlpha = 0x4c57414c
static

Enum value: LowerAlpha, which means lowercase letters (a, b, c, ...).

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumLowerRoman

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumLowerRoman = 0x4c57524d
static

Enum value: LowerRoman, which means lowercase roman numerals (i, ii, iii, iv, ...).

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumLrTb

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumLrTb = 0x4c525442
static

Enum value: LtTb, which means inline progression from left to right; block progression from top to bottom.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeWritingMode .

◆ e_AttributeValueEnumMiddle

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumMiddle = 0x4d49444c
static

Enum value: Middle, which means children are centered within the table cell.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBlockAlign .

◆ e_AttributeValueEnumNeutral

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumNeutral = 0x4e555452
static

Enum value: neutral, which means the state is neutral.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldChecked .

◆ e_AttributeValueEnumNone

◆ e_AttributeValueEnumNormal

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumNormal = 0x4e524d4c
static

Enum value: Normal, which means to adjust the line height to include any nonzero value specified for attribute BaselineShift .

@note This can be used with attribute type @link LRStructureElement::e_AttributeTypeLineHeight @endlink.

◆ e_AttributeValueEnumOff

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumOff = 0x4f464600
static

Enum value: off, which means the state is off.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldChecked .

◆ e_AttributeValueEnumOn

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumOn = 0x4f4e0000
static

Enum value: on, which means the state is on.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldChecked .

◆ e_AttributeValueEnumOrdered

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumOrdered = 0x4f524445
static

Enum value: Ordered (PDF 2.0), which means ordered lists with unspecified numbering.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumOther

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumOther = 0x4f544845
static

Enum value: Other (PDF 2.0).

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeDirection .

◆ e_AttributeValueEnumOutset

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumOutset = 0x4f545354
static

Enum value: Outset, which means the border makes the entire box look as though it were coming out of the canvas (the opposite of Inset).

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumOverline

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumOverline = 0x4f564c4e
static

Enum value: Overline, which means a line above the text.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextDecorationType .

◆ e_AttributeValueEnumPage

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumPage = 0x50414745
static

Enum value: Page, which means page artifacts. Production aids extraneous to the document itself, such as cut marks and color bars.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeSubType .

◆ e_AttributeValueEnumPagination

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumPagination = 0x5041474e
static

Enum value: Pagination, which means pagination artifacts. Ancillary page features such as running heads and folios (page numbers).

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeSubType .

◆ e_AttributeValueEnumPB

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumPB = 0x50440000
static

Enum value: pb, which means push button.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldRole .

◆ e_AttributeValueEnumRB

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumRB = 0x52420000
static

Enum value: rb, which means radio button.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldRole .

◆ e_AttributeValueEnumRidge

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumRidge = 0x52444745
static

Enum value: Ridge, which means the border looks as though it were coming out of the canvas (the opposite of Groove).

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumRight

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumRight = 0x52474854
static

Enum value: Right, which means right edge of the page.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeAttached .

◆ e_AttributeValueEnumRlTb

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumRlTb = 0x524c5442
static

Enum value: RlTb, which means inline progression from right to left; block progression from top to bottom.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeWritingMode .

◆ e_AttributeValueEnumRow

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumRow = 0x524f5700
static

Enum value: Row, which means row of a table.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTableHeaderScope .

◆ e_AttributeValueEnumSolid

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumSolid = 0x534f4c44
static

Enum value: Solid, which means the border is a single line segment.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeBorderStyle , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTBorderStyle .

◆ e_AttributeValueEnumSquare

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumSquare = 0x53515552
static

Enum value: Square, which means solid square bullet.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumStart

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumStart = 0x53545254
static

Enum value: Start, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign.

  • For attribute Placement, this means to be placed so that the start edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.

  • For attribute TextAlign, this means to be aligned with the start edge.

  • For attribute InlineAlign, this means start edge of each child's allocation rectangle aligned with that of the table cell's content rectangle.

  • For attribute RubyAlign, this means that the content is to be aligned on the start edge in the inlineprogression direction.

Note
This can be used with attribute types com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypePlacement , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextAlign , com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeInlineAlign , and com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyAlign .

◆ e_AttributeValueEnumTbLr

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumTbLr = 0x54424c52
static

Enum value: TbLr (PDF 2.0), which means inline progression from top to bottom; block progression from left to right.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeWritingMode .

◆ e_AttributeValueEnumTbRl

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumTbRl = 0x5442524c
static

Enum value: TbRl, which means inline progression from top to bottom; block progression from right to left.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeWritingMode .

◆ e_AttributeValueEnumTop

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumTop = 0x544f5000
static

Enum value: Top, which means top edge of the page.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeAttached .

◆ e_AttributeValueEnumTV

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumTV = 0x54560000
static

Enum value: tv, which means text-value field.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeFieldRole .

◆ e_AttributeValueEnumUnderline

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumUnderline = 0x55444c4e
static

Enum value: Underline, which means a line below the text.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeTextDecorationType .

◆ e_AttributeValueEnumUnordered

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumUnordered = 0x554e4f52
static

Enum value: Unordered (PDF 2.0), which means unordered list with unspecified bullets.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumUpperAlpha

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumUpperAlpha = 0x5550414c
static

Enum value: UpperAlpha, which means uppercase letters (A, B, C, ...).

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumUpperRoman

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumUpperRoman = 0x5550524d
static

Enum value: UpperRoman, which means uppercase roman numerals (I, II, III, IV, ...).

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeListNumbering .

◆ e_AttributeValueEnumWarichu

final int com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeValueEnumWarichu = 0x57415249
static

Enum value: Warichu, which means the RT and associated RP elements are to be formatted as a warichu, following the RB element.

Note
This can be used with attribute type com.foxit.sdk.addon.layoutrecognition.LRStructureElement.e_AttributeTypeRubyPosition .