Marker (Fop API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Home

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.fop.fo.flow
Class Marker

java.lang.Object
  org.apache.fop.fo.FONode
      org.apache.fop.fo.FObj
          org.apache.fop.fo.FObjMixed
              org.apache.fop.fo.flow.Marker

public class Marker
extends FObjMixed

Nested Class Summary
`static class`	`Marker.Maker`

Field Summary

Fields inherited from class org.apache.fop.fo.FObjMixed

textState

Fields inherited from class org.apache.fop.fo.FObj

column, line, properties, propMgr, systemId

Fields inherited from class org.apache.fop.fo.FONode

areaClass, areasGenerated, BREAK_AFTER, children, forcedStartOffset, forcedWidth, isInTableCell, linkSet, log, marker, parent, START

Constructor Summary
`Marker(FObj parent, PropertyList propertyList, java.lang.String systemId, int line, int column)`

Method Summary
`java.lang.String`	`getMarkerClassName()`
`java.lang.String`	`getName()` returns the name of the formatting object
`Area`	`getRegistryArea()`
`int`	`layout(Area area)` generates the area or areas for this formatting object and adds these to the area.
`int`	`layoutMarker(Area area)`
`static FObj.Maker`	`maker()`
`boolean`	`mayPrecedeMarker()`
`void`	`releaseRegistryArea()`
`void`	`resetMarker()`
`void`	`resetMarkerContent()`

Methods inherited from class org.apache.fop.fo.FObjMixed

addCharacters, addChild, end, getTextState

Methods inherited from class org.apache.fop.fo.FObj

addMarker, generatesReferenceAreas, getContentWidth, getProperty, makePropertyManager, removeID, setWritingMode

Methods inherited from class org.apache.fop.fo.FONode

forceStartOffset, forceWidth, getLinkSet, getMarkerSnapshot, getParent, removeAreas, rollback, setIsInTableCell, setLinkSet, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Marker

public Marker(FObj parent,
              PropertyList propertyList,
              java.lang.String systemId,
              int line,
              int column)
       throws FOPException

Method Detail

maker

public static FObj.Maker maker()

getName

public java.lang.String getName()

Description copied from class: FObj

returns the name of the formatting object

Specified by:: getName in class FObj

Returns:: the name of this formatting objects

layout

public int layout(Area area)
           throws FOPException