Label (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.extensions
Class Label

java.lang.Object
  org.apache.fop.fo.FONode
      org.apache.fop.fo.FObj
          org.apache.fop.extensions.ExtensionObj
              org.apache.fop.extensions.Label

public class Label
extends ExtensionObj

Class representing destinations or targets within a document (/Dest objects in PDF, called "Destinations" in Adobe Acrobat). Used for the bookmark/outline extension.

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

Field Summary

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
`Label(FObj parent, PropertyList propertyList, java.lang.String systemId, int line, int column)`

Method Summary
`protected void`	`addCharacters(char[] data, int start, int length)` adds characters (does nothing here)
`java.lang.String`	`getName()` returns the name of the formatting object
`static FObj.Maker`	`maker()`
`java.lang.String`	`toString()`

Methods inherited from class org.apache.fop.extensions.ExtensionObj

format, layout

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

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

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

addChild, forceStartOffset, forceWidth, getLinkSet, getMarkerSnapshot, getParent, mayPrecedeMarker, removeAreas, resetMarker, rollback, setIsInTableCell, setLinkSet, setLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

Label

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

Method Detail

maker

public static FObj.Maker maker()

addCharacters

protected void addCharacters(char[] data,
                             int start,
                             int length)

Description copied from class: FObj

adds characters (does nothing here)

Overrides:: addCharacters in class FObj

Parameters:: data - text; start - start position; length - length of the text

toString

public java.lang.String toString()

getName

public java.lang.String getName()