org.odftoolkit.simple.presentation

Class Notes.NotesBuilder

java.lang.Object

org.odftoolkit.simple.presentation.Notes.NotesBuilder

Enclosing class:

Notes

public static class Notes.NotesBuilder
extends Object

This is a tool class which supplies all of the notes creation detail.

The end user isn't allowed to create it directly, otherwise an IllegalStateException will be thrown.

Since:

0.3.5

Constructor Summary

Constructors

Constructor and Description
Notes.NotesBuilder(PresentationDocument doc) NotesBuilder constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Notes	getNotesInstance(PresentationNotesElement noteElement) Get a presentation notes page instance by an instance of PresentationNotesElement.

Methods inherited from class java.lang.Object

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

Constructor Detail

Notes.NotesBuilder

public Notes.NotesBuilder(PresentationDocument doc)

NotesBuilder constructor. This constructor should only be use in owner PresentationDocument constructor. The end user isn't allowed to call it directly, otherwise an IllegalStateException will be thrown.

Parameters:

doc - the owner PresentationDocument.

Throws:

IllegalStateException - if new NotesBuilder out of owner PresentationDocument constructor, this exception will be thrown.

Method Detail

getNotesInstance

public Notes getNotesInstance(PresentationNotesElement noteElement)

Get a presentation notes page instance by an instance of PresentationNotesElement.

Parameters:

noteElement - an instance of PresentationNotesElement

Returns:

an instance of Notes that can represent PresentationNotesElement