com.bowstreet.builders.webapp.api
Class PagingButtons

java.lang.Object
  com.bowstreet.builders.BaseBuilderAPI
      com.bowstreet.builders.webapp.api.PagingButtons

public class PagingButtons
extends com.bowstreet.builders.BaseBuilderAPI

Adds a set of buttons to a page in the model for navigating through a data set specified in a Paging Assistant builder call.
Note: this is a builder API wrapper class, intended to be called by the regen logic of a builder. It can be used to programmatically add a call to the PagingButtons builder to a model.

Nested Class Summary

static interface

PagingButtons.BuilderStaticValues Constant values imported from the builder definition file.

Constructor Summary

PagingButtons(BuilderCall parent, GenContext gc)

Method Summary

boolean	getAbsoluteURLs() If checked, all relative URLs on the page will be converted to absolute URLs (recommended).
java.lang.String	getAssistantName() The name of the Paging Assistant builder to use as a data source.
boolean	getDoFormSubmission() If checked, clicking on a button will submit the surrounding form.
java.lang.String	getFirstDisabledButtonImage() Disabled button image for "first page" button
java.lang.String	getFirstHoverButtonImage() Hover button image for "first page" button
java.lang.String	getFirstImageAltText() FirstImageAltText
java.lang.String	getFirstImageHeight() FirstImageHeight
java.lang.String	getFirstImageWidth() FirstImageWidth
java.lang.String	getFirstNormalButtonImage() Button image for "first page" button
java.lang.String	getFirstPressedButtonImage() Pressed button image for "first page" button
java.lang.String	getHTMLPage() HTML file to use as ImportedPage base instead of default HTML
java.lang.String	getLastButtonUnboundedEnablement() Choose whether to enable the "last" button even if the count is unknown.
java.lang.String	getLastDisabledButtonImage() Disabled button image for "last page" button
java.lang.String	getLastHoverButtonImage() Hover button image for "last page" button
java.lang.String	getLastImageAltText() LastImageAltText
java.lang.String	getLastImageHeight() LastImageHeight
java.lang.String	getLastImageWidth() LastImageWidth
java.lang.String	getLastNormalButtonImage() Button image for "last page" button
java.lang.String	getLastPressedButtonImage() Pressed button image for "last page" button
java.lang.String	getMaxLinks() Upper limit on number of links to show
java.lang.String	getName() Specify name of this builder call
java.lang.String	getNextDisabledButtonImage() Disabled button image for "next page" button
java.lang.String	getNextHoverButtonImage() Hover button image for "next page" button
java.lang.String	getNextImageAltText() NextImageAltText
java.lang.String	getNextImageHeight() NextImageHeight
java.lang.String	getNextImageWidth() NextImageWidth
java.lang.String	getNextNormalButtonImage() Button image for "next page" button
java.lang.String	getNextPressedButtonImage() Pressed button image for "next page" button
java.lang.Object	getPageLocation() For instructions on operation or syntax of location definition string see Page Location help
java.lang.String	getPrevDisabledButtonImage() Disabled button image for "previous page" button
java.lang.String	getPrevHoverButtonImage() Hover button image for "previous page" button
java.lang.String	getPrevImageAltText() PrevImageAltText
java.lang.String	getPrevImageHeight() PrevImageHeight
java.lang.String	getPrevImageWidth() PrevImageWidth
java.lang.String	getPrevNormalButtonImage() Button image for "previous page" button
java.lang.String	getPrevPressedButtonImage() Pressed button image for "previous page" button
java.lang.String	getRangeTextFormat() How to display the range of current records/pages.
java.lang.String	getStyleSheet() Optional style sheet to be applied to the HTML page
java.lang.String	getUnboundedRangeTextFormat() How to display the range of current records/pages when the data set size is not known.
boolean	getUsePagingLinks() If checked, use paging links instead of range text.
boolean	getUsePartialPageRefresh() If checked, clicking on a button will only refresh the area being paged, not the whole page.
boolean	getUseTheme() Used to override HTML Template and Style Sheet with the values specified in the default WebApp theme.
void	initializeBuilderInputs()
void	setAbsoluteURLs(boolean value) If checked, all relative URLs on the page will be converted to absolute URLs (recommended).
void	setAssistantName(java.lang.String value) The name of the Paging Assistant builder to use as a data source.
void	setDoFormSubmission(boolean value) If checked, clicking on a button will submit the surrounding form.
void	setFirstDisabledButtonImage(java.lang.String value) Disabled button image for "first page" button
void	setFirstHoverButtonImage(java.lang.String value) Hover button image for "first page" button
void	setFirstImageAltText(java.lang.String value) FirstImageAltText
void	setFirstImageHeight(java.lang.String value) FirstImageHeight
void	setFirstImageWidth(java.lang.String value) FirstImageWidth
void	setFirstNormalButtonImage(java.lang.String value) Button image for "first page" button
void	setFirstPressedButtonImage(java.lang.String value) Pressed button image for "first page" button
void	setHTMLPage(java.lang.String value) HTML file to use as ImportedPage base instead of default HTML
void	setLastButtonUnboundedEnablement(java.lang.String value) Choose whether to enable the "last" button even if the count is unknown.
void	setLastDisabledButtonImage(java.lang.String value) Disabled button image for "last page" button
void	setLastHoverButtonImage(java.lang.String value) Hover button image for "last page" button
void	setLastImageAltText(java.lang.String value) LastImageAltText
void	setLastImageHeight(java.lang.String value) LastImageHeight
void	setLastImageWidth(java.lang.String value) LastImageWidth
void	setLastNormalButtonImage(java.lang.String value) Button image for "last page" button
void	setLastPressedButtonImage(java.lang.String value) Pressed button image for "last page" button
void	setMaxLinks(java.lang.String value) Upper limit on number of links to show
void	setName(java.lang.String value) Specify name of this builder call
void	setNextDisabledButtonImage(java.lang.String value) Disabled button image for "next page" button
void	setNextHoverButtonImage(java.lang.String value) Hover button image for "next page" button
void	setNextImageAltText(java.lang.String value) NextImageAltText
void	setNextImageHeight(java.lang.String value) NextImageHeight
void	setNextImageWidth(java.lang.String value) NextImageWidth
void	setNextNormalButtonImage(java.lang.String value) Button image for "next page" button
void	setNextPressedButtonImage(java.lang.String value) Pressed button image for "next page" button
void	setPageLocation(java.lang.Object value) For instructions on operation or syntax of location definition string see Page Location help
void	setPrevDisabledButtonImage(java.lang.String value) Disabled button image for "previous page" button
void	setPrevHoverButtonImage(java.lang.String value) Hover button image for "previous page" button
void	setPrevImageAltText(java.lang.String value) PrevImageAltText
void	setPrevImageHeight(java.lang.String value) PrevImageHeight
void	setPrevImageWidth(java.lang.String value) PrevImageWidth
void	setPrevNormalButtonImage(java.lang.String value) Button image for "previous page" button
void	setPrevPressedButtonImage(java.lang.String value) Pressed button image for "previous page" button
void	setRangeTextFormat(java.lang.String value) How to display the range of current records/pages.
void	setStyleSheet(java.lang.String value) Optional style sheet to be applied to the HTML page
void	setUnboundedRangeTextFormat(java.lang.String value) How to display the range of current records/pages when the data set size is not known.
void	setUsePagingLinks(boolean value) If checked, use paging links instead of range text.
void	setUsePartialPageRefresh(boolean value) If checked, clicking on a button will only refresh the area being paged, not the whole page.
void	setUseTheme(boolean value) Used to override HTML Template and Style Sheet with the values specified in the default WebApp theme.

