Declarative UI reference

45 minute read

Declarative XML is a user interface markup language defining UI elements and bindings that allows you to quickly create dialogs within Policy Studio with minimal coding.

The defined elements map to Eclipse Standard Widget Toolkit (SWT) widgets and Axway ScreenAttributes (groups of SWT widgets backed by entity instances).

This topic describes in detail the UI elements and bindings.

ActorAttribute

The ActorAttribute tag renders an SWT Combo widget with an optional Label. The combo box is populated with the following entry: “Current Actor/Role only”. This is the default value for SOAP requests that contain a WS-Security block, and do not contain a SOAP Actor/Role attribute. An additional value can be entered if a WS_Security block with a specific Actor/Role is contained in the SOAP message.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span; 

Sample XML\

<ui>
   <panel indent="15" margin="0">
     <ActorAttribute label="ACTOR_LABEL" field="actor" required="true" />
   </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

AgeAttribute

The AgeAttribute tag renders an SWT Label (optional), Text and Combo widgets, allowing you to specify a numeric age value, and select one of the following age types:

• Seconds
• Minutes
• Hours
• Days

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
  <panel columns="3" margin="0">
    <AgeAttribute field="maxAge" label="AGE_LABEL" required="true"/>
  </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

AuthNRepositoryAttribute

The AuthNRepositoryAttribute tag renders an SWT Combo widget with an optional Label.

Authentication repositories are grouped into different types and each type of authentication repository has an associated group of filter types they are compatible with. For example, “Local Repositories” instances are compatible with the following filter types:

• HttpBasicFilter
• HttpDigestFilter
• WsBasicFilter
• WsDigestFilter
• WsUsernameFilter
• AttributeAuthnFilter
• FormAuthnFilter

The Combo widget is then populated with this list of instances that are compatible with this filter type.

Sample XML\

<ui>
 <panel columns="2">
  <AuthNRepositoryAttribute label="REPOSITORY_LABEL" field="repository"
   filterType="FormAuthnFilter" refName="name" required="true"/>
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

binding

The binding tag allows you to create a binding between various widgets.

Sample XML\

The binding below specifies a binding between a and two attributes. The binding is controlled in the Enabler class.

<ui>
 <ButtonAttribute field="sortFiles" label="SORT_FILES_LABEL"/>
 <panel columns="2" margin="0">
  <panel label="SORT_TYPE_LABEL" margin="0,0,0,7">
   <ComboAttribute field="sortType"  contentSource="com.vordel.client.manager.filter.dirscan.DirectoryScannerDialog.sortType"
    includeBlank="false" readOnly="true" required="true" stretch="true" />
  </panel>
  <panel label="SORT_DIRECTION_LABEL" margin="0,0,0,7">
   <ComboAttribute field="sortDirection" contentSource="com.vordel.client.manager.filter.dirscan.DirectoryScannerDialog.sortDirection"
    includeBlank="false" readOnly="true" required="true" stretch="true" />
  </panel>
  <binding driver="SORT_FILES_LABEL" driven="SORT_TYPE_LABEL,SORT_DIRECTION_LABEL"
   class="com.vordel.client.ui.declarative.Enabler" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

When the Sort files button is disabled the “Sort type” and “Sort direction” Combo boxes are disabled.

When the Sort files button is enabled they are enabled also.

BitMaskAttribute

The BitMaskAttribute tag renders a bank of SWT Button widgets, each with the SWT.CHECK style applied, and backed by the specified entity field.

GridLayout gridLayout = new GridLayout();
gridLayout.numColumns = columns;

Each item in the bitmask is represented declaratively as a choice tag, which is a child of BitMaskAttrbute. The following table outlines the choice attributes:

Sample XML\

<ui>
 <panel indent="15" margin="0">
  <BitMaskAttribute field="logMask" columns="3">
   <choice value="1" label="LOG_PAGE_LOG_LEVEL_FATAL"/>
   <choice value="2" label="LOG_PAGE_LOG_LEVEL_FAILURE"/>
   <choice value="4" label="LOG_PAGE_LOG_LEVEL_SUCCESS"/>
  </BitMaskAttribute>
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

