org.pajes.db.entity
Class ListerTemplate

java.lang.Object
  org.pajes.html.PajeTemplate
      org.pajes.db.entity.ListerTemplate

public class ListerTemplate
extends PajeTemplate

Generates an Paje instance to display a lost of Entity objects. The source HTML file from which the Paje is generated must contain an Container object (such as a table cell (<td>)) which has an ID attribute of entityContainer.

Field Summary

static java.lang.String	ADD_ROW The ID attribute of the row in the Table used to display a list of Entity objects managed by this class, that contains anchor or button to add a new entity.
static java.lang.String	EVEN_PROTOTYPE_ID The ID attribute of the even prototype row in the Table used to display a list of Entity objects managed by this class.
static java.lang.String	HEADER_ROW The ID attribute of the header row in the Table used to display a list of Entity objects managed by this class.
static java.lang.String	LIST_CONTAINER_ID Constant for accessing the document element with the ID attribute of "entityContainer".
static java.lang.String	NAVIGATE_FIRST_ID The ID attribute of the tag that allows the user to navigate to the first page in a sequence of multiple pages.
static java.lang.String	NAVIGATE_LAST_ID The ID attribute of the tag that allows the user to navigate to the last page in a sequence of multiple pages.
static java.lang.String	NAVIGATE_NEXT_ID The ID attribute of the tag that allows the user to navigate to the next page in a sequence of multiple pages.
static java.lang.String	NAVIGATE_PREVIOUS_ID The ID attribute of the tag that allows the user to navigate to the previous page in a sequence of multiple pages.
static java.lang.String	NAVIGATE_UPTO_MESSAGE_ID The ID attribute of the tag that informs the user the page location of this page in the total number of pages in the list.
static java.lang.String	NAVIGATION_ROW The ID attribute of the row in the Table used to display a list of Entity objects managed by this class, that contains anchors or buttons to navigate through mulitple pages.
static java.lang.String	ODD_PROTOTYPE_ID The ID attribute of the odd prototype row in the Table used to display a list of Entity objects managed by this class.

Constructor Summary

ListerTemplate()

Method Summary

static Container	getAddRow(Container container) Retrieves the tag identified with an ID attribute of ADD_ROW.
static Container	getHeaderRow(Container container) Retrieves the tag identified with an ID attribute of HEADER_ROW.
static Container	getListContainer(Container container) Retrieves the tag identified with an ID attribute of LIST_CONTAINER_ID.
static Tag	getNavigateFirst(Container container) Retrieves the tag identified with an ID attribute of NAVIGATE_FIRST_ID.
static Tag	getNavigateLast(Container container) Retrieves the tag identified with an ID attribute of NAVIGATE_LAST_ID.
static Tag	getNavigateNext(Container container) Retrieves the tag identified with an ID attribute of NAVIGATE_NEXT_ID.
static Tag	getNavigatePrevious(Container container) Retrieves the tag identified with an ID attribute of NAVIGATE_PREVIOUS_ID.
static Tag	getNavigateUptoMessage(Container container) Retrieves the tag identified with an ID attribute of NAVIGATE_UPTO_MESSAGE_ID.
static Container	getNavigationRow(Container container) Retrieves the tag identified with an ID attribute of NAVIGATION_ROW.

Methods inherited from class org.pajes.html.PajeTemplate

addDiscardedUnexpectedTagWarning, addToContainer, addToContainer, addToContainer, addWarning, clearWarnings, dumpAttributes, generate, generate, getAttributeIndex, getAttributeValue, getCurrentContainer, getCurrentForm, getWarning, handleEmptyTag, handleTag_a, handleTag_applet, handleTag_area, handleTag_b, handleTag_base, handleTag_big, handleTag_body, handleTag_br, handleTag_center, handleTag_cite, handleTag_code, handleTag_col, handleTag_colgroup, handleTag_dd, handleTag_dfn, handleTag_div, handleTag_dl, handleTag_dt, handleTag_em, handleTag_embed, handleTag_fieldset, handleTag_font, handleTag_form, handleTag_frame, handleTag_frameset, handleTag_h1, handleTag_h2, handleTag_h3, handleTag_h4, handleTag_h5, handleTag_h6, handleTag_head, handleTag_hr, handleTag_html, handleTag_i, handleTag_iframe, handleTag_img, handleTag_input_button, handleTag_input_checkbox, handleTag_input_file, handleTag_input_hidden, handleTag_input_image, handleTag_input_password, handleTag_input_radio, handleTag_input_reset, handleTag_input_submit, handleTag_input_text, handleTag_input, handleTag_kbd, handleTag_label, handleTag_legend, handleTag_li, handleTag_link, handleTag_map, handleTag_meta, handleTag_nobr, handleTag_noembed, handleTag_noframes, handleTag_noscript, handleTag_object, handleTag_ol, handleTag_optgroup, handleTag_option, handleTag_p, handleTag_param, handleTag_pre, handleTag_s, handleTag_samp, handleTag_script, handleTag_select, handleTag_small, handleTag_span, handleTag_strike, handleTag_strong, handleTag_style, handleTag_sub, handleTag_sup, handleTag_table, handleTag_tbody, handleTag_td, handleTag_textarea, handleTag_tfoot, handleTag_th, handleTag_thead, handleTag_title, handleTag_tr, handleTag_tt, handleTag_u, handleTag_ul, handleTag_var, handleTag, handleText, handleUnclosedFormattedTextTags, handleUnclosedTag_colgroup, handleUnclosedTag_dd, handleUnclosedTag_dt, handleUnclosedTag_li, handleUnclosedTag_option, handleUnclosedTag_p, log, log, log, log, log, log, log, modifyLineBreaks, popCurrentContainer, popCurrentPsuedoContainer, postProcessDocument, postProcessTag, setLogging, setSuppressWarning, setWarning

