com.klg.jclass.page.render
Class PageNumberMacro

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

All Implemented Interfaces:

TextMacro

public class PageNumberMacro

extends Object

implements TextMacro

PageNumberMacro evaluates to the number of the current page

Field Summary

protected int	status The status of the result of the last evaluation
protected String	text The text to which this 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

PageNumberMacro()
Create a macro instance

Method Summary

int	evaluate(com.klg.jclass.page.JCFlow flow, com.klg.jclass.page.JCPage page) Compute the current page number based on the flow and page
int	getStatus() Return the status of the last evaluation of the macro
String	getText() Return the page number as determined by the last 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 this macro has been evaluated

status

protected int status

The status of the result of the last evaluation

Constructor Detail

PageNumberMacro

public PageNumberMacro()

Create a macro instance

Method Detail

evaluate

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

Compute the current page number based on the flow and page

Specified by:

evaluate in interface TextMacro

Parameters:

flow - The flow within which we are evaluating this macro

page - the page the macro appears upon

Returns:

The status of the evaluation

getText

public String getText()

Return the page number as determined by the last evaluation

Specified by:

getText in interface TextMacro

Returns:

The page number

getStatus

public int getStatus()

Return the status of the last evaluation of the macro

Specified by:

getStatus in interface TextMacro

Returns:

An indication of the success of the last evaluation