com.klg.jclass.page
Class JCFlowEvent

java.lang.Object
  |
  +--com.klg.jclass.page.JCFlowEvent

public class JCFlowEvent

extends Object

A JCFlow event occurs when entering or exiting a new frame or page as a result of document flow, and also when a frame or page is marked as complete by the resolution of embedded macros.

Field Summary

protected com.klg.jclass.page.PageArea	currentPageArea The frame or page in which the event has occurred.
protected int	eventId The identifier indicating the event that has occurred.
static int	FRAME_BEGIN
static int	FRAME_COMPLETE
static int	FRAME_END
protected String	nextAreaName The name of the next frame or page template.
protected com.klg.jclass.page.PageArea	nextPageArea The next frame or page in which the event has occurred.
static int	PAGE_BEGIN
static int	PAGE_COMPLETE
static int	PAGE_END
protected com.klg.jclass.page.JCFlow	source The flow in which the event occurs.

Constructor Summary

JCFlowEvent(com.klg.jclass.page.JCFlow source, int event_id, com.klg.jclass.page.PageArea current_page_area)

JCFlowEvent(com.klg.jclass.page.JCFlow source, int event_id, com.klg.jclass.page.PageArea current_page_area, com.klg.jclass.page.PageArea next_page_area)

Method Summary

com.klg.jclass.page.PageArea	getCurrentPageArea()
String	getNextElementName()
com.klg.jclass.page.PageArea	getNextPageArea()
com.klg.jclass.page.JCFlow	getSource()
void	setNextPageArea(com.klg.jclass.page.PageArea new_next)

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_BEGIN

public static final int PAGE_BEGIN

See Also:

Constant Field Values

PAGE_END

public static final int PAGE_END

See Also:

Constant Field Values

PAGE_COMPLETE

public static final int PAGE_COMPLETE

See Also:

Constant Field Values

FRAME_BEGIN

public static final int FRAME_BEGIN

See Also:

Constant Field Values

FRAME_END

public static final int FRAME_END

See Also:

Constant Field Values

FRAME_COMPLETE

public static final int FRAME_COMPLETE

See Also:

Constant Field Values

source

protected com.klg.jclass.page.JCFlow source

The flow in which the event occurs.

eventId

protected int eventId

The identifier indicating the event that has occurred.

currentPageArea

protected com.klg.jclass.page.PageArea currentPageArea

The frame or page in which the event has occurred.

nextPageArea

protected com.klg.jclass.page.PageArea nextPageArea

The next frame or page in which the event has occurred.

nextAreaName

protected String nextAreaName

The name of the next frame or page template.

Constructor Detail

JCFlowEvent

public JCFlowEvent(com.klg.jclass.page.JCFlow source,
                   int event_id,
                   com.klg.jclass.page.PageArea current_page_area)

JCFlowEvent

public JCFlowEvent(com.klg.jclass.page.JCFlow source,
                   int event_id,
                   com.klg.jclass.page.PageArea current_page_area,
                   com.klg.jclass.page.PageArea next_page_area)

Method Detail

getSource

public com.klg.jclass.page.JCFlow getSource()

getCurrentPageArea

public com.klg.jclass.page.PageArea getCurrentPageArea()

getNextPageArea

public com.klg.jclass.page.PageArea getNextPageArea()

getNextElementName

public String getNextElementName()

setNextPageArea

public void setNextPageArea(com.klg.jclass.page.PageArea new_next)