A B C D E G H I L N O P R S T U V W X

A

AbstractITextBookRenderer - Class in org.apache.maven.doxia.book.services.renderer

Base class for iText renderer.

AbstractITextBookRenderer() - Constructor for class org.apache.maven.doxia.book.services.renderer.AbstractITextBookRenderer

AbstractXdocBookSink - Class in org.apache.maven.doxia.book.services.renderer.xdoc

Abstract XdocSink implementation for book.

AbstractXdocBookSink(Writer, I18N, Locale) - Constructor for class org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink

Default constructor.

addChapter(Chapter) - Method in class org.apache.maven.doxia.book.model.BookModel

Method addChapter.

addSection(Section) - Method in class org.apache.maven.doxia.book.model.Chapter

Method addSection.

author() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Marks the skip flag to true so that this element's text is not emitted by the base class.

author_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Marks the skip flag to false so that rendering can resume.

author_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Does nothing.

B

body() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Does nothing because we don't want the header from each document to crop up in the middle of a book.

body() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink

body() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Does nothing.

body_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Does nothing because we don't want the header from each document to crop up in the middle of a book.

body_() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink

body_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Does nothing.

book() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the start tag for the book.

book_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the end tag for the book.

bookAuthor() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the author start tag for the whole book.

bookAuthor() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.author().

bookAuthor_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the author end tag for the whole book.

bookAuthor_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.author_().

bookBody() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.body().

bookBody_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.body_().

BookContext - Class in org.apache.maven.doxia.book.context

Context to render a book.

BookContext() - Constructor for class org.apache.maven.doxia.book.context.BookContext

BookContext.BookFile - Class in org.apache.maven.doxia.book.context

Represents a BookFile.

BookContext.BookFile(File, String) - Constructor for class org.apache.maven.doxia.book.context.BookContext.BookFile

Constructor.

bookDate() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the date start tag for the whole book.

bookDate() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.date().

bookDate_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the date end tag for the whole book.

bookDate_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.date_().

BookDoxia - Interface in org.apache.maven.doxia.book

An interface to create books in different output formats from a book descriptor.

BookDoxiaException - Exception in org.apache.maven.doxia.book

Wraps an exception when rendering books.

BookDoxiaException(String) - Constructor for exception org.apache.maven.doxia.book.BookDoxiaException

Construct a new BookDoxiaException with the specified detail message.

BookDoxiaException(String, Throwable) - Constructor for exception org.apache.maven.doxia.book.BookDoxiaException

Construct a new BookDoxiaException with the specified detail message and cause.

bookHead() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.head().

bookHead_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

If some header matter has been encountered emit the book info end tag.

bookHead_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.head_().

BookIndex - Class in org.apache.maven.doxia.book.context

BookIndex class.

BookIndex() - Constructor for class org.apache.maven.doxia.book.context.BookIndex

Constructs a new BookIndex.

BookIndexer - Interface in org.apache.maven.doxia.book.services.indexer

Index a book.

BookIo - Interface in org.apache.maven.doxia.book.services.io

Common book-related IO methods.

BookModel - Class in org.apache.maven.doxia.book.model

Describes the book layout and packaging.

BookModel() - Constructor for class org.apache.maven.doxia.book.model.BookModel

BookModelXpp3Reader - Class in org.apache.maven.doxia.book.model.io.xpp3

Class BookModelXpp3Reader.

BookModelXpp3Reader() - Constructor for class org.apache.maven.doxia.book.model.io.xpp3.BookModelXpp3Reader

BookRenderer - Interface in org.apache.maven.doxia.book.services.renderer

Render a book.

bookTitle() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the title start tag for the whole book.

bookTitle() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.title().

bookTitle_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the title end tag for the whole book.

bookTitle_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Calls super.title_().

BookValidator - Interface in org.apache.maven.doxia.book.services.validation

Ensure a BookModel is valid.

C