Methods inherited from class java.lang.Object

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

Field Detail

ADD_ROW

public static final java.lang.String ADD_ROW

The ID attribute of the row in the Table used to display a list of Entity objects managed by this class, that contains anchor or button to add a new entity.

See Also:

Constant Field Values

HEADER_ROW

public static final java.lang.String HEADER_ROW

The ID attribute of the header row in the Table used to display a list of Entity objects managed by this class.

See Also:

Constant Field Values

EVEN_PROTOTYPE_ID

public static final java.lang.String EVEN_PROTOTYPE_ID

The ID attribute of the even prototype row in the Table used to display a list of Entity objects managed by this class.

See Also:

Constant Field Values

LIST_CONTAINER_ID

public static final java.lang.String LIST_CONTAINER_ID

Constant for accessing the document element with the ID attribute of "entityContainer".

See Also:

Constant Field Values

NAVIGATE_FIRST_ID

public static final java.lang.String NAVIGATE_FIRST_ID

The ID attribute of the tag that allows the user to navigate to the first page in a sequence of multiple pages.

See Also:

Constant Field Values

NAVIGATE_LAST_ID

public static final java.lang.String NAVIGATE_LAST_ID

The ID attribute of the tag that allows the user to navigate to the last page in a sequence of multiple pages.

See Also:

Constant Field Values

NAVIGATE_NEXT_ID

public static final java.lang.String NAVIGATE_NEXT_ID

The ID attribute of the tag that allows the user to navigate to the next page in a sequence of multiple pages.

See Also:

Constant Field Values

NAVIGATE_PREVIOUS_ID

public static final java.lang.String NAVIGATE_PREVIOUS_ID

The ID attribute of the tag that allows the user to navigate to the previous page in a sequence of multiple pages.

See Also:

Constant Field Values

NAVIGATE_UPTO_MESSAGE_ID

public static final java.lang.String NAVIGATE_UPTO_MESSAGE_ID

The ID attribute of the tag that informs the user the page location of this page in the total number of pages in the list.

See Also:

Constant Field Values

NAVIGATION_ROW

public static final java.lang.String NAVIGATION_ROW

The ID attribute of the row in the Table used to display a list of Entity objects managed by this class, that contains anchors or buttons to navigate through mulitple pages.

See Also:

Constant Field Values

ODD_PROTOTYPE_ID

public static final java.lang.String ODD_PROTOTYPE_ID

The ID attribute of the odd prototype row in the Table used to display a list of Entity objects managed by this class.

See Also:

Constant Field Values

Constructor Detail

ListerTemplate

public ListerTemplate()

Method Detail

getAddRow

public static final Container getAddRow(Container container)

Retrieves the tag identified with an ID attribute of ADD_ROW.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the ADD_ROW Tag instance.

getHeaderRow

public static final Container getHeaderRow(Container container)

Retrieves the tag identified with an ID attribute of HEADER_ROW.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the HEADER_ROW Tag instance.

getListContainer

public static final Container getListContainer(Container container)

Retrieves the tag identified with an ID attribute of LIST_CONTAINER_ID.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the LIST_CONTAINER_ID Tag instance

getNavigateFirst

public static final Tag getNavigateFirst(Container container)

Retrieves the tag identified with an ID attribute of NAVIGATE_FIRST_ID.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the NAVIGATE_FIRST_ID Tag instance.

getNavigateLast

public static final Tag getNavigateLast(Container container)

Retrieves the tag identified with an ID attribute of NAVIGATE_LAST_ID.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the NAVIGATE_LAST_ID Tag instance.

getNavigateNext

public static final Tag getNavigateNext(Container container)

Retrieves the tag identified with an ID attribute of NAVIGATE_NEXT_ID.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the NAVIGATE_NEXT_ID Tag instance.

getNavigatePrevious

public static final Tag getNavigatePrevious(Container container)

Retrieves the tag identified with an ID attribute of NAVIGATE_PREVIOUS_ID.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the NAVIGATE_PREVIOUS_ID Tag instance.

getNavigateUptoMessage

public static final Tag getNavigateUptoMessage(Container container)

Retrieves the tag identified with an ID attribute of NAVIGATE_UPTO_MESSAGE_ID.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the NAVIGATE_UPTO_MESSAGE_ID Tag instance.

getNavigationRow

public static final Container getNavigationRow(Container container)

Retrieves the tag identified with an ID attribute of NAVIGATION_ROW.

Parameters:

container - the Container object in which the tag is to be located. This should be the lowest possible container within the document hierarchy to enable the most efficient retrieval.

Returns:

the NAVIGATION_ROW Tag instance.