Language Reference Guide > Language Reference Guide > System Classes > FrameExec Class > PortletBlocking Attribute
Was this helpful?
PortletBlocking Attribute
Data Type: integer
4GL Access: RW1
Valid values are:
PB_GUESTFRAME
PB_HOSTFRAME
PB_GUESTFIELD
Default: PB_GUESTFRAME
A discussion of each value follows. Descriptions of system constant values and their numeric equivalents also are listed in PortletBlocking Settings.
An OpenROAD Portlet is a CompositeField in a frame (the HostFrame), that exposes child fields originating in another frame (the GuestFrame). The fields in a GuestFrame that are exposed in the HostFrame are called GuestFields.
The PortletBlocking attribute determines the HostFrame, GuestFrame, and GuestField blocking behavior that occurs after a callframe statement is issued from within a GuestFrame's script using the WITH PortletBlocking clause or the default behavior is set using the II_W4GL_PORTLETBLOCKING_DEFAULT environment variable.
Possible values include the following:
PB_GUESTFRAME
(Value = 0) Only the guest frame is blocked (default).
If the mouse pointer is over a non-GuestField in the HostFrame, the non-Guest Field activated events and scripts behave as usual. If the mouse pointer is over a GuestField in the HostFrame, the GuestField-activated events and scripts are deferred until after the blocking frame is closed.
PB_HOSTFRAME
(Value = 1) The HostFrame and GuestFrame are blocked and shielded.
If the mouse pointer is over any field in HostFrame (both GuestFields and non-GuestFields, the fields are blocked (disabled) and shielded (the wait cursor is displayed). The GuestFrame is also blocked and shielded.
PB_GUESTFIELD
(Value = 2) The GuestField becomes inactive (disabled) and shielded (a "wait" cuis displayed when the mouse pointer is over them).
The GuestFrame is blocked and shielded. The HostFrame and its fields (except the GuestFields) are not blocked or shielded.
The value is used only when the frame is first started using the 4GL callframe statement. Changing the PortletBlocking attribute in an active FrameExec (one that was activated using a callframe) has no effect.
The PortletBlocking attribute setting does not affect the blocking behavior of frames that are started using the openframe or gotoframe statements, as these invocation methods adhere to the standard existing OpenROAD frame blocking behavior that is well documented.
By default the behavior for all callframe statements issued from within a GuestFrame script is PB_GUESTFRAME. You can override this default by setting the II_W4GL_PORTLETBLOCKING_DEFAULT environment variable. For more information, see the Workbench User Guide.
Last modified date: 12/20/2023