button

The button tag renders an SWT Button widget with the SWT.PUSH style applied.

Sample XML\

<ui>
 <panel columns="2">
  <button image="browse" label="BROWSE_TIP" tooltip="BROWSE_TIP" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

ButtonAttribute

The ButtonAttribute tag renders an SWT Button widget with the SWT.PUSH style applied, and backed by the specified entity field.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <group label="LOG_PAGE_ABORT_SECTION_LABEL">
  <ButtonAttribute field="abort" label="ABORT_PROCESSING_LABEL" span="2"/>
 </group>
</ui>

Rendered UI\

The above XML renders the following UI:

CategoryAttribute

The CategoryAttribute tag renders an SWT Combo widget with either the SWT.BORER or READ_ONLY style applied. It lists all the categories available.

Sample XML\

<ui>
 <CategoryAttribute label="LOG_CATEGORY_LABEL"/>
</ui>

Rendered UI\

The above XML renders the following UI:

CertDNameAttribute

The CertDNameAttribute tag renders a SWT Combo with a list of certificates.

Sample XML\

<ui>
 <CertDNameAttribute label="ISSUER_DNAME_LABEL"
  field="issuerName" required="true" />
</ui>

Rendered UI\

The above XML renders the following UI:

certSelector

The certSelector tag renders a Label with an associated Button and read-only TextBox (which contains the alias of the selected certificate or (unset) if no certificate has been selected).

When the Button is clicked a certificate selection dialog similar to the following is displayed:

Sample XML\

<ui>
 `panel`
  <certSelector label="SECURITY_SERVER_CERTIFICATE" field="sslCertificate"
   required="false" view="privateKey" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

CertTreeAttribute

The CertTreeAttribute tag renders a JFace TreeViewer, populated with certificate information read from the certificate store.

Sample XML\

<ui>
 `panel`
  <CertTreeAttribute label="SSL_CERTIFICATES_LABEL" field="sslUsers"
   required="false" multiSelect="false" keysOnly="true" tableHeight="300" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

CheckboxGroupAttribute

The CheckboxGroupAttribute tag renders an SWT Composite with zero or more Buttons (style = SWT.CHECK) defined using choice tags as children.

CheckboxGroupAttribute attributes

GridLayout layout = new GridLayout();
layout.numColumns = columns;

choice attributes

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

The following example represents the multi-valued “options” entity field, of which there are three possible values: “value1”, “value2”, and “custom”.

• If the first check box button is selected (represented by the first choice tag) the “options” acquire the value “value1”.
• If the second check box button is selected the “options” acquire the two values: “value1” and “value2”.
• If all three check boxes are selected the “options” acquire all three values: “value1”, “value2” and “custom”.

The CheckboxGroupAttribute tag is not restricted to having only choice tags as children. A good candidate is the panel container tag, as outlined in the example below. When the ‘User Defined’ choice is selected the children of the subsequent panel are enabled automatically. When the ‘User Defined’ choice is unselected, these children are disabled automatically.

    <ui>
        `panel`
            <CheckboxGroupAttribute field="options" label="Select Values">
                <choice value="value1" label="Value1" />
                <choice value="value2" label="Value2" />
                <choice value="custom" label="User Defined" />
                    <panel indent="15" margin="0">
                        <TextAttribute field="custom" label="Value"/>
                    </panel>
            </CheckboxGroupAttribute>
        </panel>
    </ui>

Rendered UI\

The above XML renders the following UI.

The multi-valued “options” entity field has two values: “value1” and “value2”:

The multi-valued “options” entity field has two values: “value2” and “custom”:

CircuitChainTable

The CircuitChainTable tag renders a Table widget. The table is populated with the field values of the backed entity.

Sample XML\

<ui>
  <CircuitChainTable flavor="OperationCircuitReference"
   setOrderable="false" setCapabilities="EDIT"/>
</ui>

Rendered UI\

The above XML renders the following UI:

