Page

Method Summary
	addChartToPage(Chart chart) Adds the specified chart to the page.
	addData(Data data) Adds the specified Data to this response.
boolean	addDataList(DataList list) Adds the specified list to a page
boolean	addDataMap(String id, Data data) Registers the data in the response with the specified id.
boolean	addDataMaps(String keyColumn, DataList list) Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.
boolean	addDataRecord(String id, DataRecord dataRecord) Registers the DataRecord in the response with the specified id. Limited to 500 records per response.
	addJavascript(String script) Adds javascript commands to the page.
	addPayload(Payload payload) Adds the payload to this response.
	addResponseHeader(String name, String value) Adds an http response header.
	allowHTML(String key) Permits any rendering target with the specified key to be rendered as HTML.
	enablePageForm(boolean enabled) If true, the platform page form will be the root level form on the page and ClientPal.getPageForm() will return it. The default is false, letting the developer control the main page form or forms.
	flushBase(boolean flush) If set, the base tag will include a version key that forces the browser to reload any cached content on each request. This works best for web sites that have a flat structure (no sub directories).
String	get(String key) Returns the value associated with key if it exists, null otherwise.
Data	getData() Returns the Data object for this response.
String	getValue(String key) Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)
	removeDataList(String name) Removes the datalist from the payload
	removeDataMap(String id) Removes the data in the response with the specified id.
	removeSessionLayer() Removes the rendering layer, if any.
	removeValue(String key) Removes the associated key from the response.
	set(String key, String value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setBoolean(String name, boolean value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
boolean	setData(String id, Data data) Registers the data in the response with the specified id.
	setDate(String name, Date value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setDecimal(String name, double value) ⚠Deprecated since 08-28-2018. Use setDouble(String,double) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setDouble(String name, double double) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setHTML(String key, String xhtml) Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.
	setInt(String name, long value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setSessionLayer(Payload payload) Sets a rendering layer based on content stored in the payload. Supported files: images, css, script.
	setString(String name, String value) Adds the key/value pair to the data map, over-writing any set that already exists with name key.
	setValue(String key, String value) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, boolean value) ⚠Deprecated since 08-28-2018. Use setBoolean(String,boolean) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, double value) ⚠Deprecated since 08-28-2018. Use setDouble(String,double) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, int value) ⚠Deprecated since 08-28-2018. Use setInt(String,int) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
	setValue(String key, long value) ⚠Deprecated since 08-28-2018. Use setInt(String,int) Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)
PdfFile	toPdf(String fileName) Creates PDF file from this page. File will reflect current page state. Further modifications of page will not have effect on file contents.
String	toString() Returns a description of this object.

Method Detail

---

addChartToPage(Chart chart)

Adds the specified chart to the page.

Parameters:

• Chart   chart

Since: 09-08-2008

---

addData(Data data)

Adds the specified Data to this response.

Parameters:

• Data   data

Since: 05-28-2010

---

boolean addDataList(DataList list)

Adds the specified list to a page

Parameters:

• DataList   list

Returns:  boolean

Since: 07-11-2008

---

boolean addDataMap(String id, Data data)

Registers the data in the response with the specified id.

Parameters:

• String   id Required parameter.
• Data   data Required parameter.

Returns:  boolean

Since: 05-28-2010

---

boolean addDataMaps(String keyColumn, DataList list)

Extracts the records from the list and registers them in the response using the values in the key column. Limited to 500 records per response.

Parameters:

• String   keyColumn Required parameter.
• DataList   list Required parameter.

Returns:  boolean

Since: 05-28-2010

---

boolean addDataRecord(String id, DataRecord dataRecord)

Registers the DataRecord in the response with the specified id. Limited to 500 records per response.

Parameters:

• String   id Required parameter.
• DataRecord   dataRecord Required parameter.

Returns:  boolean

Since: 11-09-2010

---

addJavascript(String script)

Adds javascript commands to the page.

Parameters:

• String   script

Since: 09-23-2019

---

addPayload(Payload payload)

Adds the payload to this response.

Parameters:

• Payload   payload

