Uses of Class org.apache.fop.fo.FObj (Apache FOP 2.7 API)
Date: 2022-01-12

## Uses of Class
org.apache.fop.fo.FObj

- Packages that use FObj
  Package | Description
  --- | ---
  org.apache.fop.datatypes | XSL Datatypes.
  org.apache.fop.fo | Classes, constants and basic infrastructure for the FO tree.
  org.apache.fop.fo.expr | Classes for XSL expressions and functions.
  org.apache.fop.fo.extensions | Base classes for implementing extensions to XSL-FO.
  org.apache.fop.fo.flow | All the block- and inline-level flow formatting objects.
  org.apache.fop.fo.flow.table |
  org.apache.fop.fo.pagination | All the pagination and declaration formatting objects.
  org.apache.fop.fo.pagination.bookmarks | Formatting objects for bookmarks as defined since XSL 1.1.
  org.apache.fop.fo.properties | Classes representing the various property types as well as supporting data structures for the FO tree.
  org.apache.fop.layoutmgr | FOP's layout engine.
  org.apache.fop.layoutmgr.inline | Layout managers for inline formatting objects and line building.
  org.apache.fop.layoutmgr.table | Layout managers for tables.
  org.apache.fop.render | Generic renderer interface.
  org.apache.fop.render.rtf.rtflib.tools | Utility classes used in RTF file generation.