Methods inherited from class com.bowstreet.builders.BaseBuilderAPI

getBuilderCall, getBuilderInputs, invokeBuilder, invokeBuilderBC, setBuilderInputs

Methods inherited from class java.lang.Object

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

Constructor Detail

PagingButtons

public PagingButtons(BuilderCall parent,
                     GenContext gc)

Method Detail

getAbsoluteURLs

public boolean getAbsoluteURLs()

If checked, all relative URLs on the page will be converted to absolute URLs (recommended).

getAssistantName

public java.lang.String getAssistantName()

The name of the Paging Assistant builder to use as a data source.

getDoFormSubmission

public boolean getDoFormSubmission()

If checked, clicking on a button will submit the surrounding form.

getFirstDisabledButtonImage

public java.lang.String getFirstDisabledButtonImage()

Disabled button image for "first page" button

getFirstHoverButtonImage

public java.lang.String getFirstHoverButtonImage()

Hover button image for "first page" button

getFirstImageAltText

public java.lang.String getFirstImageAltText()

FirstImageAltText

getFirstImageHeight

public java.lang.String getFirstImageHeight()

FirstImageHeight

getFirstImageWidth

public java.lang.String getFirstImageWidth()

FirstImageWidth

getFirstNormalButtonImage

public java.lang.String getFirstNormalButtonImage()

Button image for "first page" button

