Class IFContext
java.lang.Object
org.apache.fop.render.intermediate.IFContext
- All Implemented Interfaces:
PageIndexContext
This class provides a context object that is valid for a single processing run to create
an output file using the intermediate format. It allows access to the user agent and other
context information, such as foreign attributes for certain elements in the intermediate
format.
Foreign attributes are usually specific to a particular output format implementation. Most implementations will just ignore all foreign attributes for most elements. That's why the main IF interfaces are not burdened with this.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Map
foreign attributes: Map<QName, Object>private boolean
private String
private Locale
private String
private int
private int
private IFContext.RegionType
private StructureTreeElement
private FOUserAgent
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetForeignAttribute
(org.apache.xmlgraphics.util.QName qName) Returns a foreign attribute.Returns the currently applicable foreign attributes.(package private) String
getID()
Returns the ID of the object enclosing the current content.Returns the currently applicable language.Returns the location of the object enclosing the current content.int
Obtain current page index.int
Returns the current structure tree element.Returns the associated user agent.boolean
Returnstrue
if the last text in the currently processed text area is hyphenated.void
Resets the foreign attributes to "no foreign attributes".void
Resets the current structure tree element.void
setForeignAttributes
(Map foreignAttributes) Sets the currently applicable foreign attributes.void
setHyphenated
(boolean hyphenated) Records that the last text in the currently processed text area is hyphenated.(package private) void
Sets the ID of the object enclosing the content that will follow.void
setLanguage
(Locale lang) Sets the currently applicable language.void
setLocation
(String location) Sets the location of the object enclosing the current content.void
setPageIndex
(int pageIndex) Record current page index.void
setPageNumber
(int pageNumber) void
setRegionType
(int type) void
setRegionType
(String type) void
setStructureTreeElement
(StructureTreeElement structureTreeElement) Sets the structure tree element to which the subsequently painted marks will correspond.void
Set the user agent.
-
Field Details
-
userAgent
-
foreignAttributes
foreign attributes: Map<QName, Object> -
language
-
structureTreeElement
-
id
-
location
-
hyphenated
private boolean hyphenated -
pageIndex
private int pageIndex -
pageNumber
private int pageNumber -
regionType
-
-
Constructor Details
-
IFContext
Main constructor.- Parameters:
ua
- the user agent
-
-
Method Details
-
setUserAgent
Set the user agent.- Parameters:
ua
- the user agent
-
getUserAgent
Returns the associated user agent.- Returns:
- the user agent
-
getForeignAttributes
Returns the currently applicable foreign attributes.- Returns:
- a Map<QName, Object>
-
getForeignAttribute
Returns a foreign attribute.- Parameters:
qName
- the qualified name of the foreign attribute- Returns:
- the value of the foreign attribute or null if the attribute isn't specified
-
setForeignAttributes
Sets the currently applicable foreign attributes.- Parameters:
foreignAttributes
- a Map<QName, Object> or null to reset
-
resetForeignAttributes
public void resetForeignAttributes()Resets the foreign attributes to "no foreign attributes". -
setLanguage
Sets the currently applicable language.- Parameters:
lang
- the language
-
getLanguage
Returns the currently applicable language.- Returns:
- the language (or null if the language is undefined)
-
setStructureTreeElement
Sets the structure tree element to which the subsequently painted marks will correspond. This method is used when accessibility features are enabled.- Parameters:
structureTreeElement
- the structure tree element
-
resetStructureTreeElement
public void resetStructureTreeElement()Resets the current structure tree element. -
getStructureTreeElement
Returns the current structure tree element.- Returns:
- the structure tree element (or null if no element is active)
- See Also:
-
setID
Sets the ID of the object enclosing the content that will follow.- Parameters:
id
- the ID of the nearest ancestor object for which the id property was set
-
getID
String getID()Returns the ID of the object enclosing the current content.- Returns:
- the ID of the nearest ancestor object for which the id property was set
-
setLocation
Sets the location of the object enclosing the current content. location the line and column location of the object in the source FO file -
getLocation
Returns the location of the object enclosing the current content.- Returns:
- the line and column location of the object in the source FO file,
null
if that information is not available
-
setHyphenated
public void setHyphenated(boolean hyphenated) Records that the last text in the currently processed text area is hyphenated. -
isHyphenated
public boolean isHyphenated()Returnstrue
if the last text in the currently processed text area is hyphenated. -
setPageIndex
public void setPageIndex(int pageIndex) Record current page index.- Parameters:
pageIndex
- a zero based page index or -1 (no page)
-
getPageIndex
public int getPageIndex()Obtain current page index.- Specified by:
getPageIndex
in interfacePageIndexContext
- Returns:
- a zero based page index or -1 (no page)
-
getPageNumber
public int getPageNumber() -
setPageNumber
public void setPageNumber(int pageNumber) -
getRegionType
-
setRegionType
-
setRegionType
public void setRegionType(int type)
-