Chapter - Class in org.apache.maven.doxia.book.model

Class Chapter.

Chapter() - Constructor for class org.apache.maven.doxia.book.model.Chapter

chapter() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the chapter start tag.

chapter_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the chapter end tag.

chapterTitle() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the chapter title start tag.

chapterTitle_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Emit the chapter title end tag.

ChapterXdocBookSink - Class in org.apache.maven.doxia.book.services.renderer.xdoc

A XdocSink implementation for chapter in a book.

ChapterXdocBookSink(Writer, IndexEntry, I18N, Locale) - Constructor for class org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink

Default constructor.

D

date_() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink

date_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Does nothing.

DefaultBookDoxia - Class in org.apache.maven.doxia.book

Default implementation of BookDoxia.

DefaultBookDoxia() - Constructor for class org.apache.maven.doxia.book.DefaultBookDoxia

DefaultBookIndexer - Class in org.apache.maven.doxia.book.services.indexer

Default implementation of BookIndexer.

DefaultBookIndexer() - Constructor for class org.apache.maven.doxia.book.services.indexer.DefaultBookIndexer

DefaultBookIo - Class in org.apache.maven.doxia.book.services.io

DefaultBookIo class.

DefaultBookIo() - Constructor for class org.apache.maven.doxia.book.services.io.DefaultBookIo

defaultBookPreamble() - Method in class org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink

Writes the default LaTeX commands and preamble in the main book file.

DefaultBookValidator - Class in org.apache.maven.doxia.book.services.validation

Default implementation of BookValidator.

DefaultBookValidator() - Constructor for class org.apache.maven.doxia.book.services.validation.DefaultBookValidator

DocbookBookRenderer - Class in org.apache.maven.doxia.book.services.renderer

An implementation of BookRenderer for docbook

DocbookBookRenderer() - Constructor for class org.apache.maven.doxia.book.services.renderer.DocbookBookRenderer

DocBookBookSink - Class in org.apache.maven.doxia.book.services.renderer.docbook

An Docbook Sink that doesn't write out head or body elements for every section of a book, and has some convenience methods relating to the construction of a Doxia Book.

DocBookBookSink(Writer) - Constructor for class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Construct a new DocBookSink.

E

equals(Object) - Method in class org.apache.maven.doxia.book.model.BookModel

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.book.model.Chapter

Method equals.

equals(Object) - Method in class org.apache.maven.doxia.book.model.Section

Method equals.

G

getAddDefaultEntities() - Method in class org.apache.maven.doxia.book.model.io.xpp3.BookModelXpp3Reader

Returns the state of the "add default entities" flag.

getAuthor() - Method in class org.apache.maven.doxia.book.model.BookModel

Get specifies the author of this book.

getAvailableBookRenderers() - Method in class org.apache.maven.doxia.book.DefaultBookDoxia

Returns a Set of ids of the BookRenderers that are available in this BookDoxia.

getBook() - Method in class org.apache.maven.doxia.book.context.BookContext

Return the BookModel of this BookContext.

getChapters() - Method in class org.apache.maven.doxia.book.model.BookModel

Method getChapters.

getDate() - Method in class org.apache.maven.doxia.book.model.BookModel

Get specifies the date of this book.

getDocumentBegin() - Method in class org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink

getDocumentStart() - Method in class org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink

getErrors() - Method in class org.apache.maven.doxia.book.services.validation.ValidationResult

Return the list of errors.

getFile() - Method in class org.apache.maven.doxia.book.context.BookContext.BookFile

Return the file of this BookFile.

getFile() - Method in class org.apache.maven.doxia.book.model.Section

Get specifies the file of this section.

getFiles() - Method in class org.apache.maven.doxia.book.context.BookContext

Return the files of this BookContext.

getId() - Method in class org.apache.maven.doxia.book.model.BookModel

Get specifies the id of this book.

getId() - Method in class org.apache.maven.doxia.book.model.Chapter

