org.foray.mif
Class MifBookComponent

java.lang.Object
  org.foray.mif.MifToken
      org.foray.mif.MifBookComponent

public class MifBookComponent
extends MifToken

A MIF Book Component.

Constructor Summary

MifBookComponent()
Constructor.

Method Summary

MifFrame	createFrame(MifBook book, int x, int y, int w, int h) Create a frame and add it to this component.
MifTbl	createTable() Creates a new table and adds it to this component.
MifFrame	curFrame() Returns the current frame.
MifPage	curPage() Returns the current page.
MifTbl	curTable() Returns the current table.
MifTextFlow	curTextFlow() Returns the current text flow.
MifColorCatalog	getColorCatalog() Returns the color catalog for this component.
MifDocument	getDocument() Returns the document associated with this component.
List<MifPage>	getPages() Returns the pages for this component.
MifTblCatalog	getTblCatalog() Returns the table catalog for this component.
List<MifFlow>	getTextFlows() Returns the text flows for this component.
String	mifContent() Returns the content of this token as a String.
void	setDocument(MifDocument document) Sets the document associated with this component.

Methods inherited from class java.lang.Object

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

Constructor Detail

MifBookComponent

public MifBookComponent()

Constructor.

Method Detail

createFrame

public MifFrame createFrame(MifBook book,
                            int x,
                            int y,
                            int w,
                            int h)

Create a frame and add it to this component.

Parameters:

book - The book for the new frame (??????).

x - The x coordinate of the new frame.

y - The y coordinate of the new frame.

w - The width of the new frame.

h - The height of the new frame.

Returns:

The new frame.

curFrame

public MifFrame curFrame()

Returns the current frame.

Returns:

The current frame.

curTextFlow

public MifTextFlow curTextFlow()

Returns the current text flow.

Returns:

The current text flow.

createTable

public MifTbl createTable()

Creates a new table and adds it to this component.

Returns:

The new table.

curTable

public MifTbl curTable()

Returns the current table.

Returns:

The current table.

mifContent

public String mifContent()

Description copied from class: MifToken

Returns the content of this token as a String.

Returns:

The content of this token as a String.

curPage

public MifPage curPage()

Returns the current page.

Returns:

The current page.

getTblCatalog

public MifTblCatalog getTblCatalog()

Returns the table catalog for this component.

Returns:

Returns the tblCatalog.

getColorCatalog

public MifColorCatalog getColorCatalog()

Returns the color catalog for this component.

Returns:

Returns the colorCatalog.

getPages

public List<MifPage> getPages()

Returns the pages for this component.

Returns:

The pages for this component.

getDocument

public MifDocument getDocument()

Returns the document associated with this component.

Returns:

The document.

getTextFlows

public List<MifFlow> getTextFlows()

Returns the text flows for this component.

Returns:

The textFlows.

setDocument

public void setDocument(MifDocument document)

Sets the document associated with this component.

Parameters:

document - The document to associate with this component.