ComboAttribute

The ComboAttribute tag renders an SWT Combo widget, backed by the specified entity field.

Sample XML\

<ui>
 <group label="TRACE_SETTINGS_LABEL" columns="2" span="2">
  <ComboAttribute field="traceLevel" label="TRACE_LEVEL_LABEL"
   required="true" readOnly="true"
   contentSource="com.vordel.client.manager.filter.util.TraceHelper.logLevels" />
 </group>
</ui>

Rendered UI\

The above XML renders the following UI:

comboBinding

The comboBinding tag allows you to create a binding between various widgets.

Sample XML\

The binding below specifies a binding between a ComboAttribute and a TextAttribute.

<ui>
 <ComboAttribute field="extractMethod"
  label="JMS_CONSUMER_EXTRACTION_METHOD_LABEL"
  contentSource="com.vordel.client.manager.filter.jms.JMSConsumerDialog.extractMethods"
  includeBlank="false" readOnly="true"
  required="true" stretch="true"/>
 <TextAttribute field="attributeName"
  label="JMS_MESSAGE_ATTRIBUTE_NAME"
  required="false"/>
 <comboBinding driver="JMS_CONSUMER_EXTRACTION_METHOD_LABEL"
  driven="JMS_MESSAGE_ATTRIBUTE_NAME"
  class="com.vordel.client.ui.declarative.ComboEnabler"
  valueSelected="1" enableDriven="false"/>  
</ui>

Rendered UI\

The above XML renders the following UI:

ComboStackPanel

The ComboStackPanel tag primarily renders an SWT Combo widget, backed by the specified entity field. If the tag contains panel children it also renders those controls as part of an SWT StackLayout control, with each panel being ‘flipped’ when the selection in the combo box changes.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <panel columns="2">
  <NameAttribute />
  <ComboStackPanel field="connectionType" label="FTP_UPLOAD_CONNECTION_TYPE_LABEL">
   <panel label="FTP" columns="2">
    <TextAttribute label="FTP_UPLOAD_SSL_PROTOCOL_LABEL" field="sslProtocol"/>
   </panel>

   <panel label="FTPS" columns="2">
    <TextAttribute label="FTP_UPLOAD_SSL_PROTOCOL_LABEL" field="sslProtocol"/>
    <ButtonAttribute label="FTP_UPLOAD_SSL_IS_IMPLICIT" field="isImplicit" />
    <tabFolder span="2">
     <tab label="FTP_UPLOAD_SSL_TRUSTED_CERTS_TAB">
      `panel`
       <CertTreeAttribute label="FTP_UPLOAD_SSL_TRUSTED_CERTS_LABEL"
        field="trustedCerts" required="false"
        tableHeight="100" />
      </panel>
     </tab>
     <tab label="FTP_UPLOAD_SSL_CLIENT_CERTS_TAB">
      `panel`
       <CertTreeAttribute label="FTP_UPLOAD_SSL_CLIENT_CERTS_LABEL"
        field="clientCert" required="false"
        multiSelect="false" keysOnly="true"
        tableHeight="100" />  
      </panel>
     </tab>
    </tabFolder>
   </panel>
  </ComboStackPanel>
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

Condition

The Condition tag introduces control statements.

Sample XML\

<ui>
 <Condition criteria="ifnot" property="httphostheader.disabled">
   <group label="HOST_HEADER_GROUP_NAME" columns="2" fill="false">
     <RadioGroupAttribute field="forwardClientHostHeader" columns="2">
       <choice value="1" label="HOST_HEADER_FROM_CLIENT"/>
       <choice value="0" label="HOST_HEADER_FROM_VORDEL" />
     </RadioGroupAttribute>
   </group>
 </Condition> />
</ui>

Rendered UI\

If the “httphostheader” property is not enabled nothing is displayed. If the “httphostheader” property is enabled it renders the following UI:

CronAttribute

The CronAttribute tag renders an SWT Button widget and a SWT Text widget, backed by the specified entity field.

Sample XML\