Get specifies the id of this chapter.

getId() - Method in class org.apache.maven.doxia.book.model.Section

Get specifies the id of this section.

getIndex() - Method in class org.apache.maven.doxia.book.context.BookContext

Return the index of this BookContext.

getInputEncoding() - Method in class org.apache.maven.doxia.book.context.BookContext

Getter for the field inputEncoding.

getLocale() - Method in class org.apache.maven.doxia.book.context.BookContext

Getter for the field locale.

getModelEncoding() - Method in class org.apache.maven.doxia.book.model.BookModel

Get the modelEncoding field.

getOutputDirectory() - Method in class org.apache.maven.doxia.book.context.BookContext

Return the outputDirectory of this BookContext.

getOutputEncoding() - Method in class org.apache.maven.doxia.book.context.BookContext

Getter for the field outputEncoding.

getOutputExtension() - Method in class org.apache.maven.doxia.book.services.renderer.AbstractITextBookRenderer

Get the output extension supported.

getOutputExtension() - Method in class org.apache.maven.doxia.book.services.renderer.PdfBookRenderer

Get the output extension supported.

getOutputExtension() - Method in class org.apache.maven.doxia.book.services.renderer.RtfBookRenderer

Get the output extension supported.

getParserId() - Method in class org.apache.maven.doxia.book.context.BookContext.BookFile

Return the parserId of this BookFile.

getSections() - Method in class org.apache.maven.doxia.book.model.Chapter

Method getSections.

getString(String) - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink

Gets a trimmed String for the given key from the resource bundle defined by Plexus.

getString(Locale, String) - Method in class org.apache.maven.doxia.book.services.renderer.XdocBookRenderer

Gets a trimmed String for the given key from the resource bundle defined by Plexus.

getTitle() - Method in class org.apache.maven.doxia.book.model.BookModel

Get specifies the title of this book.

getTitle() - Method in class org.apache.maven.doxia.book.model.Chapter

Get specifies the title of this chapter.

getTitle() - Method in class org.apache.maven.doxia.book.model.Section

Get specifies the title of this section.

getTitle() - Method in class org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink

Return the title.

getValidationResult() - Method in exception org.apache.maven.doxia.book.InvalidBookDescriptorException

Return the ValidationResult.

getWarnings() - Method in class org.apache.maven.doxia.book.services.validation.ValidationResult

Return the list of warnings.

H

hashCode() - Method in class org.apache.maven.doxia.book.model.BookModel

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.book.model.Chapter

Method hashCode.

hashCode() - Method in class org.apache.maven.doxia.book.model.Section

Method hashCode.

head() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Does nothing because we don't want the header from each document to crop up in the middle of a book.

head() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Does nothing.

head_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Does nothing because we don't want the header from each document to crop up in the middle of a book.

head_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Does nothing.

I

indexBook(BookModel, BookContext) - Method in interface org.apache.maven.doxia.book.services.indexer.BookIndexer

Index a book.

indexBook(BookModel, BookContext) - Method in class org.apache.maven.doxia.book.services.indexer.DefaultBookIndexer

Index a book.

IndexXdocBookSink - Class in org.apache.maven.doxia.book.services.renderer.xdoc

A XdocSink implementation for index book.

IndexXdocBookSink(Writer, IndexEntry, I18N, Locale) - Constructor for class org.apache.maven.doxia.book.services.renderer.xdoc.IndexXdocBookSink

Default constructor.

InvalidBookDescriptorException - Exception in org.apache.maven.doxia.book

Indicates that the book descriptor file could not be parsed correctly.

InvalidBookDescriptorException(ValidationResult) - Constructor for exception org.apache.maven.doxia.book.InvalidBookDescriptorException

Construct a new InvalidBookDescriptorException and stores the given ValidationResult.

isAllOk() - Method in class org.apache.maven.doxia.book.services.validation.ValidationResult

Checks if there were any errors or warnings.

