Handles screen panels.

The Panel extraction rule allows the grouping of a set of blocks within a panel. It creates a panel type element surrounding these blocks.
The extraction rule is based on remarkable character patterns in order to determine:

• the panel position,
• blocks being a part of it.

To determine the panel position, the rule can also use screen attributes. This is mostly the case for 5250 applications, where windows can be displayed with no border characters, but with colored borders.
Note: XML elements of the panel type are handled by the panel XSL template described in the panel.xsl file. To change the way panels are displayed in the HTML page, edit this file.

Property Type Category Description
Comment String configuration Describes the object comment to include in the documentation report.
This property generally contains an explanation about the object.
Is active boolean configuration Defines whether the extraction rule is active.
Is final boolean configuration Defines if the extraction is final, i.e. whether pending extraction rules should try to match on the current extraction rule matching blocks.

If set to true, once the rule applies on a matching block, Convertigo doesn’t apply the following rules on this block. This can be used to prevent a block from being modified by other rules.
Minimum number of sides int configuration Defines the minimum number of sides for a panel to be detected.
By default, the rule needs 4 sides for a panel to be detected. Sometimes, applications display text in borders (Window description for example). Borders might therefore not match exactly the rule parameters, so you can reduce the number of sides and still have the panel detected.
Panel bottom String configuration Defines the bottom character (zone 7, see "Panel zone description" table below).
Panel left String configuration Defines the left character (zone 4, see "Panel zone description" table below).
Panel lower left String configuration Defines the lower left character (zone 6, see "Panel zone description" table below).
Panel lower right String configuration Defines the lower right character (zone 8, see "Panel zone description" table below).
Panel right String configuration Defines the right character (zone 5, see "Panel zone description" table below).
Panel top String configuration Defines the top character (zone 2, see "Panel zone description" table below).
Panel upper left String configuration Defines the upper left character (zone 1, see "Panel zone description" table below).
Panel upper right String configuration Defines the upper right character (zone 3, see "Panel zone description" table below).
Remove blocks in borders boolean configuration If checked, all text blocks found in the panel border are deleted.
In some applications, windows are detected through their colored border, but there can be also text in borders. As a result, the webized screen is of poor quality. Set this parameter to true to remove text in borders.
Attributes int selection Defines the presentation attributes on which the rule applies, i.e. the rule applies on blocks matching these presentation attributes.
This property allows to configure the rule so that it applies only to parts of screens having specific attributes, for example green text on black background.
Presentation attributes to configure are :

Color: Foreground color, Background color, to choose in a list of predefined colors or “not to take into account”.
Decoration: bold, reverse, underlined, blink, for each decoration choose between “with the decoration”, “normal” (i.e. without the decoration), or “not to take into account”.
Screen zone XMLRectangle selection Defines the screen zone on which the rule applies, i.e. the rule applies on blocks completely contained in this screen area.
This property allows to configure the rule so that it applies only to areas of screens. All blocks found within the specified perimeter are matching this screen zone and can be processed by the rule.
The screen area is defined through four coordinates:

• x (area left corner),
• y (area upper corner),
• w (area width),
• h (area height).

All values are given in characters, with the upper left corner being (x=0, y=0).
-1 represents an undefined value: (x=-1, y=-1, w=-1, h=-1) is an undefined area representing the whole screen, i.e. all blocks, whatever their coordinates, are matching this screen zone and can be processed by the rule.
Title attribute int selection Defines the attributes of the title of the panel.
In some applications, a panel can contain a text in the border that corresponds to the window title. This property allows to configure the presentation attributes of this title to differentiate it from the rest of the panel border.
Presentation attributes to configure are :

Color: Foreground color, Background color, to choose in a list of predefined colors or “not to take into account”.
Decoration: bold, reverse, underlined, blink, for each decoration choose between “with the decoration”, “normal” (i.e. without the decoration), or “not to take into account”.
Type String selection Defines, using a regular expression, to which block types the rule applies.
For example, if set to:

static, the rule applies to blocks of static type only.
static | field, the rule applies to blocks of static or field type only.
[^field], the rule applies to all but field type blocks.

Notes:

• For more information about regular expression patterns, see the following page: http://www.regular-expressions.info/reference.html.
• To test regular expressions, you can use the regular expression tester at the following URL: http://www.regular-expressions.info/javascriptexample.html.