imported>Aeric |
imported>Aeric |
| (22 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| These Javascript functions and variables are available for use in a JSP/HTML [[Page]] in the platform. They can also be used in Javascript defined for [[Action]] buttons.
| | #REDIRECT [[JavaScript Functions]] |
| __TOC__
| |
| | |
| ==Functions==
| |
| | |
| ===lj_closeDialog===
| |
| Close the current dialog. Typically used in conjunction with [[#lj_refreshCurrentTab|<tt>lj_refreshCurrentTab</tt>]].
| |
| | |
| ;Syntax:
| |
| :<syntaxhighlight lang="javascript" enclose="div">
| |
| lj_refreshCurrentTab();
| |
| </syntaxhighlight>
| |
| | |
| ;Sample Usage:
| |
| {{:Javascript closeDialog Sample}}
| |
| | |
| ===lj_printRecord===
| |
| This function displays a customized print dialog for a record. Use it to set defaults, to limit the available choices, and to choose the [[Print Template]] which is used. (It is only available for {{type|}}s.)
| |
| | |
| ;Syntax:
| |
| :<syntaxhighlight lang="javascript" enclose="div">
| |
| lj_printRecord('{option1}={value}&{option2}={value}&...');
| |
| </syntaxhighlight>
| |
| | |
| ;Sample Usage:
| |
| This code adds a '''[Custom Print]''' button to a [[Form]], when placed in an On Load [[Form Script]]. In this case, the goal is restrict a user who has access to that form to a specific template. (The standard Print operation makes all templates available. A standard [[Action]] button, meanwhile, is present in every form. This code puts the button in a specific form, to restrict template access for users whose role causes it to be displayed.)
| |
| :<syntaxhighlight lang="javascript" enclose="div">
| |
| $("print_button").remove();
| |
| $("#edit_button").parent().append(
| |
| "<input type='button' id='customPrint' value='Custom Print' class='lj-button fg-button ui-state-default ui-corner-all' onClick=\"javascript:lj_printRecord('default_print_layout=template&show_print_layout=no&default_print_document=jsp&default_page_orientation=landscape&default_pdf=yes&show_pdf=no&print_immediately=yes');\">"
| |
| );
| |
| </syntaxhighlight>
| |
| :;How it Works:
| |
| ::; <tt>$("print_button").remove()</tt>: Remove the standard print button
| |
| ::; <tt>$("#edit_button").parent().append</tt>: Finds the location of the edit button (present in every form), gets it's parent (the toolbar), and adds the new button to it.
| |
| ::; <tt>class='lj-button fg-button ui-state-default ui-corner-all'</tt>: The standard CSS style elements for platform buttons.
| |
| ::; <tt><nowiki><input type='button' ...</nowiki></tt>: Define the button. (The entire string is one uninterrupted line.)
| |
| ::; <tt>onClick=\"javascript:lj_printRecord(...</tt>: Specify the button's action
| |
| | |
| ;Parameters:
| |
| Each option has two parameters: One to specify a default value, the other to determine whether it should be displayed so it can be overridden by the user.
| |
| | |
| By default, an option is always shown, unless explicitly hidden.
| |
| | |
| :{| border="1" cellpadding="5" cellspacing="1"
| |
| ! align="left"| Parameter !! align="left"| Description (default value in '''bold''')
| |
| |-
| |
| | default_print_document || Object '''form''' or JSP/HTML [Page]
| |
| |-
| |
| | show_print_document || '''yes'''
| |
| |-
| |
| | default_print_layout || The form layout or template page to use.
| |
| |-
| |
| | show_print_layout || '''yes'''
| |
| |-
| |
| | default_page_orientation || '''portrait''' or landscape
| |
| |-
| |
| | show_page_orientation || '''yes'''
| |
| |-
| |
| | default_pdf || '''yes''' (otherwise, an HTML page is generated)
| |
| |-
| |
| | show_pdf || '''yes'''
| |
| |-
| |
| | print_immediately || '''no''' (queued, instead)
| |
| |-
| |
| | show_print_immediately || '''yes'''
| |
| |}
| |
| | |
| ===lj_refreshCurrentTab===
| |
| Refresh the current tab. Typically used in conjunction with [[#lj_closeDialog|<tt>lj_closeDialog</tt>]]
| |
| | |
| ;Syntax:
| |
| :<syntaxhighlight lang="javascript" enclose="div">
| |
| lj_refreshCurrentTab();
| |
| </syntaxhighlight>
| |
| | |
| ;Sample Usage:
| |
| {{:Javascript closeDialog Sample}}
| |
| | |
| ===lj_refreshTab===
| |
| Refresh a specific tab. Typically used in conjunction with [[#lj_closeDialog|<tt>lj_closeDialog</tt>]]
| |
| | |
| ;Syntax:
| |
| :<syntaxhighlight lang="javascript" enclose="div">
| |
| {window}.lj_refreshTab();
| |
| </syntaxhighlight>
| |
| | |
| ;Sample Usage:
| |
| {{:Javascript closeDialog Sample}}
| |
| | |
| ===lj_showDialog===
| |
| This function displays a JSP/HTML [[Page]] as a dialog.
| |
| | |
| ;Syntax:
| |
| :<syntaxhighlight lang="javascript" enclose="div">
| |
| lj_showDialog(url,vertical_coordinate, horizontal_coordinate, "dialog-type", "title");
| |
| </syntaxhighlight>
| |
| :{{TBD|Are horizontal & vertical coordinates in the right order?}}
| |
| | |
| ;Sample Usage:
| |
| This sample displays a page at the specified URL in a popup dialog that has a close button.
| |
| | |
| :<syntaxhighlight lang="javascript" enclose="div">
| |
| var url = "/networking/pages/MyPage.jsp?recordId="+someValue
| |
| + "&returnUrl="+encodeURIComponent(lj_window_src);
| |
| | |
| top.lj_showDialog(url,300,350,"popupdialogWithCloser","My Page Title");
| |
| </syntaxhighlight>
| |
| | |
| ;Parameters:
| |
| All parameters are coded as strings.
| |
| | |
| :{| border="1" cellpadding="5" cellspacing="1"
| |
| ! align="left"| Parameter !! align="left"| Description
| |
| |-
| |
| | url || The URL of a JSP/HTML [[Page]] in the platform, in the form <tt>/networking/pages/SomePage.jsp</tt> with optional query parameters to pass data, in the form <tt>?param1=abc¶m2=xyz&...</tt>
| |
| |-
| |
| | vertical_coordinate || Pixel location of the upper left corner, counting down from the top of the parent window.
| |
| |-
| |
| | horizontal_coordinate || Pixel location of the upper left corner, counting from the left side of the parent window.
| |
| |-
| |
| | dialog style || A string that specifies the display style
| |
| * '''popupdialogWithCloser -''' Displays the page in a popup, with a close button.
| |
| :{{TBD|What other styles are there?}}
| |
| |-
| |
| | title || Displayed in the banner of the dialog.
| |
| |}
| |
| | |
| ==Variables==
| |
| | |
| ===lj_window_src===
| |
| Contains the URL of the current page. (Needs to be URL encoded when used.)
| |
| | |
| ;Sample Usage:
| |
| :<syntaxhighlight lang="javascript" enclose="div">
| |
| encodeURIComponent(lj_window_src)
| |
| </syntaxhighlight>
| |
