Configuration Guide
Configuration Guide
Breadcrumbs

Boolean Widget

Definition

The Boolean Widgets allows to configure the display of boolean attributes.

This Widget do not allow the edition of a boolean attribute therefore there is no Edit mode for this Widget.

To configure the edition of a boolean attribute, Toggle or Check Box Widget can be used.

On/Off display

Icon display

True/False display
image-20220928-075337.png


image-20220928-075326.png


image-20220928-075332.png


Configuration

Properties

Properties name

Type

Mandatory

Description

Values (default value in bold)

backgroundColor

String

NO

The color displayed for the background.

Standard CSS color value, #ffffff

bold

Boolean

NO

Defines if the value is displayed in bold or not.

true, false

fontSize

Enum

NO

Defines the displayed size.

INHERIT, XX_SMALL, X_SMALL, SMALL, MEDIUM, LARGE, X_LARGE, XX_LARGE

italic

Boolean

NO

Defines if the value is displayed in italic or not.

true, false

textAlign

Enum

NO

Defines where the text is aligned when displayed.

LEFT, CENTER, RIGHT

textColor

String

NO

Defines the displayed color.

Standard CSS color value, #000000

underline

Boolean

NO

Defines if the value is underlined or not.

true, false

booleanDisplayType

Enum

NO

Defines the display of the different values.

ICON, TRUE_FALSE, ON_OFF*

falseIcon

String

YES , if type is ICON

Defines an icon to display if boolean value is false.

https://fontawesome.com/v4.7.0/icons/

Example: <falseIcon>fa fa-times</falseIcon>

falseText

String

NO

Defines a text to display if boolean value is false.


trueIcon

String

YES , if type is ICON

Defines an icon to display if boolean value is true.

https://fontawesome.com/v4.7.0/icons/

Example: <trueIcon>fa fa-check-square</trueIcon>

trueText

String

NO

Defines a text to display if boolean value is true.


Example

Display - On/Off

Display -

Display - True/False (text)
XML
<widget id="enabled" xsi:type="ctdbum:AttributeEditorWidgetType">
	<hidden>false</hidden>
    <config>
    	<editor>
        	<displayWidget xsi:type="ctdbum:BooleanDisplayWidgetType">
            	<hidden>false</hidden>
                <config>
                	<backgroundColor>#ffffff</backgroundColor>
                    <bold>false</bold>
                    <fontSize>INHERIT</fontSize>
                    <italic>false</italic>
                    <textAlign>LEFT</textAlign>
                    <textColor>#000000</textColor>
                    <underline>false</underline>
                    <booleanDisplayType>ON_OFF</booleanDisplayType>
				</config>
			</displayWidget>
		</editor>
        <label></label>
        <lockedInUi>false</lockedInUi>
        <mode>READ</mode>
        <multiValued>false</multiValued>
        <override>true</override>
	</config>
    <attributeId>enabled</attributeId>
</widget>


XML
<widget id="enabled" xsi:type="ctdbum:AttributeEditorWidgetType">
  <hidden>false</hidden>
  <config>
    <editor>
        <displayWidget xsi:type="ctdbum:BooleanDisplayWidgetType">
          <hidden>false</hidden>
          <config>
              <backgroundColor>#ffffff</backgroundColor>
              <bold>false</bold>
              <fontSize>INHERIT</fontSize>
              <italic>false</italic>
              <textAlign>LEFT</textAlign>
              <textColor>#000000</textColor>
              <underline>false</underline>
              <booleanDisplayType>ICON</booleanDisplayType>
              <trueIcon>fa fa-check-square-o</trueIcon>
          </config>
        </displayWidget>
    </editor>
    <label></label>
    <lockedInUi>false</lockedInUi>
    <mode>READ</mode>
    <multiValued>false</multiValued>
    <override>true</override>
  </config>
  <attributeId>enabled</attributeId>
</widget>
XML
<widget id="enabled" xsi:type="ctdbum:AttributeEditorWidgetType">
	<hidden>false</hidden>
    <config>
    	<editor>
        	<displayWidget xsi:type="ctdbum:BooleanDisplayWidgetType">
            	<hidden>false</hidden>
                <config>
                	<backgroundColor>#ffffff</backgroundColor>
                    <bold>false</bold>
                    <fontSize>INHERIT</fontSize>
                    <italic>false</italic>
                    <textAlign>LEFT</textAlign>
                    <textColor>#000000</textColor>
                    <underline>false</underline>
                    <booleanDisplayType>TRUE_FALSE</booleanDisplayType>
				</config>
			</displayWidget>
		</editor>
        <label></label>
        <lockedInUi>false</lockedInUi>
        <mode>READ</mode>
        <multiValued>false</multiValued>
        <override>true</override>
	</config>
    <attributeId>enabled</attributeId>
</widget>


  • Features

    Design screens and business features to manage objects.