com.klg.jclass.page.render
Class SectionNumberMacro

java.lang.Object
  |
  +--com.klg.jclass.page.render.SectionNumberMacro

All Implemented Interfaces:

TextMacro

public class SectionNumberMacro

extends Object

implements TextMacro

SectionNumberMacro evaluates to the number of the current page

Field Summary

protected int	status The status of the last evaluation
protected String	text The text to which the macro has been evaluated

Fields inherited from interface com.klg.jclass.page.TextMacro

MACRO_EVALUATED, MACRO_INITIALIZED, MACRO_NOT_YET_EVALUATED, PAGE_NUMBER, PAGE_TOTAL, ROMAN_NUMBER, SECTION_NUMBER, SECTION_PAGE_NUMBER, SECTION_PAGE_TOTAL

Constructor Summary

SectionNumberMacro()
Create a macro instance

Method Summary

int	evaluate(com.klg.jclass.page.JCFlow flow, com.klg.jclass.page.JCPage page) Determine the section number (as a string) given current flow information
int	getStatus() Return the status of the last evaluation
String	getText() Return the text that was the result of the most recent evaluation

Methods inherited from class java.lang.Object

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

Field Detail

text

protected String text

The text to which the macro has been evaluated

status

protected int status

The status of the last evaluation

Constructor Detail

SectionNumberMacro

public SectionNumberMacro()

Create a macro instance

Method Detail

evaluate

public int evaluate(com.klg.jclass.page.JCFlow flow,
                    com.klg.jclass.page.JCPage page)

Determine the section number (as a string) given current flow information

Specified by:

evaluate in interface TextMacro

Parameters:

flow - The document's flow

page - The current page when we are evaluating the macro

Returns:

Whether or not the evaluation succeeded

getText

public String getText()

Return the text that was the result of the most recent evaluation

Specified by:

getText in interface TextMacro

Returns:

The current text value of this macro

getStatus

public int getStatus()

Return the status of the last evaluation

Specified by:

getStatus in interface TextMacro

Returns:

The indication of the success of the last macro evaluation