<ui>
   <CronAttribute field="expression"
    label="CRON_EXPRESSION_DIALOG_EXPRESSION_LABEL"
    required="true"/>
</ui>

Rendered UI\

The above XML renders the following UI:

ContentEncodingAttribute

The ContentEncodingAttribute tag renders an SWT Text widget and a SWT Button widget, backed by the specified entity field.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
   <ContentEncodingAttribute field="inputEncodings"
    label="inputEncodings" trackChanges="true"/>
</ui>

Rendered UI\

The above XML renders the following UI:

DirectoryChooser

The DirectoryChooser tag renders an SWT Label, Text and Button widget. When clicked, the button displays a directory browser to allow you to easily select a directory.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <group label="LOCATION_LABEL" span="2">
  <panel columns="2">
   <TextAttribute field="fileName" label="FILENAME_LABEL" required="true" />
   <DirectoryChooser field="directory" label="DIRECTORY_LABEL" required="true"
    span="2" />
  </panel>
 </group>
</ui>

Rendered UI\

The above XML renders the following UI:

ESPKReferenceSummaryAttribute

The ESPKReferenceSummaryAttribute tag renders an SWT Text and Button control. When clicked, the button displays a reference browser to allow you to easily select the required entity reference.

Sample XML\

<ui>
 <ESPKReferenceSummaryAttribute
  displayName="EMS_CONSUMER_SELECT_CONNECTION_DISP_NAME"
  field="emsClient"
  searches="EMSClientGroup" selectableType="EMSClient"
  dialogTitle="EMS_CLIENT_DIALOG_TITLE" required="true" span="2" />
</ui>

Rendered UI\

The above XML renders the following UI:

The following dialog is displayed when you click the browse button:

FieldTable

The FieldTable tag renders an SWT TableViewer, along with a bank of buttons to allow you to enter a list of values, the type of which is based on the specified entity field.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
   <panel columns="2">
     <TextAttribute field="cmdLine" label="CMD_LINE_LABEL" required="true" />
     <FieldTable field="arguments" label="ARGUMENTS_LABEL" />
  </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

FileChooserText

The FileChooserText tag renders an SWT Label, Text and Button widget. When clicked, the button displays a file browser to allow a user to easily select a file.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
  <panel columns="2">
    <FileChooserText field="fileIn" label="FILE_LABEL" required="true" span="2" />
  </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

group

The group tag renders an SWT Group widget, which is usually used to group other widgets.

GridLayout gridLayout = new GridLayout();
gridLayout.numColumns = columns;

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

GridLayout gridLayout = new GridLayout();
gridLayout.marginHeight = margin;
gridLayout.marginWidth = margin;
gridLayout.marginTop = margin;
gridLayout.marginBottom = margin;
gridLayout.marginLeft = margin;
gridLayout.marginRight = margin;

GridLayout gridLayout = new GridLayout();
StringTokenizer st = new StringTokenizer(margin, “,”);
gridLayout.marginTop = st.nextToken();
gridLayout.marginBottom = st.nextToken();
gridLayout.marginLeft = st.nextToken();
gridLayout.marginRight = st.nextToken();

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.verticalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.grabExcessVerticalSpace = true;
gridData.horizontalSpan = span;

GridLayout gridLayout = new GridLayout();
gridLayout.verticalSpacing = verticalSpacing;

GridLayout gridLayout = new GridLayout();
gridLayout.marginWidth = indent;

Sample XML\

<ui>
 <group label="LOG_PAGE_CATEGORY_LABEL" columns="2">
  <CategoryAttribute label="LOG_CATEGORY_LABEL" required="true" />
 </group>
</ui>

Rendered UI\

The above XML renders the following UI:

HTTPStatusTableAttribute

The HTTPStatusTableAttribute tag renders a Table and a group SWT Buttons that appear as a Button bar. When clicked, the buttons display a dialog to add, edit, or delete a HTTP status code.

Sample XML\

<ui>
  <HTTPStatusTableAttribute field="retryHTTPRanges" tableHeight="100" />
</ui>

Rendered UI\