Since: 07-20-2010

---

addResponseHeader(String name, String value)

Adds an http response header.

Parameters:

• String   name
• String   value

Since: 05-26-2023

---

allowHTML(String key)

Permits any rendering target with the specified key to be rendered as HTML.

Parameters:

• String   key Required parameter.

Since: 08-02-2017

---

enablePageForm(boolean enabled)

If true, the platform page form will be the root level form on the page and ClientPal.getPageForm() will return it. The default is false, letting the developer control the main page form or forms.

Parameters:

• boolean   enabled Required parameter.

Since: 01-06-2022

---

flushBase(boolean flush)

If set, the base tag will include a version key that forces the browser to reload any cached content on each request. This works best for web sites that have a flat structure (no sub directories).

Parameters:

• boolean   flush

Since: 03-23-2018

---

String get(String key)

Returns the value associated with key if it exists, null otherwise.

Parameters:

• String   key

Returns:  String

Since: 08-28-2018

---

Data getData()

Returns the Data object for this response.

Returns:  Data

Since: 05-31-2007

---

String getValue(String key)

Returns the value associated with key if it exists, null otherwise. Shortcut for getData().getValue(key)

Parameters:

• String   key

Returns:  String

Since: 07-11-2008

---

removeDataList(String name)

Removes the datalist from the payload

Parameters:

• String   name  - name of data list in payload. Required parameter.

Since: 06-29-2021

---

removeDataMap(String id)

Removes the data in the response with the specified id.

Parameters:

• String   id Required parameter.

Since: 12-21-2017

---

removeSessionLayer()

Removes the rendering layer, if any.

Since: 12-08-2017

---

removeValue(String key)

Removes the associated key from the response.

Parameters:

• String   key

Since: 05-28-2010

---

set(String key, String value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   key Required parameter.
• String   value

Since: 08-28-2018

---

setBoolean(String name, boolean value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• boolean   value

Since: 08-28-2018

---

boolean setData(String id, Data data)

Registers the data in the response with the specified id.

Parameters:

• String   id Required parameter.
• Data   data Required parameter.

Returns:  boolean

Since: 02-11-2019

---

setDate(String name, Date value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• Date   value

Since: 08-28-2018

---

setDecimal(String name, double value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• double   value

Since: 08-28-2018

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

---

setDouble(String name, double double)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• double   double

Since: 08-28-2018

---

setHTML(String key, String xhtml)

Adds the given XHTML to the page (the XHTML should ideally be well-formed). You must use the c:html tag for displaying the content. Throws exception if the content contains illegal tags or attributes. You should avoid inline scripts or script blocks.

Parameters:

• String   key
• String   xhtml

Since: 07-11-2008

---

setInt(String name, long value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• long   value

Since: 08-28-2018

---

setSessionLayer(Payload payload)

Sets a rendering layer based on content stored in the payload. Supported files: images, css, script.

Parameters:

• Payload   payload Required parameter.

Since: 12-08-2017

---

setString(String name, String value)

Adds the key/value pair to the data map, over-writing any set that already exists with name key.

Parameters:

• String   name Required parameter.
• String   value

Since: 08-28-2018

---

setValue(String key, String value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• String   value

Since: 07-11-2008

---

setValue(String key, boolean value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• boolean   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setBoolean(String,boolean)

---

setValue(String key, double value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• double   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setDouble(String,double)

---

setValue(String key, int value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• int   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

---

setValue(String key, long value)

Adds the key/value pair to the data object for this page, over-writing any set that already exists with name key. Shortcut for getData().setValue(key,value)

Parameters:

• String   key
• long   value

Since: 04-06-2009

This method has been deprecated since 08-28-2018. Use setInt(String,int)

---

PdfFile toPdf(String fileName)

Creates PDF file from this page. File will reflect current page state. Further modifications of page will not have effect on file contents.

Parameters:

• String   fileName  - file name. Required parameter.

Returns:  PdfFile

Since: 11-03-2010

---

String toString()

Returns a description of this object.

Returns:  String

Since: 07-11-2008