getFirstPressedButtonImage

public java.lang.String getFirstPressedButtonImage()

Pressed button image for "first page" button

getHTMLPage

public java.lang.String getHTMLPage()

HTML file to use as ImportedPage base instead of default HTML

getLastButtonUnboundedEnablement

public java.lang.String getLastButtonUnboundedEnablement()

Choose whether to enable the "last" button even if the count is unknown. Clicking the button in this case might cause a long delay if the data is very large.
Legal values: Enable (Always enable), Disable (Disable if data size is unknown)

getLastDisabledButtonImage

public java.lang.String getLastDisabledButtonImage()

Disabled button image for "last page" button

getLastHoverButtonImage

public java.lang.String getLastHoverButtonImage()

Hover button image for "last page" button

getLastImageAltText

public java.lang.String getLastImageAltText()

LastImageAltText

getLastImageHeight

public java.lang.String getLastImageHeight()

LastImageHeight

getLastImageWidth

public java.lang.String getLastImageWidth()

LastImageWidth

getLastNormalButtonImage

public java.lang.String getLastNormalButtonImage()

Button image for "last page" button

getLastPressedButtonImage

public java.lang.String getLastPressedButtonImage()

Pressed button image for "last page" button

getMaxLinks

public java.lang.String getMaxLinks()

Upper limit on number of links to show

getName

public java.lang.String getName()

Specify name of this builder call

getNextDisabledButtonImage

public java.lang.String getNextDisabledButtonImage()

Disabled button image for "next page" button

getNextHoverButtonImage

public java.lang.String getNextHoverButtonImage()

Hover button image for "next page" button

getNextImageAltText

public java.lang.String getNextImageAltText()

NextImageAltText

getNextImageHeight

public java.lang.String getNextImageHeight()

NextImageHeight

getNextImageWidth

public java.lang.String getNextImageWidth()

NextImageWidth

getNextNormalButtonImage

public java.lang.String getNextNormalButtonImage()

Button image for "next page" button

getNextPressedButtonImage

public java.lang.String getNextPressedButtonImage()

Pressed button image for "next page" button

getPageLocation

public java.lang.Object getPageLocation()

For instructions on operation or syntax of location definition string see Page Location help

getPrevDisabledButtonImage

public java.lang.String getPrevDisabledButtonImage()

Disabled button image for "previous page" button

getPrevHoverButtonImage

public java.lang.String getPrevHoverButtonImage()

Hover button image for "previous page" button

getPrevImageAltText

public java.lang.String getPrevImageAltText()

PrevImageAltText

getPrevImageHeight

public java.lang.String getPrevImageHeight()

PrevImageHeight

getPrevImageWidth

public java.lang.String getPrevImageWidth()

PrevImageWidth

getPrevNormalButtonImage

public java.lang.String getPrevNormalButtonImage()

Button image for "previous page" button

getPrevPressedButtonImage

public java.lang.String getPrevPressedButtonImage()

Pressed button image for "previous page" button

getRangeTextFormat

public java.lang.String getRangeTextFormat()

How to display the range of current records/pages.
Legal values: {start} - {end} of {count}, Page {page} of {page_count}

getStyleSheet

public java.lang.String getStyleSheet()

Optional style sheet to be applied to the HTML page

getUnboundedRangeTextFormat

public java.lang.String getUnboundedRangeTextFormat()

How to display the range of current records/pages when the data set size is not known.
Legal values: {start} - {end}

getUsePagingLinks

public boolean getUsePagingLinks()

If checked, use paging links instead of range text.

getUsePartialPageRefresh

public boolean getUsePartialPageRefresh()

If checked, clicking on a button will only refresh the area being paged, not the whole page.

getUseTheme

public boolean getUseTheme()

Used to override HTML Template and Style Sheet with the values specified in the default WebApp theme.

initializeBuilderInputs

public void initializeBuilderInputs()

Overrides:

initializeBuilderInputs in class com.bowstreet.builders.BaseBuilderAPI

setAbsoluteURLs

public void setAbsoluteURLs(boolean value)

If checked, all relative URLs on the page will be converted to absolute URLs (recommended).

setAssistantName

public void setAssistantName(java.lang.String value)

The name of the Paging Assistant builder to use as a data source.

setDoFormSubmission

public void setDoFormSubmission(boolean value)

If checked, clicking on a button will submit the surrounding form.

setFirstDisabledButtonImage

public void setFirstDisabledButtonImage(java.lang.String value)

Disabled button image for "first page" button

setFirstHoverButtonImage

