Adding a Boolean property

Boolean properties represent a true or false value and can be used to enable or disable features in your application.

To add a Boolean property to a template:

  1. Insert a <Boolean> element inside a <Property> element.

  2. Optionally, you can specify the default value for the property. 

        <Property name="eligibleFreeShipping">
      <Boolean>true</Boolean>
				</Property>

    Any value other than the string "true" (case insensitive) defaults to a value of false.

The following example shows the configuration of a Boolean property: 

<ContentTemplate xmlns="http://endeca.com/schema/content-template/2008"
                 xmlns:editors="editors" 
                 type="HeaderContent">
    <!-- additional elements omitted from this example -->
    <ContentItem>
        <Name>Search Box</Name>
        <Property name="autoSuggestEnabled">
            <Boolean>false</Boolean>
        </Property>
        <!-- additional elements omitted from this example -->
    </ContentItem>
    <!-- additional elements omitted from this example -->
</ContentTemplate>

A Boolean editor provides a checkbox for Experience Manager users to specify the value of a Boolean property.

To add a Boolean editor:

  1. Insert a <editors:BooleanEditor> element within <BasicContentItemEditor>.

  2. Specify additional attributes for the editor:

    AttributeDescription
    propertyName Required. The name of the Boolean property that this editor is associated with. This property must be declared in the same template as the Boolean editor.
    enabled If set to false, the checkbox displays in Experience Manager but the value cannot be changed by the user. By default, checkboxes are enabled.

The following example illustrates a checkbox for specifying whether auto-suggest search results should be enabled, with a default value of false: 

<ContentTemplate xmlns="http://endeca.com/schema/content-template/2008"
                 xmlns:editors="editors" 
                 type="HeaderContent">
    <!-- additional elements omitted from this example -->
    <ContentItem>
        <Name>Search Box</Name>
        <Property name="autoSuggestEnabled">
            <Boolean>false</Boolean>
        </Property>
        <!-- additional elements omitted from this example -->
    </ContentItem>
    <EditorPanel>
        <BasicContentItemEditor>
            <GroupLabel label="Auto-Suggest Configuration"/>
            <editors:BooleanEditor propertyName="autoSuggestEnabled" 
                label="Enable Auto-Suggest" 
                enabled="true"/>
            <!-- additional elements omitted from this example -->
        </BasicContentItemEditor>
    </EditorPanel>
</ContentTemplate>

Copyright © Legal Notices