The above XML renders the following UI:

include

The tag allows another declarative XML file to be included inline in the parent including XML file.

Sample XML\

<ui>
 <panel columns="2">
  <include resource="AuditSettings-page.xml"
   class="com.vordel.client.manager.AuditSettingsPage"/>
 </panel>
</ui>

label

The label tag renders an SWT Label widget.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <panel columns="2">
  <NameAttribute />
  <label label="FILE_TO_LOAD_SUMMARY" span="2" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

LifeTimeAttribute

The LifeTimeAttribute tag renders a Label, Text, and a group of Spin controls, representing a time span. This allows you to enter values for Days, Hours, Minutes and Seconds.

Sample XML\

<ui>
 <panel columns="2">
  <panel span="2" columns="3" margin="0">
   <LifeTimeAttribute label="VALIDITY_LABEL" field="validity" required="true" />
  </panel>
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

NameAttribute

The NameAttribute tag renders an SWT Label and accompanying Text widget. It is used to wrap the following TextAttribute:

<TextAttribute field="name" label="NAME_LABEL" required="true" />

The label NAME_LABEL must exist in the appropriate resource.properties file.

Sample XML\

<ui>
  <panel columns="2">
    <NameAttribute />
  </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

MsgAttrAttribute

The MsgAttrAttribute tag renders an SWT Label and accompanying Combo widget populated with a list of Axway message attributes.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <panel columns="2">
  <MsgAttrAttribute field="sourceAttribute"
   label="STRING_REPLACE_SRC_ATTRIBUTE_LABEL" required="true"/>
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

MultiValueTextAttrAttribute

The MultiValueTextAttribute tag is similar to the TextAttribute tag in that it renders an SWT Text widget (and optionally, a Label widget), backed by the specified field for the entity being configured. The difference is that it caters for multiple values interspersed with the specified separator.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = colSpan;

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.verticalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.grabExcessVerticalSpace = true;
gridData.horizontalSpan = colSpan;

Sample XML\

<ui>
 <panel columns="2">
  <MultiValueTextAttribute field="extension" label="EXTENSION_LABEL"
   required="false" split=";"/>
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

In this case, EXTENSION_LABEL is resolved to the localized string “Extension:”.

NumberAttribute

The NumberAttribute tag renders an SWT Label and accompanying Text widget. The Text widget only accepts numbers as input.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <panel columns="2">
  <NameAttribute />
  <NumberAttribute field="pause" label="PAUSE_FOR_LABEL" required="true" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

panel

The panel tag renders an SWT Composite widget, which is usually used to group other widgets.

GridLayout gridLayout = new GridLayout();
gridLayout.numColumns = columns;

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

GridLayout gridLayout = new GridLayout();
gridLayout.marginHeight = margin;
gridLayout.marginWidth = margin;
gridLayout.marginTop = margin;
gridLayout.marginBottom = margin;
gridLayout.marginLeft = margin;
gridLayout.marginRight = margin;

Margin can also be specified as a list of four integer values, whereby the following layout members will be set:
GridLayout gridLayout = new GridLayout();
StringTokenizer st =new StringTokenizer(margin, “,”);
gridLayout.marginTop = st.nextToken();
gridLayout.marginBottom = st.nextToken();
gridLayout.marginLeft = st.nextToken();
gridLayout.marginRight = st.nextToken();

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.verticalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.grabExcessVerticalSpace = true;
gridData.horizontalSpan = span;

GridLayout gridLayout = new GridLayout();
gridLayout.verticalSpacing = verticalSpacing;

GridLayout gridLayout = new GridLayout();
gridLayout.marginWidth = indent;

GridData gridData = new GridData();
gridData.horizontalAlignment = SWT.CENTER;

GridData gridData = new GridData();
gridData.verticalAlignment = SWT.CENTER;

GridData gridData = new GridData();
gridData.widthHint = 200;

GridData gridData = new GridData();
gridData.heightHint = 300;

GridData gridData = new GridData();
gridData.minimumWidth = 300;

GridData gridData = new GridData();
gridData.minimumHeight = 300;