L

LatexBookRenderer - Class in org.apache.maven.doxia.book.services.renderer

LatexBookRenderer class.

LatexBookRenderer() - Constructor for class org.apache.maven.doxia.book.services.renderer.LatexBookRenderer

LatexBookSink - Class in org.apache.maven.doxia.book.services.renderer.latex

LatexBookSink class.

LatexBookSink(Writer) - Constructor for class org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink

Construct a new LatexBookSink which is a LatexSink with the given writer, null sinkCommands, null preamble and fragmentDocument = true.

loadBook(File) - Method in interface org.apache.maven.doxia.book.BookDoxia

Load a BookModel from a descriptor file.

loadBook(File) - Method in class org.apache.maven.doxia.book.DefaultBookDoxia

Load a BookModel from a descriptor file.

loadFiles(BookContext, List<File>) - Method in interface org.apache.maven.doxia.book.services.io.BookIo

Loads files in a given context.

loadFiles(BookContext, List<File>) - Method in class org.apache.maven.doxia.book.services.io.DefaultBookIo

Loads files in a given context.

N

navigationPanel() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.AbstractXdocBookSink

Add a navigation panel.

navigationPanel() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink

Add a navigation panel.

navigationPanel() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.IndexXdocBookSink

Add a navigation panel.

navigationPanel() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.SectionXdocBookSink

Add a navigation panel.

next() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink

Add next link

next(IndexEntry, IndexEntry) - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.SectionXdocBookSink

Add next link.

O

org.apache.maven.doxia.book - package org.apache.maven.doxia.book

org.apache.maven.doxia.book.context - package org.apache.maven.doxia.book.context

org.apache.maven.doxia.book.model - package org.apache.maven.doxia.book.model

org.apache.maven.doxia.book.model.io.xpp3 - package org.apache.maven.doxia.book.model.io.xpp3

org.apache.maven.doxia.book.services.indexer - package org.apache.maven.doxia.book.services.indexer

org.apache.maven.doxia.book.services.io - package org.apache.maven.doxia.book.services.io

org.apache.maven.doxia.book.services.renderer - package org.apache.maven.doxia.book.services.renderer

org.apache.maven.doxia.book.services.renderer.docbook - package org.apache.maven.doxia.book.services.renderer.docbook

org.apache.maven.doxia.book.services.renderer.latex - package org.apache.maven.doxia.book.services.renderer.latex

org.apache.maven.doxia.book.services.renderer.xdoc - package org.apache.maven.doxia.book.services.renderer.xdoc

org.apache.maven.doxia.book.services.renderer.xhtml - package org.apache.maven.doxia.book.services.renderer.xhtml

org.apache.maven.doxia.book.services.validation - package org.apache.maven.doxia.book.services.validation

P

PdfBookRenderer - Class in org.apache.maven.doxia.book.services.renderer

PDF book renderer with the iText framework.

PdfBookRenderer() - Constructor for class org.apache.maven.doxia.book.services.renderer.PdfBookRenderer

previous(IndexEntry) - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink

Add previous link.

previous(IndexEntry, IndexEntry) - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.SectionXdocBookSink

Add previous link.

R

read(Reader, boolean) - Method in class org.apache.maven.doxia.book.model.io.xpp3.BookModelXpp3Reader

read(Reader) - Method in class org.apache.maven.doxia.book.model.io.xpp3.BookModelXpp3Reader

read(InputStream, boolean) - Method in class org.apache.maven.doxia.book.model.io.xpp3.BookModelXpp3Reader

Method read.

read(InputStream) - Method in class org.apache.maven.doxia.book.model.io.xpp3.BookModelXpp3Reader

Method read.

readBook(File) - Method in interface org.apache.maven.doxia.book.services.io.BookIo

Read a BookModel from a descriptor file.

readBook(File) - Method in class org.apache.maven.doxia.book.services.io.DefaultBookIo

