Open topic with navigation

TIBCO Business Studio™ - BPM Edition 5.4.0

# Members for Pane Class

The table below lists the members for the Pane class.

Note: These methods cannot be used to control panes that are inside of record or grid panes. Record and grid panes contain a list of values for the panes and controls that are inside of them, but the pane methods do not contain indexes to specify which pane or control to act upon. For example, the following cannot be used to control the visibility of a tabbed pane in a record pane:

    pane.Accounts_correspondence.visible = false;

However, a computation action can be used as a workaround. For the example shown above, create a computation action on the "Visible" property of the "correspondence" pane for the "Accounts" update event, and compute the value using the `context.record` property. For example:

    var correspVisible = true;
    if (context.record != null) {
    var genInfo = context.record.generalInformation;
    if (genInfo != null)
    { correspVisible = "PROXYHOLDER" != genInfo.selectType; }

    }
    correspVisible;

This will make the "correspondence" tab invisible when "PROXYHOLDER" is selected. The `context.record` will point to that record in the record pane relative to the instance where the value is computed.

Property | Return Value | Description | Read Only
--- | --- | --- | ---
    reallyEnabled
| Boolean | The enabled setting of a pane is controlled both by its own enabled property, and the enabled properties of any of its ancestors. If the parent pane of a pane is disabled, then `reallyEnabled` returns`false` for that control. The method returns `true` only if its own enabled property is `true` and all of its ancestor's enabled properties are set to `true`. | Y
    reallyReadOnly
| Boolean | The readOnly setting of a control is controlled both by its own readOnly property, and the readOnly properties of any of its ancestors. If the parent pane of a control is not read only, then `reallyReadOnly` returns `false` for that control. The method returns `true` everytime it's own readOnly property is true or any of its ancestor's readOnly property is `true`. . | Y
    reallyVisible
| Boolean | The visibility of a pane is controlled both by its own visibility property, and the visibility properties of any of its ancestors. If the parent pane of a pane is not visible, then `reallyVisible` returns `false` for that control. The method returns `true` only if it's own visibility property is `true` and all of its ancestor's visibility properties are set to `true`. | Y
    activeTab
| Pane | Returns the active child pane for a tabbed pane. |
    controls
| Control[] | Returns an array of controls that are direct children of this pane. | Y
    enabled
| Boolean | Retrieves the enabled flag for this pane. |
    form
| Form | Returns the form object to which this pane belongs. | Y
    label
| String | Retrieves the label for this pane. |
    name
| String | Returns the name of the pane. | Y
    panes
| Pane[] | Returns an array of panes that are direct children of this pane. | Y
    paneType
| String | Returns the pane type of this pane (for example,`"com.tibco.forms.panes.vertical"`). | Y
    parent
| Pane or Form | Returns the parent pane or form object to which this pane belongs. | Y
    readOnly
| Boolean | Returns the read-only state of this pane. |
    selection
| List or Object | Returns the object currently selected in the grid or record pane. If the grid supports multiple selections, then this is a list that contains the selected records. | Y
    selectedIndex
| Pane | Returns the index of the currently selected row of a single select grid pane or the index of the currently selected record of the record pane. If there is no selection, it returns -1 |
    value
| List or Object | For grid and record panes returns a list. Returns `null` or a complex object value for other pane types. | Y
    visible
| Boolean | Retrieves the visible flag for this pane. | Y

Method | Return Value | Description | Read Only
--- | --- | --- | ---
    addMessage(String message, String cssClasses, Control or Pane target, Integer row)
| String | Adds a message at the end of the message pane and returns a message identifier, which can be used to remove the message. The parameters are: `message`: is the message string that is added at the end of the message pane `cssClasses`: is the space-separated list of CSS classes to allow custom styling of the message. You need to add the `cssClasses` string to the element containing the message. `target`: is either a control or a pane to which the message is targeted. If specified, renders a message as a link, to allow users to navigate directly to the target of the message. If `null`, then the message is not rendered as a link. `row`: is the row of the list control or the control in a grid pane, to which the message is targeted. This is used only if a control is specified in the `target` parameter, and it is a list control or the control is in a grid pane. This is an optional parameter. If `null`, then the first element in the list control or grid pane column is targeted with a clickable message. If the target is a list control within a grid pane, then an array of length two needs to be specified. The first number in the array indicates the row of the control. The second value indicates the index of the value within the list control that receives the focus. |
    cancel()
| Void | Cancels the modal dialog pane and triggers a cancel event. |
    clearMessages()
| Void | Clears all messages added to the message pane using the `addMessage()` API. |
    close()
| Void | Closes the modal dialog pane and triggers a close event. |
    isOpen
| Boolean | Returns `True` if the modal dialog pane is open. | Y
    open()
| Void | Opens the modal dialog pane and triggers an open event. Throws an exception if the same or another modal dialog pane is already open on the form. |
    removeMessage(String messageId)
| Void | Removes a message previously added to the message pane using the `addMessage()`API. You might only remove the messages added using the `addMessage()` API. The `messageId` is an identifier used to specify which message needs to be removed. |
    setActiveTab(Pane childPane)
| Void | Sets the active child pane for a tabbed pane. The tab to be set as active tab is passed as `childPane` parameter to the method. The `childPane` parameter must be a direct child pane of the tabbed pane. |
    validate(Boolean updateMessagePane)
| Boolean | Forces validation to run on the pane and all child panes and controls. Returns `true` if all validations return `true`. If `updateMessagePane` is`true`, then validation messages are displayed in the messages pane for any validation that failed. If `updateMessagePane` is not specified, it is treated as `false` |

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO Business Studio™ - BPM Edition

Copyright © 2015-2023. Cloud Software Group, Inc. All Rights Reserved.