Sample XML\

<ui>
 <panel span=”2” columns="2" indent=”15” margin=”0” label=”SETTINGS_PANEL”>
  <ReferenceSelector field="connectionFailurePolicy"
   type="FilterCircuit"
   label="CONNECTION_FAILURE_POLICY_SELECTION_DIALOG_TITLE"
   title="CHOOSE_CONNECTION_FAILURE_POLICY" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

PasswordAttribute

The PasswordAttribute tag renders an SWT Label and accompanying Text widget. The Text widget has its user-entered text masked with the * character.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <group label="PROXY_SETTINGS_LABEL" columns="2" span="2">
  <TextAttribute field="username" label="PROXY_USERNAME_LABEL"/>
  <PasswordAttribute field="password" label="PROXY_PASSWORD_LABEL"/>
 </group>
</ui>

Rendered UI\

The above XML renders the following UI:

RadioGroupAttribute

The RadioGroupAttribute tag renders an SWT Composite with 0 or more Buttons (style = SWT.RADIO) defined using ‘choice’ tags as children.

RadioGroupAttribute – Available attributes

GridLayout layout = new GridLayout();
layout.numColumns = columns;

choice – Available attributes

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

The following example represents the “logMaskType” entity field, of which there are two possible values: “SERVICE” and “FILTER”. If the first radio button is selected (represented by the first ‘choice’ tag) the logMaskField will acquire the value “SERVICE”. If the second radio button is selected the logMaskField will acquire the value “FILTER”.

The RadioGroupAttribute tag is not restricted to just having ‘choice’ tags as children. A good candidate is the container tag, as outlined in the example below. When the ‘USE_FILTER’ choice is selected the children of the subsequent panel are enabled automatically. When the ‘USE_SERVICE’ choice is selected, these children are disabled automatically.

<ui>
  <panel>
    <RadioGroupAttribute field="logMaskType" columns="1">
     <choice value="SERVICE" label="USE_SERVICE" />
     <choice value="FILTER" label="USE_FILTER" />
     <panel indent="15" margin="0">
         <BitMaskAttribute field="logMask" columns="3">
        <choice value="1" label="LEVEL_FATAL"/>
        <choice value="2" label="LEVEL_FAILURE"/>
        <choice value="4" label="LEVEL_SUCCESS"/>
         </BitMaskAttribute>
      </panel>
     </RadioGroupAttribute>
  </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

ReferenceSelector

The ReferenceSelector tag renders an SWT Label, Text and Button control. When clicked, the button displays a reference browser to allow you to easily select the required entity reference.

Sample XML\

<ui>
 <panel span="2" columns="2" indent="15" margin="0" label="SETTINGS_PANEL">
  <ReferenceSelector field="connectionFailurePolicy"
   selectableTypes="FilterCircuit"
   searches="ROOT_CIRCUIT_CONTAINER,CircuitContainer"
   label="POLICY_SELECTION_DIALOG_TITLE"
   title="CHOOSE_CONNECTION_FAILURE_POLICY" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

The following dialog is displayed when the browse button is clicked:

SamlAttribute

The SamlAttribute tag renders a SWT Combo with a list of SAML versions.

Sample XML\

<ui>
 <SamlAttribute label="SAML_VERSION_REQUIRED_LABEL"
  field="samlVersion" required="true" />
</ui>

Rendered UI\

The above XML renders the following UI:

SamlSubjectConfirmationAttribute

The SamlSubjectConfirmationAttribute tag renders a SWT Combo with a list of available SAML subject confirmation methods. The Attribute is very specific to using the SAML filter. You can only have one SamlSubjectConfirmationAttribute per window.

When a SAML assertion is consumed by a downstream web service, the information contained in the SubjectConfirmation block can be used to authenticate the end-user that authenticated to the API Gateway, or the issuer of the assertion, depending on what is configured.

The following table shows the available methods and their meanings :

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

GridLayout gridLayout = new GridLayout();
gridLayout.numColumns = columns;

Sample XML\