Read a BookModel from a descriptor file.

removeChapter(Chapter) - Method in class org.apache.maven.doxia.book.model.BookModel

Method removeChapter.

removeSection(Section) - Method in class org.apache.maven.doxia.book.model.Chapter

Method removeSection.

renderBook(BookModel, String, List<File>, File) - Method in interface org.apache.maven.doxia.book.BookDoxia

Creates a book from a BookModel using the Locale.getDefault() and UTF-8 as default encoding.

renderBook(BookModel, String, List<File>, File, Locale, String, String) - Method in interface org.apache.maven.doxia.book.BookDoxia

Creates a book from a BookModel.

renderBook(BookModel, String, List<File>, File) - Method in class org.apache.maven.doxia.book.DefaultBookDoxia

Creates a book from a BookModel using the Locale.getDefault() and UTF-8 as default encoding.

renderBook(BookModel, String, List<File>, File, Locale, String, String) - Method in class org.apache.maven.doxia.book.DefaultBookDoxia

Creates a book from a BookModel.

renderBook(BookContext) - Method in class org.apache.maven.doxia.book.services.renderer.AbstractITextBookRenderer

Render a book.

renderBook(BookContext) - Method in interface org.apache.maven.doxia.book.services.renderer.BookRenderer

Render a book.

renderBook(BookContext) - Method in class org.apache.maven.doxia.book.services.renderer.DocbookBookRenderer

Render a book.

renderBook(BookContext) - Method in class org.apache.maven.doxia.book.services.renderer.LatexBookRenderer

Render a book.

renderBook(BookContext) - Method in class org.apache.maven.doxia.book.services.renderer.XdocBookRenderer

Render a book.

renderBook(BookContext) - Method in class org.apache.maven.doxia.book.services.renderer.XHtmlBookRenderer

Render a book.

renderXML(File, File) - Method in class org.apache.maven.doxia.book.services.renderer.AbstractITextBookRenderer

Generate an ouput file with the iText framework.

renderXML(File, File) - Method in class org.apache.maven.doxia.book.services.renderer.PdfBookRenderer

Generate an ouput file with the iText framework.

renderXML(File, File) - Method in class org.apache.maven.doxia.book.services.renderer.RtfBookRenderer

Generate an ouput file with the iText framework.

ROLE - Static variable in interface org.apache.maven.doxia.book.BookDoxia

The plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.book.services.indexer.BookIndexer

The plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.book.services.io.BookIo

The plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.book.services.renderer.BookRenderer

The plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.book.services.validation.BookValidator

The plexus lookup role.

RtfBookRenderer - Class in org.apache.maven.doxia.book.services.renderer

RTF book renderer with the iText framework.

RtfBookRenderer() - Constructor for class org.apache.maven.doxia.book.services.renderer.RtfBookRenderer

S

Section - Class in org.apache.maven.doxia.book.model

Class Section.

Section() - Constructor for class org.apache.maven.doxia.book.model.Section

sectionTitle() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

sectionTitle_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

SectionXdocBookSink - Class in org.apache.maven.doxia.book.services.renderer.xdoc

A XdocSink implementation for section in a book

SectionXdocBookSink(Writer, IndexEntry, I18N, Locale) - Constructor for class org.apache.maven.doxia.book.services.renderer.xdoc.SectionXdocBookSink

Default constructor.

setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.book.model.io.xpp3.BookModelXpp3Reader

Sets the state of the "add default entities" flag.

setAuthor(String) - Method in class org.apache.maven.doxia.book.model.BookModel

Set specifies the author of this book.

setBook(BookModel) - Method in class org.apache.maven.doxia.book.context.BookContext

Set the BookModel of this BookContext.

setChapters(List<Chapter>) - Method in class org.apache.maven.doxia.book.model.BookModel

Set specifies a collection of chapters.

setDate(String) - Method in class org.apache.maven.doxia.book.model.BookModel

