Dynamic list JavaScript functions

Dynamic list JavaScript functions

In order to use a dynamic list, implement the following JavaScript functions in your JavaScript file. You must call the following JavaScript functions in your base frame JSP page.

JavaScript Functions Description
parent.loadFrames() Called when the page is initialized, this loads the other frames while the base frame is loading.
parent.afterLoads() Called when the page loading completes.
parent.setResultssize(size) Called after the page is loaded, this specifies the list size.
getUserNLSTitle() If you implement this function, the title in the scroll control frame is replaced by the translated version returned by this function.

Use the following JavaScript functions in your wizard, they are implemented by WebSphere Commerce by default. The following functions are defined in the parent frame, and are called using parent.functionName():

JavaScript Functions Description
parent.setTotalPage(num) Sets the total number of pages for the control panel navigation.
parent.setNumPage(num) Sets the current number of the page being displayed in the control panel navigation.
parent.setTotalItem(num) Sets the total number of items in the control panel navigation.
parent.displayButton(name) Dynamically displays the button name.
parent.hideButton(name) Dynamically hides the button name.
parent.showControlPanel() Dynamically shows the control panel.
parent.hideControlPanel() Dynamically hides the control panel.
parent.removeEntry(name) Explicitly removes the selected element by its name (same as check box name).
parent.setInstruction(text) Sets the instruction text in the scroll control frame.
parent.setButtonPos(x,y) Dynamically sets the button position. For example, setButtonPos('0px','15px') moves all of the buttons down by 15 pixels. Other valid units are centimeters (cm), millimeters (mm), inches (in), points (pt), and picas (pc).
parent.removeEntry() Dynamic lists keep track of what was checked in previous visits to the page. If these items no longer meet the criteria for inclusion in the list, you may use the parent.removeEntry method to remove all of the checked items.

Related concepts

Dynamic lists

Related tasks

Add a dynamic list
Related reference

Java methods available for a dynamic list

JavaScript Functions	Description
parent.loadFrames()	Called when the page is initialized, this loads the other frames while the base frame is loading.
parent.afterLoads()	Called when the page loading completes.
parent.setResultssize(size)	Called after the page is loaded, this specifies the list size.
getUserNLSTitle()	If you implement this function, the title in the scroll control frame is replaced by the translated version returned by this function.

JavaScript Functions	Description
parent.setTotalPage(num)	Sets the total number of pages for the control panel navigation.
parent.setNumPage(num)	Sets the current number of the page being displayed in the control panel navigation.
parent.setTotalItem(num)	Sets the total number of items in the control panel navigation.
parent.displayButton(name)	Dynamically displays the button name.
parent.hideButton(name)	Dynamically hides the button name.
parent.showControlPanel()	Dynamically shows the control panel.
parent.hideControlPanel()	Dynamically hides the control panel.
parent.removeEntry(name)	Explicitly removes the selected element by its name (same as check box name).
parent.setInstruction(text)	Sets the instruction text in the scroll control frame.
parent.setButtonPos(x,y)	Dynamically sets the button position. For example, setButtonPos('0px','15px') moves all of the buttons down by 15 pixels. Other valid units are centimeters (cm), millimeters (mm), inches (in), points (pt), and picas (pc).
parent.removeEntry()	Dynamic lists keep track of what was checked in previous visits to the page. If these items no longer meet the criteria for inclusion in the list, you may use the parent.removeEntry method to remove all of the checked items.