<ui>
  <SamlSubjectConfirmationAttribute label="SAML_SUBJECT_CONF_METHOD_LABEL"
   required="true" />
</ui>

Rendered UI\

The above XML renders the following UI:

scrollpanel

The scrollpanel tag renders an SWT ScrolledComposite widget. When rendered the control automatically calculates the extent of its children so that the scroll bars are rendered correctly.

To facilitate ease-of-use, one of the following tags must be a direct child of scrollpanel:

• panel
• group
• tabFolder

GridData gridData = new GridData();
gridData.widthHint = 200;

GridData gridData = new GridData();
gridData.heightHint = 300;

GridData gridData = new GridData();
gridData.minimumWidth = 300;

GridData gridData = new GridData();
gridData.minimumHeight = 300;

Sample XML\

<ui>
 <scrollpanel>
  <panel columns="2">
    <TextAttribute field="name" label="EXCEPTION_NAME" required="true" />
    <TextAttribute field="name" label="EXCEPTION_NAME" required="true" />
    <TextAttribute field="name" label="EXCEPTION_NAME" required="true" />
    <TextAttribute field="name" label="EXCEPTION_NAME" required="true" />
    <TextAttribute field="name" label="EXCEPTION_NAME" required="true" />
    <TextAttribute field="name" label="EXCEPTION_NAME" required="true" />
  </panel>
 </scrollpanel>
</ui>

Rendered UI\

The above XML renders the following UI:

section

The section tag renders an SWT ExpandableComposite widget, which allows for groups of controls to be expanded or hidden from view.

To facilitate ease-of-use, one of the following tags must be a direct child of section:

• panel
• group
• tabFolder

Sample XML\

<ui>
 <section label="RS_STATUS_LABEL" expanded="true">
  <panel columns="2">
   <TextAttribute field="name" label="RS_STATUS_LABEL" required="true" />
  </panel>
 </section>
</ui>

Rendered UI\

The above XML renders the following UI:

The section can also be collapsed as follows:

SigningKeyAttribute

The SigningKeyAttribute tag renders a SWT Radio Button and a Tab Folder which has three tabs whose content includes SWT Buttons, Radio Buttons, Combo boxes, and so on.

Sample XML\

<ui>
  <SigningKeyAttribute
   subjectConfirmationNote="SUBJECT_CONFIRMATION_ASYMMETRIC_NOTE_LABEL"
   required="false"/>
</ui>

Rendered UI\

The above XML renders the following UI:

SizeAttribute

The SizeAttribute tag renders an SWT Label (optional), Text, and Combo widgets, allowing you to specify a numeric size value, and select one of the following age types:

• Kb
• Mb
• Gb

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <panel columns="3" margin="0">
   <SizeAttribute field="maxDbSize" label="OPDB_MAX_DB_SIZE_LABEL" required="true"/>
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

SoftRefListAttribute

The renders a SWT Combo  that shows a list of entities of a certain type.

Sample XML\

<ui>
 <SoftRefListAttribute label="WS_USERNAME_TOKEN_REPOSITORY_NAME_LABEL"
  field="repository" refName="name"
  src="/[AuthnRepositoryGroup]name=Authentication Repositories/[AuthnRepositoryBaseGroup]allowedFilter=WsUsernameFilter/[AuthnRepositoryBase]" />
</ui>

Rendered UI\

The above XML renders the following UI:

SoftRefTreeAttribute

The SoftRefTreeAttribute renders a jFace TreeViewer that shows the policies of a certain type.

GridData gridData = new GridData(GridData.FILL_BOTH);
gridData.horizontalSpan = 1;

Sample XML\

<ui>
 <panel columns="2">
  <group label="POP_POLICY_LABEL" span="1" columns="1">
   <SoftRefTreeAttribute field="filterCircuit"
    searches="/[CircuitContainer]**/[FilterCircuit],/[FilterCircuit]"
    selectableType="FilterCircuit"
    displayName="POP_CIRCUIT_DISP_NAME"
    height="80"
    width="100"
   />
  </group>
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