Set specifies the date of this book.

setFile(String) - Method in class org.apache.maven.doxia.book.model.Section

Set specifies the file of this section.

setFiles(Map<String, BookContext.BookFile>) - Method in class org.apache.maven.doxia.book.context.BookContext

Set the files of this BookContext.

setId(String) - Method in class org.apache.maven.doxia.book.model.BookModel

Set specifies the id of this book.

setId(String) - Method in class org.apache.maven.doxia.book.model.Chapter

Set specifies the id of this chapter.

setId(String) - Method in class org.apache.maven.doxia.book.model.Section

Set specifies the id of this section.

setIndex(BookIndex) - Method in class org.apache.maven.doxia.book.context.BookContext

Set the index of this BookContext.

setInputEncoding(String) - Method in class org.apache.maven.doxia.book.context.BookContext

Setter for the field inputEncoding.

setLocale(Locale) - Method in class org.apache.maven.doxia.book.context.BookContext

Setter for the field locale.

setModelEncoding(String) - Method in class org.apache.maven.doxia.book.model.BookModel

Set the modelEncoding field.

setOutputDirectory(File) - Method in class org.apache.maven.doxia.book.context.BookContext

Set the outputDirectory of this BookContext.

setOutputEncoding(String) - Method in class org.apache.maven.doxia.book.context.BookContext

Setter for the field outputEncoding.

setSections(List<Section>) - Method in class org.apache.maven.doxia.book.model.Chapter

Set specifies a collection of sections.

setTitle(String) - Method in class org.apache.maven.doxia.book.model.BookModel

Set specifies the title of this book.

setTitle(String) - Method in class org.apache.maven.doxia.book.model.Chapter

Set specifies the title of this chapter.

setTitle(String) - Method in class org.apache.maven.doxia.book.model.Section

Set specifies the title of this section.

T

text(String) - Method in class org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink

title() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Marks the skip flag to true so that this element's text is not emitted by the base class.

title() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Does nothing.

title_() - Method in class org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

Marks the skip flag to false so that rendering can resume.

title_() - Method in class org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink

title_() - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Does nothing.

toString() - Method in class org.apache.maven.doxia.book.model.BookModel

Method toString.

toString() - Method in class org.apache.maven.doxia.book.model.Chapter

Method toString.

toString() - Method in class org.apache.maven.doxia.book.model.Section

Method toString.

U

up() - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink

Add parent/up link.

up(IndexEntry) - Method in class org.apache.maven.doxia.book.services.renderer.xdoc.SectionXdocBookSink

Add parent/up link.

V

validateBook(BookModel) - Method in interface org.apache.maven.doxia.book.services.validation.BookValidator

Validate a BookModel.

validateBook(BookModel) - Method in class org.apache.maven.doxia.book.services.validation.DefaultBookValidator

Validate a BookModel.

ValidationResult - Class in org.apache.maven.doxia.book.services.validation

Encapsulates the result of a validation.

ValidationResult() - Constructor for class org.apache.maven.doxia.book.services.validation.ValidationResult

W

write(String) - Method in class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

X

XdocBookRenderer - Class in org.apache.maven.doxia.book.services.renderer

An implementation of BookRenderer for Xdoc

XdocBookRenderer() - Constructor for class org.apache.maven.doxia.book.services.renderer.XdocBookRenderer

XHtmlBookRenderer - Class in org.apache.maven.doxia.book.services.renderer

XHtmlBookRenderer class.

XHtmlBookRenderer() - Constructor for class org.apache.maven.doxia.book.services.renderer.XHtmlBookRenderer

XhtmlBookSink - Class in org.apache.maven.doxia.book.services.renderer.xhtml

An Xhtml Sink that doesn't write out head or body elements.

XhtmlBookSink(Writer, RenderingContext) - Constructor for class org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink

Construct a new XhtmlBookSink.

A B C D E G H I L N O P R S T U V W X