public void setFirstHoverButtonImage(java.lang.String value)

Hover button image for "first page" button

setFirstImageAltText

public void setFirstImageAltText(java.lang.String value)

FirstImageAltText

setFirstImageHeight

public void setFirstImageHeight(java.lang.String value)

FirstImageHeight

setFirstImageWidth

public void setFirstImageWidth(java.lang.String value)

FirstImageWidth

setFirstNormalButtonImage

public void setFirstNormalButtonImage(java.lang.String value)

Button image for "first page" button

setFirstPressedButtonImage

public void setFirstPressedButtonImage(java.lang.String value)

Pressed button image for "first page" button

setHTMLPage

public void setHTMLPage(java.lang.String value)

HTML file to use as ImportedPage base instead of default HTML

setLastButtonUnboundedEnablement

public void setLastButtonUnboundedEnablement(java.lang.String value)

Choose whether to enable the "last" button even if the count is unknown. Clicking the button in this case might cause a long delay if the data is very large.
Legal values: Enable (Always enable), Disable (Disable if data size is unknown)

setLastDisabledButtonImage

public void setLastDisabledButtonImage(java.lang.String value)

Disabled button image for "last page" button

setLastHoverButtonImage

public void setLastHoverButtonImage(java.lang.String value)

Hover button image for "last page" button

setLastImageAltText

public void setLastImageAltText(java.lang.String value)

LastImageAltText

setLastImageHeight

public void setLastImageHeight(java.lang.String value)

LastImageHeight

setLastImageWidth

public void setLastImageWidth(java.lang.String value)

LastImageWidth

setLastNormalButtonImage

public void setLastNormalButtonImage(java.lang.String value)

Button image for "last page" button

setLastPressedButtonImage

public void setLastPressedButtonImage(java.lang.String value)

Pressed button image for "last page" button

setMaxLinks

public void setMaxLinks(java.lang.String value)

Upper limit on number of links to show

setName

public void setName(java.lang.String value)

Specify name of this builder call

setNextDisabledButtonImage

public void setNextDisabledButtonImage(java.lang.String value)

Disabled button image for "next page" button

setNextHoverButtonImage

public void setNextHoverButtonImage(java.lang.String value)

Hover button image for "next page" button

setNextImageAltText

public void setNextImageAltText(java.lang.String value)

NextImageAltText

setNextImageHeight

public void setNextImageHeight(java.lang.String value)

NextImageHeight

setNextImageWidth

public void setNextImageWidth(java.lang.String value)

NextImageWidth

setNextNormalButtonImage

public void setNextNormalButtonImage(java.lang.String value)

Button image for "next page" button

setNextPressedButtonImage

public void setNextPressedButtonImage(java.lang.String value)

Pressed button image for "next page" button

setPageLocation

public void setPageLocation(java.lang.Object value)

For instructions on operation or syntax of location definition string see Page Location help

setPrevDisabledButtonImage

public void setPrevDisabledButtonImage(java.lang.String value)

Disabled button image for "previous page" button

setPrevHoverButtonImage

public void setPrevHoverButtonImage(java.lang.String value)

Hover button image for "previous page" button

setPrevImageAltText

public void setPrevImageAltText(java.lang.String value)

PrevImageAltText

setPrevImageHeight

public void setPrevImageHeight(java.lang.String value)

PrevImageHeight

setPrevImageWidth

public void setPrevImageWidth(java.lang.String value)

PrevImageWidth

setPrevNormalButtonImage

public void setPrevNormalButtonImage(java.lang.String value)

Button image for "previous page" button

setPrevPressedButtonImage

public void setPrevPressedButtonImage(java.lang.String value)

Pressed button image for "previous page" button

setRangeTextFormat

public void setRangeTextFormat(java.lang.String value)

How to display the range of current records/pages.
Legal values: {start} - {end} of {count}, Page {page} of {page_count}

setStyleSheet

public void setStyleSheet(java.lang.String value)

Optional style sheet to be applied to the HTML page

setUnboundedRangeTextFormat

public void setUnboundedRangeTextFormat(java.lang.String value)

How to display the range of current records/pages when the data set size is not known.
Legal values: {start} - {end}

setUsePagingLinks

public void setUsePagingLinks(boolean value)

If checked, use paging links instead of range text.

setUsePartialPageRefresh

public void setUsePartialPageRefresh(boolean value)

If checked, clicking on a button will only refresh the area being paged, not the whole page.

setUseTheme

public void setUseTheme(boolean value)

Used to override HTML Template and Style Sheet with the values specified in the default WebApp theme.