In this case, POP_POLICY_LABEL is resolved to the localized string “Policy to use”.

SpinAttribute

The SpinAttribute tag renders an SWT Text widget (and optionally, a Label widget), along with two buttons, one for incrementing the current entity value, and one for decrementing the value.

Sample XML\

<ui>
 <panel columns="7">
  <SpinAttribute field="hrs" label="HOUR" required="true"
   rangeMin="0" rangeMax="23" />
  <SpinAttribute field="mins" label="MIN" required="true"
   rangeMin="0" rangeMax="59" />
  <SpinAttribute field="secs" label="SEC" required="true"
   rangeMin="0" rangeMax="59" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

tab

The tab tag renders an SWT TabItem widget. They must be direct children of the tabFolder.

Sample XML\

<ui>
 <panel columns="2" span="2">
  <tabFolder span="2">
   <tab label="CERTS">
   <tab label="SSL">
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

tabFolder

The tabFolder tag renders an SWT TabFolder widget used to house TabItems (generated by using tab tags as children).

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.verticalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.grabExcessVerticalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <panel columns="2" span="2">
  <tabFolder span="2">
   <tab label="CERTS">
   <tab label="SSL">
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

TablePage

The TablePage tag renders a jFace TableViewer that represents a list of entities of the specified type. These entities can be added, edited, and deleted using the available buttons.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.verticalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.grabExcessVerticalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <panel columns="2">
  <TablePage type="Property"
   dialogClass="com.vordel.client.manager.filter.exec.EnvironmentVariableDialog"
   columnProperties="name,value" sortColumns="name,value"
   columnResources="COLUMN_VARIABLE,COLUMN_VALUE" columnWidths="300,200"
   deleteText="DELETE_VARIABLE_CONFIRMATION"
   dialog.setFlavor="environment_variable_dialog.xml" />
 </panel>
</ui>

Sample dialog flavor XML

<panel columns="2">
 <TextAttribute field="name" label="NAME_LABEL" required="true"/>
 <TextAttribute field="value" label="VALUE_LABEL" required="false"/>
</panel>

Rendered UI\

The above XML renders the following UI:

The dialog is rendered as follows:

text

The text tag renders an SWT Text widget.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = colSpan;

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.verticalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.grabExcessVerticalSpace = true;
gridData.horizontalSpan = colSpan;

Sample XML\

<ui>
 <text label="KEYPAIRS_PUBLICKEY_LABEL" multiline="true" vscroll="true"
  wrap="true" heightHint="100" widthHint="350" readOnly="true"/>
</ui>

Rendered UI\

The above XML renders the following UI:

TextAttribute

The TextAttribute tag renders an SWT Text widget (and optionally, a Label widget), backed by the specified field for the entity being configured.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = colSpan;

Sample XML\

<ui>
 <panel columns="2">
  <TextAttribute field="name" label="EXCEPTION_NAME" required="true" />
 </panel>
</ui>

Rendered UI\

The above XML renders the following UI:

In this case, EXCEPTION_NAME is resolved to the localized string “Name:”.

ui

The ui tag is the root of a declarative XML document.

This tag does not require any attributes.

Sample XML\

<ui>
 <panel columns="2">
  <TextAttribute field="name" label="EXCEPTION_NAME" required="true" />
 </panel>
</ui>

validator

The validator tag is used to include a validator class.

Sample XML\

<ui>
 <validator class="com.vordel.client.manager.filter.dirscan.DirectoryScannerDialogValidator" />
</ui>

XPathAttribute

The XPathAttribute tag renders an SWT Combo widget and three SWT Button widgets within an SWT Composite displayed as a Button bar.

GridData gridData = new GridData();
gridData.horizontalAlignment = GridData.FILL;
gridData.grabExcessHorizontalSpace = true;
gridData.horizontalSpan = span;

Sample XML\

<ui>
 <XPathAttribute field="insertTokenLocationXPath"
  xpathGroup="XPathTokenInsertionLocationGroup" />
</ui>

Rendered UI\

The above XML renders the following UI: