Using Page Controls

This chapter provides an overview of page controls and discusses how to use:

• Charts.

• Frames.

• Group boxes.

• Horizontal rules.

• Images.

• Static text.

• Check boxes.

• Drop-down list boxes.

• Edit boxes and long edit boxes.

• Radio buttons.

• Popup pages.

• Subpages.

• Secondary pages.

• Push buttons or links.

• HTML areas.

Understanding Page Controls

There are three categories of controls that you use in page design and development. You determine which types of controls that you want to add to your page definition by considering how you want to organize information on a page as well as how your users will enter data.

This section discusses:

• Aesthetic controls.

• Data entry controls.

• Function and data processing controls.

Aesthetic Controls

Use aesthetic controls to help organize, display, or emphasize information on the page. In most cases, aesthetic controls are not associated with a particular record field that is defined in a record definition and maintained in the database. With the exception of the image control, these controls never update data in the database. Aesthetic controls include:

Data Entry Controls

Use data entry controls to offer different ways to enter and maintain information. These types of controls are always associated with a record field that is defined in a record definition and maintained in the database.

Note. The PeopleSoft Application Designer allows you add up to 405 fields on a page. When you have reached this limit, typical system behavior includes being unable to select, move, or edit the page fields with an order number exceeding the 405–field limit. While this limit has no affect on the page during runtime, it has the potential to disrupt productivity during design time. If you find a page nearing the 405-field limit, PeopleSoft recommends using subpages to decrease the number of fields on a single page.

See Using Subpages.

Function and Data Processing Controls

Use function and data processing controls to provide a mechanism for running commands and to maintain levels of information on a page.

Using Charts

Use the Chart Properties dialog box to:

• Associate your chart with a record definition and record field.

• Assign a page field name.

• Set label attributes.

• Set the chart as a page anchor.

On the Label tab, add an information-only name for your chart. This label does not appear at runtime, but does appear on the control order list on the Order tab of the page definition and any page definition report that you print. Assigning a label is helpful if you have multiple charts on your page.

See Also

GetChart

Using Frames

Use the frame control to visually group a set of controls on a page.

To change frame labels and display options:

1. Double-click a frame to open the Frame Properties dialog box.

2. On the Label tab, enter a brief text description of the function of the controls in the frame.

   The default frame label is Frame. Any label that you attach to a frame is for information only—it doesn’t appear on your page, but it does appear on the page definition printout and in the control order list. Use labels to differentiate among multiple frames on your page.

   For example, if you’re enclosing address controls, you might use the label Address Frame.

3. Select the style for the frame.

   You can control the line color and thickness and background color of a frame by specifying a style.

   See Creating Style Sheet Definitions.

4. Select the Hide Border check box to hide the border of the frame.

   Use this option to use the style to shade only the background of the framed area or to apply other styles. If you select Hide Border, it overrides the border options that are specified in a style.

   A frame with a hidden border might also be used to facilitate HTML generation. When a frame is inserted in a page section, the system generates that section as a table in HTML. This is useful to ensure the correct layout. However, in some browsers, adding more HTML tables can result in performance degradation.

   See Improving Online Performance.

5. Select the Adjust Layout for Hidden Fields check box to enable automatic vertical adjustments to the frame size when hidden fields are present.

   If visible fields are not present to the right or left of the hidden field in a frame, the frame collapses to surround the remaining fields.

6. If the field is associated with multicurrency processing, select the Multi-Currency Field option on the Use tab in the Frame Properties dialog box.

   This causes the field to appear at runtime only if the Multi-Currency option on the PeopleTools Options page is selected.

Using Group Boxes

This section discusses how to:

• Insert and move a group box.

• Set group box properties.

Inserting and Moving a Group Box

To insert and move a group box:

1. Select Insert, Group Box.

2. Position the mouse where you want the initial location of the group box and click.

3. Move the group box to the appropriate location by clicking and dragging.

4. Adjust the group box size and shape using the "handles" on the edge of the group box.

5. Remove cursor focus from the group box by clicking anywhere outside of the group box on your page workspace.

Setting Group Box Properties

Associate your group box with a record definition and record field to easily distinguish it from other group boxes on your page in the Order tab.

To link group boxes to record definitions:

1. Open the Group Box Properties dialog box.

2. On the Record tab, select record and field names.

   Linking a record field with your group box enables you to control hiding and unhiding of the group box.

Changing the Group Box Label

The label of your group box should reflect how the fields are related. However, if for visual reasons, the group box surrounds a variety of disparate controls, you might change the label, rather than associate it with one record definition and field.

To change the group box label:

1. Open the Group Box Properties dialog box.

2. Select the Label tab.

   If you are organizing a group of radio buttons with translate values, you can label your group box by associating it with the record definition and field and selecting either the long or short name as the label. If neither the long or short name is appropriate, create a text label.

   Group box labels are limited to 50 characters regardless of whether the label is static text or retrieved from the Message Catalog.

3. In the Display Options region of the Label tab, select the body style for the group box border.

   You can control the color, line thickness, and background of the body section of a group box by specifying a style.

   See Creating Style Sheet Definitions.

4. Select the Hide Border check box to hide the border.

   This overrides border options that are specified in a style.

5. Select Adjust Layout for Hidden Fields.

   If there are hidden fields, the group box adjusts its borders to accommodate them if this feature is selected.

   Note. For the group box to adjust automatically, the hidden fields inside the group box must be surrounded by open space or have other hidden fields to the right or left.

6. Set the remaining group box label properties.

   See Setting Label Properties.

Setting Group Box Use Properties

Access the Group Box Properties dialog box. Select the Use tab.

Example of Collapsible Group Boxes

In the following example, the first group box, Spain, is expanded while the group boxes for France, Italy, and USA are collapsed.

Using Horizontal Rules

This section discusses how to:

• Draw a horizontal rule.

• Set horizontal rule properties.

Drawing a Horizontal Rule

To draw a horizontal rule:

1. Select Insert, Horizontal Rule.

2. Draw a horizontal line to the appropriate length on the page.

Setting Horizontal Rule Properties

This section discusses how to apply informational labels to a horizontal rule and configure how the horizontal rule is used on a page.

Setting Horizontal Rule Label Properties

To set horizontal rule label properties:

1. Open the Horizontal Rule Properties dialog box.

2. On the Label tab, enter an information-only label to differentiate the line from other frames and lines on your field order list.

3. Select the style for the line.

   You can control the color and line thickness of a horizontal rule by specifying a style.

   See Creating Style Sheet Definitions.

Setting Horizontal Rule Use Properties

Access the Horizontal Rule Properties dialog box. Select the Use tab.

Using Images

This section discusses how to:

• Adjust static image size and shape.

• Set static image properties.

• Set image properties.

Understanding Static Images

A static image is different from an image because it:

• Does not change at runtime.

• Is not associated with a record field.

Static images are associated with a predefined image definition. For example, you might select a static image, such as a yellow Clear button, from the image catalog and place it on top of a push button control so that the user knows to click that button to clear the contents of the page.

Adjusting Static Image Size and Shape

You can adjust the size of a static image by dragging the "handles" on the edge of the image box , or you can adjust the size in the Static Image Properties dialog box on the Label tab by changing the width and height in pixels.

Setting Static Image Properties

To associate a static image with an image definition:

1. Open the Static Image Properties dialog box.

2. On the Label tab, select the label type.

3. If you select Text, enter a label to identify your static image.

   The label does not appear on your page at runtime. Use it to track your images in your scroll order list box and on page definition reports.

4. Select an image ID using one of the following methods:

   • Select a predefined image definition from the Image ID drop-down list box.

   • Click the Browse button next to Image ID to preview the list of available images.

     The Select Image dialog box appears with a list of the image components available. To the right of the list is a preview of the selected image.

5. Click OK to return to the Static Image Properties dialog box.

   The image that you selected appears in the image area with its width and height displayed in pixels.

6. Set the format and size attributes for the image.

   Scale	Select to scale the image to the size of the frame that you set using the control selection handles or by the width and height that you enter. The scaling occurs when you view the page in a browser.
   Size	Select to display the image as is, regardless of the control size on the page.

7. Click OK.

   You can now position the static image anywhere on the page.

Note. You can define your own static images, such as your company logo, by creating a new image definition. After you create the image definition, you can then add your logo to a page using a static image control.

See Creating Image Definitions.

Setting Image Properties

To associate a record definition with an image:

1. Open the Image Properties dialog box.

2. On the Record tab, select the record and field names with which this image field is associated.

3. Set the image format and size attributes.

   Scale	Select to scale the image to the size of the frame that you set using the control selection handles or by the width and height that you enter. The scaling occurs when you view the page in a browser.
   Size	Select to display the image as is, regardless of the control size on the page.

4. Specify the alignment of your image.

5. Select a style for the image.

Setting Image Label Properties

Be sure to assign an informational label to your image. This is especially important if your application works with screen reader software.

To document an image control with an informational label:

1. Enter a text description in the Alt tag for image region.

2. Select one of the following settings from the Type drop-down list box:

   None	Select if you do not want a label. The Text field becomes unavailable for entry.
   Text	Select to enter a custom label. This is the default setting.
   Message Catalog	Select to use a preset message from the message catalog. The Message Set and Msg Number (message number) fields become available for entry.
   RFT Long (record field table long) and RFT Short (record field table short)	Select to use a preset label from the record field set on the Record tab. The Label ID drop-down list box becomes available for entry.

Setting Image Use Properties

The Use tab of the Image Properties dialog is the same as for that of an edit box.

See Setting Use Properties.

Using Static Text

Access the Static Text Properties dialog box.

Label Text

Style

You can control the color, font, size, and other characteristics of the text by specifying a style.

See Creating Style Sheet Definitions.

Alignment

Set the horizontal alignment of your text control, as determined by the left-hand edge of the field. You can align controls to the left-of-center, centered, or to the right-of-center.

Use Tab

If a text item is associated with multicurrency processing, select the Multi-Currency Field option. This causes the text item to appear at runtime only if the Multi-Currency option on the PeopleTools Options page is selected.

Using Check Boxes

When you insert a check box on a page, it appears with a default label, Dummy Name, until you specify a record definition name and field name, or a text label.

Setting Check Box Properties

Define the check box control by assigning the appropriate properties.

Setting Check Box Record Properties

To link check boxes with associated record definitions:

1. Open the Check Box Properties dialog box.

2. On the Record tab, select the record and field names from the drop-down list boxes.

3. Enter the enabled and disabled values for the check box.

   For example, if the enabled value of the check box is Y for yes, and the check box is selected when the user saves the row, the Y value is written to the database. If the disabled value of the check box is N for no, and the check box is cleared when the user saves, the N value is written to the database.

   The enabled and disabled values that you enter validate against the Translate table. If a value isn’t found, the system displays a warning message but allows the value to remain. You might find this useful when prototyping pages before defining record definitions.

Setting Check Box Label and Use Properties

After you link the check box to a record definition and field, set the label properties. Otherwise, the default check box label is the field long name. Set how the check box will be used on the Use tab.

See Also

Setting Page Field Properties for Controls

Setting Use Properties

Using Drop-Down List Boxes

This section discusses how to:

• Set drop-down list box record properties.

• Set drop-down list box label and use properties.

Setting Drop-Down List Box Record Properties

To set drop-down list box record properties:

1. Open the Drop-Down List Box Properties dialog box.

2. On the Record tab, associate the drop-down list box with a record and field.

3. Select a style.

   Set the font and color attributes of your drop-down list box data.

   See Creating Style Sheet Definitions.

4. Select a displayed text option:

   • Xlat Short.

   • Xlat Long.

   • Prompt Table Field.

5. If you selected Prompt Table Field, enter the field name in the Prompt Table Field area.

6. Set the field size for the drop-down list box.

Setting Drop-Down List Box Label and Use Properties

You can set the label and use properties for a drop-down list box.

See Also

Setting Label Properties

Setting Use Properties

Using Radio Buttons

This section provides an overview of radio buttons and discusses how to:

• Set radio button record properties.

• Set radio button label properties.

• Set radio button use properties.

Understanding Radio Buttons

When you insert a radio button on a page, it appears with the default label, Dummy Name, until you specify a record definition name, field, and value for the radio button. Like edit box labels, radio button labels have a dotted box around the 25 percent of extra space that is required for translation purposes in addition to the box around the radio button label itself.

For radio buttons to function as a single group, they must be associated with the same record field and they must be adjacent fields on the Order tab of the page definition. To save time, add all radio buttons in a set, one after the other. After you add the first radio button, the system remembers the record definition name and field name for all subsequent radio buttons—you must enter only the database value for each. Then, place a group box around all of your radio buttons to keep them together and labeled as in this example:

Radio buttons

Setting Radio Button Record Properties

To link a record with radio buttons:

1. Open the Radio Button Properties dialog box.

2. On the Record tab, select the record and field name.

   The system retrieves the default label text if you enter the record or field.

3. Enter the database translate value for this radio button.

   In the preceding radio button example, N is for Normal. If you select the drop-down list box for the value, you see the translate value and the long name that was assigned to the field. When the user selects this radio button, it indicates a Normal value.

Setting Radio Button Label Properties

To set the label of a radio button:

1. Open the Radio Button Properties dialog box.

2. On the Label tab, select the type of label if it is other than the default of XLAT Long.

3. Select the location of the label for your radio button: to the left or right.

   See Setting Label Properties.

Setting Radio Button Use Properties

You might want to change the way that a radio button is used on a page. For example, you might want the selected value of a radio button to control what appears in another control.

See Setting Use Properties.

Using Edit Boxes and Long Edit Boxes

This section provides an overview of edit boxes and long edit boxes.

Understanding Edit Boxes and Long Edit Boxes

When you insert edit boxes and long edit boxes on a page, they appear with the default label, Dummy Name, until you specify a record and field for them or until you specify a text type field label. There is more space than required between the edit box label and the control. Application Designer provides 25 percent extra space for the edit box label for translation purposes.

You control source data, labels, and how the control is used in the respective edit box and long edit box properties dialog boxes in PeopleSoft Application Designer. The settings for these two controls are mostly the same.

Note. Long edit boxes do not limit the number of characters that a user can enter in the browser, regardless of any limits defined in the underlying record field. As such, characters entered by the user that exceed the field definition’s field length may be truncated. For example, if you enter 012345678901234 into a long edit box associated with a field with a field length of 10, input would be truncated and saved to the database as 0123456789. The system treats carriage returns (ASCII=13) and line feeds (ASCII=10) the same as any other character.

Note. When using these controls on pages, application users will see ?<![CDATA*? in place of ?<![CDATA[? and in ?*]>? place of ?]]>? when xml, that contains CDATA sections,  is displayed in a page at runtime.

Mouse Over Popup Edit Boxes

Some edit boxes should display additional information than that which appears on the main page. You can create mouse over popup pages to appear when you hover your mouse over any edit box that is popup enabled. You can identify edit boxes with mouse over popup pages associated with them because these edit boxes are both display-only and they appear with a dashed line beneath the control.

You can configure edit boxes to display popup pages at runtime by configuring properties on the Use tab at design time.

Display-Only Edit Boxes

Some edit boxes should be display-only. You might want a page field to govern what is displayed in another control. In some cases, you might want the page control to be invisible because it is required by PeopleCode, but is not a field that is accessible by a user.

If you designate the long edit box as display-only, select the Expand Field When Display Only check box to hide the scroll and automatically expand the size of the edit box as necessary to display large amounts of text in the field.

You can configure controls to be display-only runtime by configuring properties on the Use tab at design time.

Rich Text Long Edit Boxes

Some long edit boxes should display rich text format (RTF). RTF is a format type that enables cross-platform document interchange. Any field that is rich text enabled appears at runtime with rows of text formatting tool bars, which enable you to indicate formatting information in the text such as font; font size; font characteristics, such as bold and italic; margins; and so on.

You can configure long edit boxes to display rich text at runtime by configuring properties on the Options tab at design time.

See Also

Setting Use Properties

Understanding Popup Pages

DisplayOnly

Using Popup Pages

This section provides an overview of popup pages and discusses how to:

• Design context-sensitive popup pages.

• Define popup pages.

• Associate popup pages with fields.

• Enable Message Catalog popup pages.

• Add variables to messages to embed context-sensitive help.

Understanding Popup Pages

You can use popup pages to display expanded context-sensitive information when the main page displays only limited information. For example, you can create a Employee Details popup page to display the employee ID, name, department, current job assignment, phone number, and email address of employees. You can then configure any employee-related main page to display the Employee Details popup page. When you hover over the mouse over field, the popup page appears displaying the appropriate context-sensitive information for the employee that is shown on the main page.

Popup pages look and behave differently from standard pages. For example:

• You access popup pages through the primary page only.

• You can insert a certain subset of page controls only.

• All fields on popup pages must be display-only.

• All fields on popup pages are at level zero.

• Popup pages appear when you mouse over any display-only edit box or hyperlink with which you associate them.

• All PeopleCode should be placed in the Page Activate event or on work records associated with the popup page.

  Note. PeopleCode that you write in the RowInit event will not run for any views that you use on popup pages.

Designing Context-Sensitive Popup Pages

For the popup page to retrieve the correct values, the lowest level key field on a popup page looks to the entire component panel buffer to find a field of the same name. These fields do not have to reference the same record and only the lowest level key must be present physically on the parent page. When a field of the same name is found, its value passes to record on the popup page. The popup page uses this value as the key value for the record field, retrieves the correct row from the record referenced by the field on the popup page, and displays the value in the correct page fields.

Consider this example, you have a User Details page that displays an employee's name, photo, department, phone, addresses, and web site URL that appears when you hover over the Employee ID field. This is the popup page:

All of the fields on the popup page reference the QE_EMPL_POPUP_VW record. On this record, make the EMPLID field the only key on this view. At runtime, the QE_EMPL_POPUP_VW view uses the EMPLID field to find the value on the main component, and then selects using this value from QE_EMPL_POPUP_VW to populate all the values on the popup page.

The SQL WHERE clause that retrieves the correct values would be WHERE EMPLID = '25000' where 25000 is the value of EMPLID in the parent component.

Identifying Popup Page Controls

You may insert these controls only on a popup page:

• Frames.

• Group boxes.

• Horizontal rules.

• Static text.

• Static images.

• Check boxes.

• Drop-down list boxes.

• Edit boxes.

• Images.

• Long edit boxes.

• Push Button/Hyperlinks.

• Radio buttons.

• Charts.

Note. These controls are automatically set as display-only at runtime even if you do not set the Display-Only property on the control.

Using Push Buttons and Links on Popup Pages

You may use only these destination type values on a popup page:

Note. Do not use other destination types for push button/hyperlink controls on popup pages. Unexpected results will occur.

• External link.

• Instant messaging action.

• Internal link.

• PeopleCode command.

• Process.

• Secondary page.

   

Defining Popup Pages

Determine which data in the primary page is appropriate for popup information. Typically, this is supplemental information or information that you might accessed from more than one main page.

Note. When planning popup page design, plan for versatility and reusability.

To define popup pages:

1. Select File, New and select Page from the New Definition dialog box.

2. Insert the record fields on the popup page.

3. Right-click the page and select Page Properties to open the Page Properties dialog box.

4. Select the Use tab.

5. Select Popup Page from the drop-down list box in the Page Type group box.

6. Select the page size:

   Auto-Size	Select to size the page automatically to fit the fields that are defined on it.
   Custom Size	Select to size the popup page by dragging the edge or by entering the width and height in pixels.

7. (Optional) Select Adjust Layout for Hidden Fields.

8. Click OK and save your popup page.

   If you selected Auto-Size, the system sizes the page automatically to fit the fields that are defined on it when you save.

Associating Popup Pages with Fields

To associate popup pages with fields:

1. Select File, Open and select the parent page.

2. Select Insert, Edit Box or Insert Push button/Hyperlink..

   Note. Popup pages can only be associated with display-only edit box and push button/hyperlink controls.

3. Double-click the control.

4. Select the Use tab.

5. Select the Display Only check box.

6. In the Mouse Over Popup group box, select the Page Popup option.

7. Select the name of the popup page from the drop-down list box.

   Note. Only popup pages appear in the drop-down list.

8. Click the OK button.

9. Save the page.

Note. If page controls are placed too close together on a page, the dashed line, which indicates an associated mouse over popup page, might not appear beneath the control.

Enabling Message Catalog Popup Pages

You can enable Message Catalog Popup pages to embed context sensitive help on any PeopleSoft page. This section discusses how to:

• Enable message catalog popup pages.

• Embed context-sensitive PeopleBooks help in popup pages.

Enabling Message Catalog Popup Pages

To enable message catalog popup pages:

1. Double-click the field that accesses the popup page.

2. Select the Use tab.

3. Select the Display-Only check box.

   Note. You must select Display-Only.

4. Select the Enable Mouse Over Popup.

5. Select the Message Catalog Popup check box.

6. Enter the Message Set and Message Number of the of the message whose Message Test and Explain strings appear in the Message Catalog Popup page.

7. Click the OK button.

Note. You can also enable Message Catalog mouse over popup pages by using PeopleCode.

Embedding Context-Sensitive PeopleBooks Help in Popup Pages

You can add variables to a message to make a Message Catalog popup page context-sensitive to the PeopleBooks Online Library.

Note. You must correctly configure and implement PeopleBooks.

