Developer

Page class

Page class represents a one page of menu items based on the specified maximum number of items per page.

Package

com.sybase365.mobiliser.brand.plugins.smapp.state
Syntax
Syntax
public class Page

Members

All members of Page, including inherited members.

Variables
Modifier and Type Variable Description
protected boolean next True/false for whether to show the pagination menu item or not, respectively.
protected boolean exit True/false for whether to show the Exit menu item or not, respectively.
protected String header Header text to be included with the menu items. For example, the header text "Transactions:" will appear in the following menu:
        Transactions:
        1. 26 Jan 2012 09:16 - USD 10.00 Pay cab
 2. 26 Jan 2012 10:10 - USD 3.45  Starbucks
 3. 26 Jan 2012 12:25 - USD 20.00 Lunch
 4. 26 Jan 2012 13:30 - USD 3.00 Starbucks
 9: More
 0: Exit
protected String lineBreak Line break characters to be used in the menu. Some operator support different types of line break characters, so this specified line break characters will be used in the menu.
protected String paginationExit The Exit menu item. For example, the following menu has the "0: Exit" as the exit menu item.
        Transactions:
        1. 26 Jan 2012 09:16 - USD 10.00 Pay cab
 2. 26 Jan 2012 10:10 - USD 3.45  Starbucks
 3. 26 Jan 2012 12:25 - USD 20.00 Lunch
 4. 26 Jan 2012 13:30 - USD 3.00 Starbucks
 9: More
 0: Exit
protected String paginationNext The pagination NEXT menu item. For example, the following menu has the "9: More" as the pagination next menu item.
        Transactions:
        1. 26 Jan 2012 09:16 - USD 10.00 Pay cab
 2. 26 Jan 2012 10:10 - USD 3.45  Starbucks
 3. 26 Jan 2012 12:25 - USD 20.00 Lunch
 4. 26 Jan 2012 13:30 - USD 3.00 Starbucks
 9: More
 0: Exit
protected List< KeyValuePair< String, String > > items List of KeyValuePair items to be used in generating the menu items.
Constructors
Modifier and Type Constructor Description
public Page(boolean) Constructor.
Methods
Modifier and Type Method Description
public String getHeader() Get the header text to be included with the menu items.
public List< KeyValuePair< String, String > > getItems() Get the List of KeyValuePair items to be used in generating the menu items.
public String getLineBreak() Line break characters to be used in the menu.
public String getPaginationExit() Get the Exit menu item.
public String getPaginationNext() Get the pagination NEXT menu item.
public boolean isExit() True/false for whether to show the Exit menu item or not, respectively.
public boolean isNext() True/false for whether to show the pagination Next menu item or not, respectively.
protected String previewMenu() String representation of the menu page, but without the pagination menu item.
public void setExit(boolean) Set True/false for whether to show the Exit menu item or not, respectively.
public void setHeader(String) Set the header text to be included with the menu items.
public void setItems(List< KeyValuePair< String, String >>) Set the List of KeyValuePair items to be used in generating the menu items.
public void setLineBreak(String) Line break characters to be used in the menu.
public void setNext(boolean) Set True/false for whether to show the pagination Next menu item or not, respectively.
public void setPaginationExit(String) Set the Exit menu item.
public void setPaginationNext(String) Set the pagination NEXT menu item.
public String toString() Complete string representation of the menu page.

Usage

Used in the AbstractDynamicMenu implementation of Send SMS menu states.