Button

This element is used to display a button on the page.

Attributes

Name	Description	Value
id	Unique Identifier.	Any
label	A label that is positioned above the button.	Any
name	The name of the button.	Any
colspan	The number of columns the component spans. The default value is 1.	numeric
rowspan	The number of rows the component spans. The default value is 1.	numeric
alignment	The position of the button relative to the parent component.	left, center, right
visiblemodes	The modes the button should be visible.	A comma-separated list of the modes (read, new, edit)
visibilityconditions	The conditions that should be met in order to display the component.	'[[pagefunction, datatype, datapath ]]' operator(==,!=) 'value'
setmode	The mode of the page when the button is clicked.	read, new, edit
refresh	The parts of the page that should be refreshed when the button is clicked.	page mainmenu main details tab,tabID component,is_on_tab:is_on_menu:tabID:componentID element,is_on_tab:is_on_menu:tabid:componentID:elementID section,sectionID area,areaID
url	The URL of the page the user will be redirected to when the button is clicked.	A relative URL
functioncall	The method(s) that will be called when the button is clicked.	A list of functions
buttonlook	Indicates if the button should appear like a button or underlined text.	true or false
assignandclosemodal	Close the modal and assign the values as defined when the modal was called. Used only when a page is opened as a modal.	true or false
closemodal	Closes the modal. Used only when a page is opened as a modal.	true or false
disableonclick	Disables the button on click. This prevents the user calling the same function more than once.	true or false
style	Disables the button. Used in cases where we want to show the button, but the user will not be able to press it.	TopToolbarItemsDisabled
image	Used in cases when we want to remove the default icon image from a button	none
functioncall	Defines the function call(s) triggered on button click.	<functions>…</functions>

Icons

Icon Image Name	Icon Image	Description
none		It disable any images that are added automatically
actions.png		Displayed if the icon image name is included in the image element
viewmore_3.png		Displayed if the button name is equals to "View More Information" or if the icon image name is included in the image element
preview_3.png		Displayed if the button name includes the word "preview" or if the icon image name is included in the image element
preview_4.png		Displayed if the icon image name is included in the image element
modify_3.png		Displayed if the button name is equals to "Add More Information" or if the icon image name is included in the image element
list_3.png		Displayed if the button name includes the words "View All" or "View Only" or if the icon image name is included in the image element
history_3.png		Displayed if the button name includes the word "History" or if the icon image name is included in the image element
modify_5.png		Displayed if the button name includes the word "Modify" or if the icon image name is included in the image element
reset_3.png		Displayed if the button name includes the words "Start Over" or if the icon image name is included in the image element
existing_3.png		Displayed if the button name includes the words "Use Existing" or if the icon image name is included in the image element
newar_5.png		Displayed if the button name includes the words "Register New" or if the icon image name is included in the image element
save1.png		Displayed if the button name is equals to "Save" or if the icon image name is included in the image element
new1.png		Displayed if the button name is equals to "New" or if the icon image name is included in the image element
edit1.png		Displayed if the button name is equals to "Edit" or if the icon image name is included in the image element
cancel1.png		Displayed if the button name is equals to "Cancel" or if the icon image name is included in the image element
delete1.png		Displayed if the button name is equals to "Delete" or if the icon image name is included in the image element
actions1.png		Displayed if the button name is equals to "Actions" or if the icon image name is included in the image element
back_button.png		Displayed if the button name is equals to "Home" or if the icon image name is included in the image element
saveasdraft1.png		Displayed if the button name is equals to "Save as Draft" or if the icon image name is included in the image element
plus-blue.png		Displayed if the button name is equals to "Add" (only on tabs) or if the icon image name is included in the image element
deleteit.png		Displayed if the button name is equals to "Remove" (only on tabs) or if the icon image name is included in the image element

Example

Button

Button

<button>
	<id>btnSubmit</id>
	<name>Submit</name>
	<setmode>read</setmode>
	<refresh>page</refresh>
	<buttonlook>true</buttonlook> 
	<visiblemodes>edit,new</visiblemodes>
	<alignment>right</alignment>
    <assignandclosemodal>true</assignandclosemodal>
	<functioncall>
		<functions>
			<function>
				<type>ejb</type>
				<classname>ejb/CRMUISubscriptionServiceSwap</classname>
				<functionname>submitButton</functionname>
				<resultaction>replace</resultaction>
				<datatype>root</datatype>
				<parameters>
					<parameter>
						<value>[[getDTO]]</value>
						<datatype>java.lang.Object</datatype>
					</parameter>
				</parameters>
			</function>
		</functions>
	</functioncall>
</button>