See About These PeopleBooks, Managing the PeopleSoft Online Library and PeopleBooks, Integrating Context Sensitivity.

To add variables to messages to embed context-sensitive help:

1. Access the Message Catalog. ( PeopleTools, Utilities, Administration, Message Catalog to access the Message Catalog).

2. Select an existing or create a new message.

3. Enter an explanation and place the variable in the Explanation field.

   Note. The text in the Message Text field appears as the popup page header. The text in the Explanation field appears in the popup page body.

4. Enable the popup page on the desired edit box control.

   See Defining Popup Pages.

This table describes the variables and arguments necessary to create context-sensitive help using Message Catalog popup pages:

%PBCTXT()

%PBCTXT(sn,mn)

%PBCTXT(CTXT_PG_NM)

%PBCTXT(CTXT_PG_NM, sn,mn)

%PBURLTBL(<URL_IDENTIFIER>, sn,mn)

%PBLNK(http://www.anysite.com, sn,mn)

Example

In this example, the %PBCTXT variable uses QRY_ADMIN as a CONTEXT_ID that references the Query Administration page in PeopleBooks.

The 4, 7 part refers to Message Catalog entry (4,7), that contains the label to use for the generated link.

On the Web Profile Configuration page at runtime, mouse over the chosen control to see the generated popup page:

Notice that the popup text comes from Message Catalog entry (4,6) and the link label, Query Administration, defined by the %PBCTXT(QRY_ADMIN, 4, 7) variable comes from Message Catalog entry (4,7). Click on the Query Administration link, and the system accesses the PeopleBooks entry for the QRY_ADMIN CONTEXT_ID using that Help URL entry to ascertain the PeopleBooks location on the web server.

Note. You define the location of your online PeopleBooks by entering a URL in the Help URL field that is located on the Web Profile - General page (PeopleTools, Web Profile, Web Profile Configuration).

See Configuring General Portal Properties.

Using Subpages

This section provides an overview of subpages and discusses how to:

• Define a subpage.

• Insert a subpage on a page.

• Specify informational subpage labels.

Understanding Subpages

Subpages are a powerful means of factoring out commonly used page functionality in your application. Rather than duplicating the same set of page fields on two or more pages, you can create a single subpage that contains those page fields and add it to any page. This makes it much easier to maintain the functionality that these page fields represent.

Subpages are even more effective when used with corresponding subrecords. In order to support the use of subrecords with subpages, the system uses a record name substitution mechanism for subpage-type page fields. Each subpage has a "from" record, determined dynamically by the page definition in PeopleSoft Application Designer and by the PeopleSoft Pure Internet Architecture. The "from" record is a record associated with one of the page fields in the subpage. Which page field depends upon the page field ordering, the types of page fields on the subpage, and whether it's record is a subrecord. The subpage itself must be fully expanded in order to make this determination. (This is important to keep in mind when working with subpages that contain other subpages.)

The "to" record is specified by you in the SubPage Record Name Substitution group box in the Insert Subpage dialog box that displays after you insert the subpage into a page (and on the Subpage tab of the Subpage Properties dialog). At runtime, when a subpage-type page field is expanded, each page field that is associated with the dynamically determined "from" record is instead associated with the "to" record you specify. This means, for example, that a subpage can be populated with page fields that are associated with a subrecord so that the subrecord is determined to be the "from" record. Then when that subpage is used as a subpage-type page field, you can specify the "to" record as one of the records that contains that subrecord. This enables you to associate a single set of page fields (through the subpage) with a variety of different records (each containing the subrecord).

Defining a Subpage

Creating a subpage is just like creating a brand new page definition. The difference is that you define it as a subpage rather than a standard page in the Page Properties dialog box.

To define a subpage:

1. Select File, New, Page.

2. Insert the record fields on the page.

   See Adding Page Controls.

3. Select File, Definition Properties to access the Page Properties dialog box.

   Use this dialog box to define the type, size, and layout of the page.

4. Select SubPage in the Page Type drop-down list box.

5. Select the size of the page.

   See Changing Page Use Information.

6. Select Adjust Layout for Hidden Fields if necessary.

7. Select Allow Deferred Processing if appropriate.

   See Understanding Processing Modes.

Inserting a Subpage Into a Page

After you create the subpage definition, insert a subpage control on your primary page and associate it with the subpage definition.

To insert a subpage into a page:

1. Open the page on which you want to insert the subpage.

2. Select Insert, SubPage.

   The Insert Subpage dialog box appears.

3. Select a subpage definition.

   Specify the name of the subpage that you want to insert into the open page definition.

4. Select a record definition in the SubPage Record Name Substitution group box.

   The subpage writes its fields to a generic record. Specify the application-specific record name to which you want the information in the subpage written.

   See Using Subpages.

   Note. All of the fields in a subpage must be associated with fields of a subrecord in the specified record definition.

5. Click OK.

   The subpage appears on the page. Its size reflects the size of the page control group, and it is identified by the subpage definition name. During design time, the fields within the subpage are not visible. At runtime, pages containing subpages are dynamically expanded. Be sure to leave a few pixels of space between the left edge of the main page and the subpage page field to ensure sufficient padding at runtime.

When saving a page with multiple subpages, be aware that you may receive a warning message if duplicate fields are present.

Inserting a Subpage Into a Grid

You can insert a subpage into a grid as you would any other column.

See Inserting and Manipulating Grid Columns.

Specifying Informational Subpage Labels

Document the purpose of the subpage by changing the informational label of the subpage. The default subpage label is Subpage. Any label that you attach to a subpage is for information only—it doesn’t appear on the page, but it does appear on the page definition printout and in the control order list. Use labels to differentiate among multiple subpages on a page.

To change informational subpage labels:

1. Open the Subpage Properties dialog box.

   Note that the Subpage tab displays the information that you entered on the Insert Subpage dialog box.

2. On the Label tab, enter your informational text label.

3. Enter the page field name in the General tab.

4. (Optional) Select Enable as Page Anchor if you want the subpage to serve as a jump destination on the page.

5. Click OK.

Using Secondary Pages

This section provides an overview of secondary pages and discusses how to:

• Define secondary pages.

• Insert a secondary page control.

Understanding Secondary Pages

While a secondary page is just another page to the user at runtime, they look and behave differently than the primary pages. For example:

• You can view a secondary page from its primary page only.

• A secondary page should have OK and Cancel buttons so that the user can dismiss the page (accepting or canceling input) and return to the primary page.

  To offer the user alternative buttons to dismiss the page, disable the default OK and Cancel buttons in the Page Properties dialog box.

Secondary Page or a Push Button?

There are two ways to associate a secondary page with a primary page:

• Insert a push button or link and associate it with your secondary page.

  This automatically displays the secondary page when the user presses the button or clicks the link and is the preferred method. Use this method when:

  • No procedural PeopleCode logic is necessary before the secondary page is displayed (PeopleCode can be used on the secondary page just like any other page).

  • You want to control the formatting of the information (therefore you want to use a page, and not use the Prompt function).

  • The secondary page is used more than once.

• Insert a secondary page control.

  This control looks like a command push button, but it is invisible at runtime. When you use a secondary page control, you must also insert a command push button on the page and call the DoModal PeopleCode function from the FieldChange event for the push button to display the secondary page.

Example

In the following example, the Address page contains an Email link at the bottom of the scroll area. This link opens the Email Addresses page, enabling the user to enter email address information.

Primary page

Secondary page

After the user enters the email information in the Email grid, the user can return to the Address page by clicking OK.

Defining Secondary Pages

Determine which data in the primary component is appropriate for a secondary page. Typically, this is supplemental information or information that is accessed from more than one main page.

To create a secondary page:

1. Select File, New and select Page from the New Definition dialog box.

2. Open the Page Properties dialog box.

3. Select the Use tab.

4. Select Secondary Page from the drop-down list box in the Page Type group box.

5. Select the page size:

   Auto-Size	Select to size the page automatically to fit the fields that are defined on it.
   Custom Size	Select to size the secondary page by dragging the edge or by entering the width and height in pixels.

6. Select the page style sheet to associate with the secondary page.

   To override the default style sheet that is associated with the application, select a different style sheet from the drop-down list box. The style sheet that you select is available only for the controls on the secondary page.

7. Select the page background.

   You can control the background of the page and any controls that don't have a style sheet associated with them by specifying a style in the page background.

8. (Optional) Select Adjust Layout for Hidden Fields.

9. (Optional) Clear Allow Deferred Processing if you want processing to occur each time the user presses Tab to move through a field.

10. Click OK and save your secondary page.

    If you selected Auto-Size, the system sizes the page automatically to fit the fields that are defined on it when you save.

Inserting a Secondary Page Control

After you define the secondary page, you can place a secondary page control on your primary page and associate it with the secondary page you just created.

To insert a secondary page control on a primary page:

1. Select Insert, Secondary Page.

2. Click the primary page where you want to display the secondary page control.

   The secondary page control appears like a small push button with the secondary page icon on it. This control is invisible at runtime.

3. Double-click the control to access the Secondary Page Properties dialog box: Secondary Page tab.

4. Select the name of the secondary page to associate with the secondary page control on the active page.

   Only secondary pages can be associated with secondary page controls. You cannot associate a standard page or subpage with the secondary page control.

5. Select the Label tab.

   This label is for informational purposes only. It appears in the Order tab of the page definition and in the page description printout.

6. Position the secondary page control at the proper scroll level on the Order tab.

   See Specifying Type Properties for Push Buttons or Links.

Using HTML Areas

This section provides an overview of HTML area controls and discusses how to:

• Insert an HTML area.

• Populate an HTML area.

• Change an HTML area label.

Understanding HTML Area Controls

You can insert an HTML area control on any PeopleSoft page. It can be inserted at any level on a page and can even be placed in a grid control. This control is rectangular and can be resized easily.

Populate the HTML area control in one of these ways:

• Statically, in the page field property sheet.

• Dynamically, by associating the control with a record field or HTML definition.

If the control is linked to a record field, the value of the record field is displayed in the HTML area. Use PeopleCode to associate the HTML area control with a predefined HTML definition.

When using HTML areas, consider:

• HTML areas are downloaded to Excel as a non-breaking space (&nbsp).

• HTML areas are not searched with the Find feature.

Generating Trees in HTML Areas

You can use the GenerateTree PeopleCode function with HTML areas. This example shows the tree that is created by the GenerateTree PeopleCode function next to a grid in a frame:

Populating an HTML Area

You can populate an HTML area either statically, using the HTML Area Properties dialog box, or dynamically, by associating the control with a record field. Because the HTML that you write is included in the HTML that is dynamically generated by the system at runtime, consider the following:

• The HTML that you include can affect the layout of the page.

  Being true to the design-time sizing of the HTML area is the best way to ensure that you do not affect the layout of the other page field controls. Adding an invisible frame around the HTML area control can help ensure that you don't affect other page fields.

• You can use only certain types of HTML tags. These tags are not supported by the HTML area control:

  • <body>

  • <frame>

  • <frameset>

  • <form>

  • <head>

  • <html>

  • <meta>

  • <title>

Using JavaScript in HTML Areas

If an HTML area contains a reference to third party JavaScript, you need to include the absolutized attribute in the script tag and set it to"false". For example,

<script type="text/javascript" language="javascript" absolutized="false"  ⇒
src="../../../../../ps/spellcheck/lf/spch.js"></script>

Using HTML Areas in AJAX Mode

Note the following code restrictions in HTML areas when running the application in AJAX mode:

• Do not include XML tags, such as CDATA.

• Do not include empty or commented out <script> elements.

• Do not include document.write as part of the HTML in an HTML area.

See Also

Using the GenerateTree Function

Inserting an HTML Area

To insert an HTML area on a page:

1. Select Insert, HTML Area.

2. Draw the HTML area on your page.

3. Move the HTML area control by dragging it with the mouse or by pressing the arrow keys.

Populating an HTML Area

This section discusses how to:

• Populate an HTML area statically.

• Populate an HTML area dynamically.

Populating an HTML Area Statically

Use the HTML Area Properties dialog box to populate an HTML area.

To populate an HTML area statically:

1. Access the HTML Area Properties dialog box.

2. On the HTML tab, select Constant as the value type.

3. In the long edit box, enter the HTML code that you want to display in the HTML area.

Populating an HTML Area Dynamically

To populate an HTML area dynamically:

1. Access the HTML Area Properties dialog box.

2. On the HTML tab, select Field as the value type.

3. Specify the record and field to which you want to associate the HTML area control.

   The value of the record field generates the HTML code that is included at runtime in the HTML area.

   Note. When you associate an HTML area control with a field, make sure that the field is long enough to contain the data that you want to pass to it. For example, if you associate an HTML area control with a field that is only 10 characters long, only the first 10 characters of your text are displayed. PeopleSoft recommends using long character fields for record fields that are associated with an HTML area control.

Changing an HTML Area Label

Assign a distinct label to your HTML area to distinguish it from other HTML area controls on the Order tab of the page.

To change an HTML area label:

1. Access the HTML Area Properties dialog box.

2. Select the Label tab.

3. Enter a brief text description of the HTML area.

   This label does not display at runtime; however, it appears on the Order tab of the page definition.

Using Push Buttons and Links

This section provides an overview of push buttons and links and discusses how to:

• Insert push buttons or links.

• Specify type properties for push buttons or links.

• Specify use properties for push buttons or links.

• Specify label properties for push button or link.

• Change hover text for the push button or link programmatically.

Understanding Push Buttons and Links

PeopleSoft Pure Internet Architecture supports these features for this control:

• Selecting link style.

• Selecting these types of push buttons and links:

  • External link.

  • Internal link.

  • Prompt action.

  • Scroll action.

  • Toolbar action.

• Selecting these image options:

  • On mouse over.

  • When disabled.

Inserting Push Buttons or Links

After you add a push button or link control to your page you can define the attributes by opening the Push Button/Hyperlink Properties dialog box.

To insert a push button or link:

1. Select Insert, Push Button/Hyperlink.

2. Click where you want the upper, left-hand corner of the control to begin.

   A push button of small image size appears.

3. Double-click the push button to access the Push Button/Hyperlink Properties dialog box.

4. On the Type tab, select whether the control appears as a push button or link.

5. Select a destination type from the Destination drop-down list box.

   See Specifying Type Properties for Push Buttons or Links.

6. Select the record and field names with which you want to associate the push button or link.

7. Select any of the remaining Type options:

   Enable When Page is Display Only	Select to make the push button or link available to users who have display-only access to this page. Display-only access is set per user and user class in Security.
   Open in New Window	Select to have the page that is displayed by the URL to appear in a new window, as opposed to replacing the existing window.
   Activate by Enter Key	Select to activate the push button or link when the user presses the Enter key. You can have more than one push button or link with this feature set per page, as long as only one of these fields is enabled at runtime. Otherwise, only one push button or link with this attribute enabled is allowed per page. This feature is available for all control types except external links. When using Activate by Enter Key in a scroll area or grid with an occurs count greater than one, the Enter key triggers the first row only. Note that on a secondary page with the standard OK and Cancel buttons enabled, the Enter key activates the OK button rather than a custom button or link.
   Set Component Changed	Select to enable the ComponentChanged built-in PeopleCode function when the user selects the push button or link. This issues a save warning if the user attempts to leave the page. This setting is cleared by default. See ComponentChanged.

Specifying Type Properties for Push Buttons or Links

Access the Push Button/Hyperlink Properties dialog box.

Type

Each destination type that you select enables a different region on the Type tab, enabling you to further define your push button or link. Select one of these values from the Destination drop-down list box:

External Link

In this group box, select Dynamic or Static, and enter the URL ID, if necessary. Select a value from the URL Maintenance table of a record field to define the destination. For example, a derived record field might be used to set the destination value dynamically at runtime. The value of the derived record field is placed in the HREF tag of the HTML.

See URL Maintenance.

Internal Link

Specifying Label Properties for Push Buttons or Links

This section discusses how to:

• Specify a text label.

• Specify an image label.

Specifying a Text Label for the Push Button or Link

To specify a text label for a push button or link:

1. Access the Push Button/Hyperlink Properties dialog box.

2. Select the Label tab.

3. In the Type group box select Text.

4. Select the size.

   There are three standard push button sizes, depending on what kind of text or image you want to display on the button face.

   Small Image	Creates toolbar-sized buttons that handle small 16 × 16 pixel images.
   Large Image	Handles 32 × 32 pixel images.
   Standard Text	Matches the Microsoft standard dimensions for text push buttons.
   Custom	Select if none of these sizes meets your needs. When you click OK, the push button displays selection handles that you can use to resize it.

5. Specify the type of label text.

   Depending on the destination type that you selected, the values in the Type drop-down list box differ.

   Message Catalog	Select to reference a message that exists in the message catalog. Enter the message set and number. Message catalog items are all translatable.
   RFT Short (record field table short)	Select to label the push button with the short name for the field from a record definition. RFT is an abbreviation of record field table, which stores attributes for fields in a record definition. Use this option only if you specified a record definition and field name on the Type tab in the Push Button/Hyperlink Properties dialog box. The RFT short name appears on the push button when you click OK and return to the page. Select the label ID if you do not want to use the default label if more than one label has been set for the record field.
   RFT Long (record field table long)	Select to label the push button with the long name for the field. Use this option only if you specified a record definition and field name on the Type tab in the Push Button/Hyperlink Properties dialog box. The RFT long name appears on the push button when you click OK and return to the page. Select a different label ID if you do not want the default label if more than one label has been set for the record field. The system uses the RFT long label as the tool tip at runtime for links if it is different from the assigned display value of the link and it is not null. If more than one label is stored for the record field you can select an alternate tool tip from the Label ID drop-down list box.
   Static Text	Select to enter the text to appear on the label.
   URL Description	Select if you selected External Link as the destination on the Type tab. Select the style from the drop-down list box. See Creating Style Sheet Definitions.

6. Select the alignment.

   This option is only available if you selected Hyperlink for the type on the Type tab. Push button text is automatically centered for controls that appear as push buttons. Push buttons with text and images are automatically center aligned when used in grids.

Note. Some browsers do not support custom push buttons.

See "Troubleshooting Browser Limitations" on Customer Connection.

Specifying an Image Label for a Push Button or Link

To specify an image label for your push button or link:

1. Access the Push Button/Hyperlink Properties dialog box.

2. Select the Label tab.

3. Select Image for the type.

4. Specify the size.

   If you select Custom, the Image/Format Size group box becomes available.

   Scale	Select to adjust the width and height as percentages.
   Size	Select to set the image size by altering the width and height in pixels.
   Reset to actual image size	Resizes the image according to its natural size. That is, the images size is not manipulated by custom width or height values.

5. Specify the image ID.

   Select one of the predefined image definitions or click the Browse button to view push button images.

   See Understanding Image Definitions.

6. In the Alt tag for image group box, specify the hover text type.

   Message Catalog	Select to reference a message that exists in the message catalog. Enter the message set and number. Message catalog items are all translatable.
   RFT Long (record field table long)	Select to use the long name of the record field as the hover text. Use this option only if you specified a record definition and field name on the Type tab in the Push Button/Hyperlink Properties dialog box. The system uses the RFT long label as the tool tip at runtime for links if it is different from the assigned display value of the link and it is not null. If more than one label is stored for the record field you can select alternate hover text from the Label ID drop-down list box.
   RFT Short	Select to use the short name of the field as the hover text. Use this option only if you specified a record definition and field name on the Type tab in the Push Button/Hyperlink Properties dialog box. If more than one label is stored for the record field you can select alternate hover text from the Label ID drop-down list box.
   Static Text	Select to enter the text to appear on the label.

7. (Optional) Select the image to appear on a mouse over.

   For example, you might want to highlight an image so that users can easily see which option they're selecting.

8. (Optional) Select an image to appear when the button is disabled.

Specify Use Properties for Push Buttons or Links

Access the Push Button/Hyperlink Properties dialog box. Click the Use tab.

Field Use Options

This table describes the Field Use options:

Grid Cell Alignment

Push buttons with images or text are center aligned automatically when in a grid. Otherwise, select Left, Centered, or Right.

Note. Grid Cell Alignment properties are only enabled when the push button field is in a grid and is configured as a text hyperlink.

Modal Window

The Modal Window options are available when you select a destination type of either PeopleCode command or Secondary page.

This table describes the Modal Window options:

Mouse Over Popup

Select the Display Only check box to enable the Mouse Over Popup options. Select from these mouse over popup options:

Note. Attempts to make a pushbutton/hyperlink editable at runtime when it has a mouse over popup page associated with it for example, using PeopleCode, will fail.

Changing Hover Text for the Push Button or Link Programmatically

Hover text or mouse over text enables you to display additional or supplemental information about the button or link. Under certain circumstances, you might want to vary the hover text based on the context of application data on the page.

You can alter hover text by using the PeopleCode HoverText Field property. This property sets the hover text for any buttons or links associated with the field. The maximum length of hover text is 100 characters. You can use the Message Catalog to store hover text.

Example of Changing Hover Text Programmatically

To set hover text for a push button or link at runtime, use PeopleCode to define the HoverText property for a field definition.

QE_ABSENCE_HIST.QE_ABSENCE_TYPE.HoverText = MsgGetText(95, 5037, "Personalize Layout");

Note. The HoverText field property is available for the Push button/Hyperlink page control only.