- - ### Uses of FObj in org.apache.fop.datatypes

    Fields in org.apache.fop.datatypes declared as FObj
    Modifier and Type | Field and Description
    --- | ---
    `protected FObj` | LengthBase.`fobj` The FO for which this property is to be calculated.

    Methods in org.apache.fop.datatypes with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `int` | SimplePercentBaseContext.`getBaseLength(int lengthBase, FObj fobj)` Returns the value for the given lengthBase.
    `int` | ValidationPercentBaseContext.`getBaseLength(int lengthBase, FObj fobj)` Returns the value for the given lengthBase.
    `int` | PercentBaseContext.`getBaseLength(int lengthBase, FObj fobj)` Returns the base length for the given length base.

  - ### Uses of FObj in org.apache.fop.fo

    Subclasses of FObj in org.apache.fop.fo
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FObjMixed` Abstract base class for representation of mixed content formatting objects (= those that can contain both child `FONode`s and `#PCDATA`).

    Methods in org.apache.fop.fo that return FObj
    Modifier and Type | Method and Description
    --- | ---
    `FObj` | FObj.`findNearestAncestorFObj()` Find the nearest parent, grandparent, etc.
    `FObj` | PropertyList.`getFObj()`
    `FObj` | PropertyList.`getParentFObj()`
    `FObj` | FObj.FObjIterator.`parent()` Returns the parent node for this iterator's list of child nodes
    `FObj` | FONode.FONodeIterator.`parent()` Returns the parent node for this iterator's list of child nodes

    Methods in org.apache.fop.fo with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `PropertyList` | PropertyListMaker.`make(FObj fobj, PropertyList parentPropertyList)` Make a property list.

    Constructors in org.apache.fop.fo with parameters of type FObj
    Constructor and Description
    `PropertyList(FObj fObjToAttach, PropertyList parentPropertyList)` Basic constructor.
    `RecursiveCharIterator(FObj fobj)` Constructor which creates an iterator for all child nodes
    `RecursiveCharIterator(FObj fobj, FONode child)` Constructor which creates an iterator for only some child nodes
    `StaticPropertyList(FObj fObjToAttach, PropertyList parentPropertyList)` Construct a StaticPropertyList.

  - ### Uses of FObj in org.apache.fop.fo.expr

    Methods in org.apache.fop.fo.expr that return FObj
    Modifier and Type | Method and Description
    --- | ---
    `FObj` | PropertyInfo.`getFO()` accessor for FObj

  - ### Uses of FObj in org.apache.fop.fo.extensions

    Subclasses of FObj in org.apache.fop.fo.extensions
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ExternalDocument` Class for the fox:external-document extension element.

  - ### Uses of FObj in org.apache.fop.fo.flow

    Subclasses of FObj in org.apache.fop.fo.flow
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractGraphics` Common base class for the `fo:instream-foreign-object` and `fo:external-graphic` flow formatting objects.
    `class` | `AbstractListItemPart` Common superclass for `fo:list-item-label` and `fo:list-item-body`.
    `class` | `AbstractPageNumberCitation` Common base class for the `fo:page-number-citation` and `fo:page-number-citation-last` objects.
    `class` | `AbstractRetrieveMarker` Abstract base class for the `fo:retrieve-marker` and `fo:retrieve-table-marker` formatting objects.
    `class` | `BasicLink` Class modelling the `fo:basic-link` object.
    `class` | `BidiOverride` Class modelling the `fo:bidi-override` object.
    `class` | `Block` Class modelling the `fo:block object`.
    `class` | `BlockContainer` Class modelling the `fo:block-container` object.
    `class` | `ChangeBar` Common change bar base class.
    `class` | `ChangeBarBegin`
    `class` | `ChangeBarEnd`
    `class` | `Character` Class modelling the `fo:character` object.
    `class` | `ExternalGraphic` Class modelling the `fo:external-graphic` object.
    `class` | `Float` Class modelling the `fo:float` object.
    `class` | `Footnote` Class modelling the `fo:footnote` object.
    `class` | `FootnoteBody` Class modelling the `fo:footnote-body` object.
    `class` | `InitialPropertySet` Class modelling the `fo:initial-property-set` object.
    `class` | `Inline` Class modelling the `fo:inline` formatting object.
    `class` | `InlineContainer`
    `class` | `InlineLevel` Class modelling the commonalities of several inline-level formatting objects.
    `class` | `InstreamForeignObject` Class modelling the `fo:instream-foreign-object` object.
    `class` | `Leader` Class modelling the `fo:leader` object.
    `class` | `ListBlock` Class modelling the list block `fo:list-block` object.
    `class` | `ListItem` Class modelling the list item `fo:list-item` object.
    `class` | `ListItemBody` Class modelling the list item `fo:list-item-body object`.
    `class` | `ListItemLabel` Class modelling the list item `fo:list-item-label` object.
    `class` | `Marker` Class modelling the marker `fo:marker`object.
    `class` | `MultiCase` Class modelling the `fo:multi-case` object.
    `class` | `MultiProperties` Class modelling the `fo:multi-properties` object.
    `class` | `MultiPropertySet` Class modelling the `fo:multi-property-set` object.
    `class` | `MultiSwitch` Class modelling the `fo:multi-switch` object.
    `class` | `MultiToggle` Class modelling the `fo:multi-toggle` property.
    `class` | `PageNumber` Class modelling the `fo:page-number` object.
    `class` | `PageNumberCitation` Class modelling the `fo:page-number-citation` object.
    `class` | `PageNumberCitationLast` Class modelling the `fo:page-number-citation-last` object from XSL 1.1.
    `class` | `RetrieveMarker` Class modelling the `fo:retrieve-marker` formatting object.
    `class` | `RetrieveTableMarker` Class modelling the `fo:retrieve-table-marker` formatting object.
    `class` | `Wrapper` Class modelling the fo wrapper `fo:wrapper` object.

    Constructors in org.apache.fop.fo.flow with parameters of type FObj
    Constructor and Description
    `MarkerPropertyList(FObj fobj, PropertyList parentPropertyList)` Overriding default constructor

  - ### Uses of FObj in org.apache.fop.fo.flow.table

    Subclasses of FObj in org.apache.fop.fo.flow.table
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Table` Class modelling the `fo:table` object.
    `class` | `TableAndCaption` Class modelling the `fo:table-and-caption` property.
    `class` | `TableBody` Class modelling the `fo:table-body` object.
    `class` | `TableCaption` Class modelling the `fo:table-caption` object.
    `class` | `TableCell` Class modelling the `fo:table-cell` object.
    `class` | `TableCellContainer` A common class for fo:table-body and fo:table-row which both can contain fo:table-cell.
    `class` | `TableColumn` Class modelling the `fo:table-column` object.
    `class` | `TableFObj` Common base class for table-related FOs
    `class` | `TableFooter` Class modelling the `fo:table-footer` object.
    `class` | `TableHeader` Class modelling the `fo:table-header` object.
    `class` | `TablePart` An abstract base class modelling a TablePart (i.e.
    `class` | `TableRow` Class modelling the `fo:table-row` object.

    Methods in org.apache.fop.fo.flow.table with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `Property` | TableFObj.ColumnNumberPropertyMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | TableFObj.ColumnNumberPropertyMaker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.

  - ### Uses of FObj in org.apache.fop.fo.pagination

    Subclasses of FObj in org.apache.fop.fo.pagination
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractPageSequence` Abstract base class for the `fo:page-sequence` formatting object and the `fox:external-document` extension object.
    `class` | `ColorProfile` Class modelling the `fo:color-profile` object.
    `class` | `ConditionalPageMasterReference` Class modelling the `fo:conditional-page-master-reference` object.
    `class` | `Declarations` Class modelling the `fo:declarations` object.
    `class` | `Flow` Class modelling the `fo:flow` object.
    `class` | `LayoutMasterSet` Class modelling the `fo:layout-master-set` object.
    `class` | `PageSequence` Class modelling the `fo:page-sequence` object.
    `class` | `PageSequenceMaster` Class modelling the `fo:page-sequence-master` object.
    `class` | `PageSequenceWrapper` Class modelling the `fo:page-sequence-wrapper` object, first introduced in the XSL 1.1 WD.
    `class` | `Region` This is an abstract base class for pagination regions.
    `class` | `RegionAfter` Class modelling the `fo:region-after` object.
    `class` | `RegionBA` Abstract base class for `fo:region-before` and `fo:region-after`.
    `class` | `RegionBefore` Class modelling the `fo:region-before` object.
    `class` | `RegionBody` Class modelling the `fo:region-body` object.
    `class` | `RegionEnd` Class modelling the `fo:region-end` object.
    `class` | `RegionSE` Abstract base class for `fo:region-start` and `fo:region-end`.
    `class` | `RegionStart` Class modelling the `fo:region-start` object.
    `class` | `RepeatablePageMasterAlternatives` Class modelling the `fo:repeatable-page-master-alternatives` object.
    `class` | `RepeatablePageMasterReference` Class modelling the `fo:repeatable-page-master-reference` object.
    `class` | `Root` Class modeling the `fo:root` formatting object.
    `class` | `SideRegion` Common base class for side regions (before, after, start, end).
    `class` | `SimplePageMaster` Class modelling the `fo:simple-page-master` object.
    `class` | `SinglePageMasterReference` Class modelling the `fo:single-page-master-reference` object.
    `class` | `StaticContent` Class modelling the `fo:static-content` object.
    `class` | `Title` Class modeling the `fo:title` object.

  - ### Uses of FObj in org.apache.fop.fo.pagination.bookmarks

    Subclasses of FObj in org.apache.fop.fo.pagination.bookmarks
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Bookmark` Class modelling the `fo:bookmark` object, first introduced in the XSL 1.1 WD.
    `class` | `BookmarkTitle` Class modelling the `fo:bookmark-title` object, first introduced in the XSL 1.1 WD.
    `class` | `BookmarkTree` Class modelling the `fo:bookmark-tree` object, first introduced in the XSL 1.1 WD.

  - ### Uses of FObj in org.apache.fop.fo.properties

    Methods in org.apache.fop.fo.properties with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `Property` | CondLengthProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | LengthPairProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | FontStretchPropertyMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Convert a property.
    `Property` | LengthRangeProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | EnumProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Convert a property.
    `Property` | ColorProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a ColorProperty object based on the passed Property object.
    `Property` | SpaceProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | NumberProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | NumberProperty.PositiveIntegerMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` If the value is not positive, return a property with value 1 Return a Property object based on the passed Property object.
    `protected Property` | PropertyMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | FontSizePropertyMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | FontFamilyProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | KeepProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | SpacingPropertyMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Support for the 'normal' value.
    `protected Property` | CompoundPropertyMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | ListProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | ToBeImplementedProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)`
    `Property` | LengthProperty.Maker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | TextDecorationMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `Property` | LineHeightPropertyMaker.`convertProperty(Property p, PropertyList propertyList, FObj fo)` Return a Property object based on the passed Property object.
    `protected Property` | PropertyMaker.`convertPropertyDatatype(Property p, PropertyList propertyList, FObj fo)` For properties that have more than one legal way to be specified, this routine should be overridden to attempt to set them based upon the other methods.
    `Property` | PropertyMaker.`convertShorthandProperty(PropertyList propertyList, Property prop, FObj fo)` Converts a shorthand property
    `Property` | PropertyMaker.`make(Property baseProperty, int subpropertyId, PropertyList propertyList, java.lang.String value, FObj fo)` Make a property value for a compound property.
    `Property` | CompoundPropertyMaker.`make(Property baseProperty, int subpropertyId, PropertyList propertyList, java.lang.String value, FObj fo)` Return a property value for a compound property.
    `Property` | FontShorthandProperty.Maker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | CharacterProperty.Maker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | URIProperty.Maker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | BackgroundPositionShorthand.Maker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | FontWeightPropertyMaker.`make(PropertyList pList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | PropertyMaker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | FontSizePropertyMaker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | FontFamilyProperty.Maker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | StringProperty.Maker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Make a new StringProperty object
    `Property` | CompoundPropertyMaker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | OptionalCharacterProperty.Maker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `Property` | LineHeightPropertyMaker.`make(PropertyList propertyList, java.lang.String value, FObj fo)` Create a Property object from an attribute specification.
    `protected Property` | CompoundPropertyMaker.`makeCompound(PropertyList propertyList, FObj parentFO)` Create a empty compound property and fill it with default values for the subproperties.

    Constructors in org.apache.fop.fo.properties with parameters of type FObj
    Constructor and Description
    `TableColLength(double tcolUnits, FObj column)` Construct an object with tcolUnits of proportional measure.

  - ### Uses of FObj in org.apache.fop.layoutmgr

    Fields in org.apache.fop.layoutmgr declared as FObj
    Modifier and Type | Field and Description
    --- | ---
    `protected FObj` | AbstractBaseLayoutManager.`fobj` The formatting object for this LM.

    Methods in org.apache.fop.layoutmgr that return FObj
    Modifier and Type | Method and Description
    --- | ---
    `FObj` | AbstractBaseLayoutManager.`getFObj()` Returns the fo this layout manager is associated with.
    `FObj` | LayoutManager.`getFObj()` Returns the fo this layout manager is associated with.

    Methods in org.apache.fop.layoutmgr with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `int` | AbstractBaseLayoutManager.`getBaseLength(int lengthBase, FObj fobjx)` Returns the base length for the given length base.

    Constructors in org.apache.fop.layoutmgr with parameters of type FObj
    Constructor and Description
    `AbstractBaseLayoutManager(FObj fo)` Abstract base layout manager.
    `AbstractLayoutManager(FObj fo)` Abstract layout manager.
    `BlockStackingLayoutManager(FObj node)`
    `MultiCaseLayoutManager(FObj node)`
    `MultiSwitchLayoutManager(FObj node)`
    `SpacedBorderedPaddedBlockLayoutManager(FObj node)`

  - ### Uses of FObj in org.apache.fop.layoutmgr.inline

    Methods in org.apache.fop.layoutmgr.inline with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `int` | LeaderLayoutManager.`getBaseLength(int lengthBase, FObj fobj)` Returns the base length for the given length base.
    `int` | AbstractGraphicsLayoutManager.`getBaseLength(int lengthBase, FObj fobj)` Returns the base length for the given length base.

    Constructors in org.apache.fop.layoutmgr.inline with parameters of type FObj
    Constructor and Description
    `InlineStackingLayoutManager(FObj node)` Create an inline stacking layout manager.
    `LeafNodeLayoutManager(FObj node)` Create a Leaf node layout manager.

  - ### Uses of FObj in org.apache.fop.layoutmgr.table

    Methods in org.apache.fop.layoutmgr.table with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `int` | TableLayoutManager.`getBaseLength(int lengthBase, FObj fobj)` Returns the base length for the given length base.
    `int` | TableContentLayoutManager.`getBaseLength(int lengthBase, FObj fobj)` Returns the base length for the given length base.

  - ### Uses of FObj in org.apache.fop.render

    Methods in org.apache.fop.render with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `int` | DummyPercentBaseContext.`getBaseLength(int lengthBase, FObj fo)` Returns the base length for the given length base.

  - ### Uses of FObj in org.apache.fop.render.rtf.rtflib.tools

    Methods in org.apache.fop.render.rtf.rtflib.tools with parameters of type FObj
    Modifier and Type | Method and Description
    --- | ---
    `int` | PercentContext.`getBaseLength(int lengthBase, FObj fobj)` Returns the available width for a specific FObj
    `void` | BuilderContext.`pushPart(FObj part)` Push a Class representing a non-writeable section of the FO tree
    `void` | PercentContext.`setDimension(FObj fobj)` Elements willing to use this context have to register themselves by calling this function.
    `void` | PercentContext.`setDimension(FObj fobj, int width)` Elements having a width property can call this function if their width is calculated in RTFHandler

Copyright 1999-2022 The Apache Software Foundation. All Rights Reserved.