calendar-scheduler.xml

<?xml version="1.0" encoding="utf-8" ?>
<widget id="calendar.widget.calendar-scheduler" needsEntityContext="false" xmlns="http://www.mendix.com/widget/1.0/">
    <name>Calendar (with scheduler)</name>
    <description>Calendar with Scheduler</description>

    <icon>iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAANkE3LLaAgAAAbVJREFUeJylkL9qVEEUxn9zM3dD0mx3MS4uxCCIlSRF/Jft1gSfQCzSuJUvYKmWeYTIphEs0goKYkRUdrXSBYsQglhY+ADBu/HOnHMs7ubuCrFw/Zr5ZpjzO9857ukKD713D5hCMdojt7vqbK3VzElm5oOmiEsRPNFmMDzqEjQIMQRiiIRfBcXxMcWwIIaYe4BEh6AJrlAsKDEIRVBUDBUjKsRoqEIQCNEogiM/+jnvdledTRP/RP6o85jzS0tgYBiqipqhIpgpIoqqIlqeKlLeRRjmOR6g2WxShMDnwfeKvPDi3h+dftzarvy5xhyiwtfDQxKARqPB2YUzAKy3l1lvLwOwuLnF4uYWAGvXL3L1ygUAsiwjy7JyBIDabA1VBWC2Vjt9Vp/inAMg9Z5EkzEA4GSTz55/LEcAvj25XwHevP3C+K9hZhMAM2yU4PK1FgADttm4uYKI8Or1gNaNS4gKvf4BqoZqCUgATMfESZkaOno3M0x05BVMxwnUrNrBoP+uArzc+1T59739yqtSgT1AmqbU63Xu3G6fusC/6UO/VwJ2ut1/KpyUB7jb6UxVvNPt/n+C3whO5yPEeUjNAAAAAElFTkSuQmCC</icon>

    <properties>
        <!-- DATA SOURCE -->
        <property key="dataSourceType" type="enumeration" defaultValue="xpath">
            <caption>Data source type</caption>
            <category>Data source</category>
            <description>- The method of retrieving the objects. A normal XPath uses the Entity and XPath constraint. - The Microflow uses a standalone microflow that returns the objects. - The Microflow with context object can be used if the calendar is placed inside a dataview. This will use the Dataview data source microflow which will send along the Dataview Context object.</description>
            <enumerationValues>
                <enumerationValue key="xpath">XPath retrieve</enumerationValue>
                <enumerationValue key="mf">Microflow</enumerationValue>
                <enumerationValue key="contextmf">Microflow with context object</enumerationValue>
                <enumerationValue key="contextmf_viewspecific">Microflow with context object (Retrieve events for each view)</enumerationValue>
            </enumerationValues>
        </property>
        <property key="eventEntity" type="entity" allowNonPersistableEntities="true">
            <caption>Event Entity</caption>
            <category>Data source</category>
            <description>The entity.</description>
        </property>
        <property key="eventConstraint" type="entityConstraint" entityProperty="eventEntity" required="false">
            <caption>XPath Constraint</caption>
            <category>Data source</category>
            <description>The XPath constraint on the objects.</description>
        </property>
        <property key="datasourceMf" type="microflow" required="false">
            <caption>Data source microflow</caption>
            <category>Data source</category>
            <description>Setting this microflow will override the XPath retrieve option, and solely use this microflow to fill the calendar.</description>
            <returnType type="Void" />
        </property>

        <!-- DATAVIEW CONTEXT -->
        <property key="contextEntity" type="entity" required="false" allowNonPersistableEntities="true">
            <caption>Dataview Entity</caption>
            <category>Dataview context (Optional)</category>
            <description>The entity of the dataview object.</description>
        </property>
        <property key="contextDatasourceMf" type="microflow" required="false" entityProperty="contextEntity">
            <caption>Dataview data source microflow</caption>
            <category>Dataview context (Optional)</category>
            <description>Setting this microflow will override the XPath retrieve option, and solely use this microflow to fill the calendar.</description>
            <returnType type="Void" />
        </property>
        <property key="viewContextReference" type="entity" isPath="yes" pathType="reference" required="false" entityProperty="contextEntity">
            <caption>Reference to ViewRender entity (if used)</caption>
            <category>Dataview context (Optional)</category>
            <description>Select the path from the dataview object to the view render object to constrain on it within your microflow.</description>
        </property>
        <property key="startPos" type="attribute" required="false" entityProperty="contextEntity">
            <caption>Start pos attribute</caption>
            <category>Dataview context (Optional)</category>
            <description>The date on which the calendar should start.</description>
            <attributeTypes>
                <attributeType name="DateTime" />
            </attributeTypes>
        </property>
        <property key="showWeekendsAttribute" type="attribute" required="false" entityProperty="contextEntity">
            <caption>Show weekend</caption>
            <category>Dataview context (Optional)</category>
            <description>Attribute indicating whether to show weekends or not.</description>
            <attributeTypes>
                <attributeType name="Boolean" />
            </attributeTypes>
        </property>
        <property key="firstdayAttribute" type="attribute" required="false" entityProperty="contextEntity">
            <caption>First day of week</caption>
            <category>Dataview context (Optional)</category>
            <description>An integer attribute to specify the first day of the week, 0 = Sunday, 1 = Monday etc.</description>
            <attributeTypes>
                <attributeType name="Integer" />
            </attributeTypes>
        </property>

        <!-- EVENT DATA -->
        <property key="titleAttr" type="attribute" isPath="optional" pathType="reference" entityProperty="eventEntity">
            <caption>Title</caption>
            <category>Event data</category>
            <description></description>
            <attributeTypes>
                <attributeType name="String" />
            </attributeTypes>
        </property>
        <property key="startAttr" type="attribute" entityProperty="eventEntity">
            <caption>Start</caption>
            <category>Event data</category>
            <description></description>
            <attributeTypes>
                <attributeType name="DateTime" />
            </attributeTypes>
        </property>
        <property key="endAttr" type="attribute" entityProperty="eventEntity">
            <caption>End</caption>
            <category>Event data</category>
            <description></description>
            <attributeTypes>
                <attributeType name="DateTime" />
            </attributeTypes>
        </property>
        <property key="editable" type="boolean" defaultValue="true">
            <caption>Editable</caption>
            <category>Event data</category>
            <description>Sets the editability of events. Defaults to true.</description>
        </property>
        <property key="alldayAttr" type="attribute" entityProperty="eventEntity" required="false">
            <caption>All day</caption>
            <category>Event data</category>
            <description>Boolean attribute to define/save whether this is an all day event.</description>
            <attributeTypes>
                <attributeType name="Boolean" />
            </attributeTypes>
        </property>
        <property key="limitEvents" type="boolean" defaultValue="false">
            <caption>Limit events</caption>
            <category>Event data</category>
            <description>Boolean attribute to define whether the amount of events for one single day should be limited.</description>
        </property>

        <!-- BEHAVIOR -->
        <property key="onchangemf" type="microflow" required="false" entityProperty="eventEntity">
            <caption>On change</caption>
            <category>Behavior</category>
            <description>Microflow to trigger on change.</description>
            <returnType type="Void" />
        </property>
        <property key="onclickmf" type="microflow" required="false" entityProperty="eventEntity">
            <caption>On click</caption>
            <category>Behavior</category>
            <description>Microflow to trigger on click.</description>
            <returnType type="Void" />
        </property>
        <property key="neweventmf" type="microflow" required="false" entityProperty="eventEntity">
            <caption>New event</caption>
            <category>Behavior</category>
            <description>The new event microflow.</description>
            <returnType type="Void" />
        </property>
        <property key="neweventref" type="entity" required="true" isPath="yes" pathType="reference" entityProperty="eventEntity">
            <caption>New event reference</caption>
            <category>Behavior</category>
            <description>Required: The reference to connect the event to the context object.</description>
        </property>
        <property key="nowIndicator" type="boolean" defaultValue="false">
            <caption>Now Indicator</caption>
            <category>Behavior</category>
            <description>Indicates what time it is on the calendar</description>
        </property>
        <property key="defaultView" type="enumeration" defaultValue="month">
            <caption>Start view</caption>
            <category>Behavior</category>
            <description>Which is the default view when the widget is loaded</description>
            <enumerationValues>
                <enumerationValue key="month">Month</enumerationValue>
                <enumerationValue key="fourWeeks">Four weeks</enumerationValue>
                <enumerationValue key="basicWeek">Basic week</enumerationValue>
                <enumerationValue key="basicDay">Basic day</enumerationValue>
                <enumerationValue key="agendaWeek">Agenda week</enumerationValue>
                <enumerationValue key="agendaDay">Agenda day</enumerationValue>
                <enumerationValue key="timelineDay">Day timeline</enumerationValue>
                <enumerationValue key="timelineThreeDays">3 day timeline</enumerationValue>
                <enumerationValue key="listDay">List Day</enumerationValue>
                <enumerationValue key="listWeek">List Week</enumerationValue>
                <enumerationValue key="listMonth">List Month</enumerationValue>
                <enumerationValue key="listYear">List Year</enumerationValue>
            </enumerationValues>
        </property>

        <!-- VIEW SETTINGS -->
        <property key="calHeight" type="integer" defaultValue="0">
            <caption>Height</caption>
            <category>View settings</category>
            <description>The height in px. Will use 'auto' if value is set to 0. </description>
        </property>
        <property key="showWeekNumbers" type="boolean" defaultValue="false">
            <caption>Show weeknumbers</caption>
            <category>View settings</category>
            <description>Whether or not to show weeknumbers in the calendar. If 'YES' a column with weeknumbers will be added.</description>
        </property>
        <property key="weeknumberTitle" type="string" required='false' defaultValue='W'>
            <caption>Weeknumber Title</caption>
            <category>View settings</category>
            <description>Title used for the weeknumber column, defaults to "W".</description>
        </property>
        <property key="showWeekends" type="boolean" defaultValue="true">
            <caption>Show weekends</caption>
            <category>View settings</category>
            <description>Whether weekend should be shown on the calendar</description>
        </property>
        <property key="firstday" type="integer" defaultValue="0">
            <caption>First day of the week</caption>
            <category>View settings</category>
            <description>An integer to specify the first day of the week, 0 = Sunday, 1 = Monday etc.</description>
        </property>
        <property key="timeFormat" type="translatableString" required="false">
            <caption>Custom time format</caption>
            <category>View settings</category>
            <description>Default: h:mm{ - h:mm}. For more information: http://arshaw.com/fullcalendar/docs/text/timeFormat/</description>
        </property>
        <property key="dateFormat" type="translatableString" required="false">
            <caption>Custom date format</caption>
            <category>View settings</category>
            <description>For more information: http://arshaw.com/fullcalendar/docs/text/columnFormat/</description>
        </property>
        <property key="titleFormat" type="string" required="false">
            <caption>Custom title format</caption>
            <category>View settings</category>
            <description>For more information: http://arshaw.com/fullcalendar/docs/text/titleFormat/</description>
        </property>
        <property key="monthNamesFormat" type="translatableString" required="false">
            <caption>Month names format</caption>
            <category>View settings</category>
            <description>Comma seperated list of the full names of the months, starting at Januari.</description>
        </property>
        <property key="monthShortNamesFormat" type="translatableString" required="false">
            <caption>Month short names format</caption>
            <category>View settings</category>
            <description>Comma seperated list of the short names of the months, starting at Jan.</description>
        </property>
        <property key="dayNamesFormat" type="translatableString" required="false">
            <caption>Day names format</caption>
            <category>View settings</category>
            <description>Comma seperated list of the full names of the days, starting at Sunday.</description>
        </property>
        <property key="dayShortNamesFormat" type="translatableString" required="false">
            <caption>Day short names format</caption>
            <category>View settings</category>
            <description>Comma seperated list of the short names of the days, starting at Sun.</description>
        </property>
        <property key="languageSetting" type="string" defaultValue="en-gb">
            <caption>Language</caption>
            <category>View settings</category>
            <description>The language for the calendar.</description>
        </property>
        <property key="typeAttr" type="attribute" entityProperty="eventEntity" required="false">
            <caption>Enum for colors</caption>
            <category>View settings</category>
            <description></description>
            <attributeTypes>
                <attributeType name="Enum" />
            </attributeTypes>
        </property>
        <property key="notused" type="object" isList="true" required="false">
            <caption>Colors</caption>
            <category>View settings</category>
            <description></description>
            <properties>
                <property key="enumKey" type="string" required="false">
                    <caption>Enumeration key</caption>
                    <category>View settings</category>
                    <description></description>
                </property>
                <property key="bgColor" type="string" required="true">
                    <caption>Background color</caption>
                    <category>View settings</category>
                    <description></description>
                </property>
                <property key="border" type="string" required="true">
                    <caption>Border color</caption>
                    <category>View settings</category>
                    <description></description>
                </property>
                <property key="textColor" type="string" required="true">
                    <caption>Text color</caption>
                    <category>View settings</category>
                    <description></description>
                </property>
            </properties>
        </property>

        <!-- EXTRA -->
        <property key="axisFormat" type="translatableString" required="false">
            <caption>Agenda axis time format</caption>
            <category>Extra</category>
            <description>The format of the vertical axis labels in agenda views. Default: h(:mm)a</description>
        </property>
        <property key="slotMinutes" type="string" defaultValue="00:30:00">
            <caption>Slot duration</caption>
            <category>Extra</category>
            <description>The time interval (in minutes) of day and week calendars. Format: "00:30:00"</description>
        </property>
        <property key="todaycaption" type="translatableString" required="false">
            <caption>Today button caption</caption>
            <category>Extra</category>
            <description>Caption on button which jumps to today. Default: Today</description>
        </property>
        <property key="alldaycaption" type="translatableString" required="false">
            <caption>All-day caption</caption>
            <category>Extra</category>
            <description>The text titling the "all-day" slot at the top of the calendar. Default: all-day. This option only applies to Agendaweek en AgendaDay views.</description>
        </property>
        <property key="businessHours" type="boolean" defaultValue="false">
            <caption>Business hours</caption>
            <category>Extra</category>
            <description>Use business hours (highlighted in Calendar). This option only applies to Agendaweek en AgendaDay views. Defaults to false.</description>
        </property>
        <property key="startTime" type="string" defaultValue="08:00">
            <caption>Start time</caption>
            <category>Extra</category>
            <description>The start time for the business hours of each week day. This option only applies to Agendaweek en AgendaDay views. Format: "08:00"</description>
        </property>
        <property key="endTime" type="string" defaultValue="17:00">
            <caption>End time</caption>
            <category>Extra</category>
            <description>The end time for the business hours of each week day. This option only applies to Agendaweek en AgendaDay views. Format: "17:00"</description>
        </property>
        <property key="scrollTime" type="string" defaultValue="00:00">
            <caption>Scroll time</caption>
            <category>Extra</category>
            <description>Determines how far down the scroll pane is initially scrolled down. This option only applies to Agendaweek and AgendaDay views. Format: "08:00"</description>
        </property>
        <property key="minTime" type="string" required="false">
            <caption>minTime</caption>
            <category>Extra</category>
            <description>Determines the first time slot that will be displayed for each day. (https://fullcalendar.io/docs/minTime)</description>
        </property>
        <property key="maxTime" type="string" required="false">
            <caption>maxTime</caption>
            <category>Extra</category>
            <description>Determines the last time slot that will be displayed for each day. Specified as an exclusive end time. (https://fullcalendar.io/docs/maxTime)</description>
        </property>
        <property key="todayButton" type="boolean" defaultValue="true">
           <caption>Show 'today' button</caption>
           <category>Extra</category>
           <description></description>
        </property>
        <property key="prevnextButton" type="boolean" defaultValue="true">
           <caption>Show pagination button</caption>
           <category>Extra</category>
           <description></description>
        </property>
        <property key="singleButton" type="boolean" defaultValue="true">
           <caption>Show single button</caption>
           <category>Extra</category>
           <description>If you have a single view, should this button be shown?</description>
        </property>
        <property key="notused1" type="object" isList="true" required="false">
            <caption>Available views</caption>
            <category>Extra</category>
            <description>Default will use: Month, Agenda week, Agenda day.</description>
            <properties>
                <property key="availableViews" type="enumeration" defaultValue="month">
                    <caption>View</caption>
                    <category>View settings</category>
                    <description></description>
                    <enumerationValues>
                        <enumerationValue key="month">Month</enumerationValue>
                        <enumerationValue key="fourWeeks">Four weeks</enumerationValue>
                        <enumerationValue key="basicWeek">Basic week</enumerationValue>
                        <enumerationValue key="basicDay">Basic day</enumerationValue>
                        <enumerationValue key="agendaWeek">Agenda week</enumerationValue>
                        <enumerationValue key="agendaDay">Agenda day</enumerationValue>
                        <enumerationValue key="timelineDay">Day timeline</enumerationValue>
                        <enumerationValue key="timelineThreeDays">3 day timeline</enumerationValue>
                        <enumerationValue key="listDay">List Day</enumerationValue>
                        <enumerationValue key="listWeek">List Week</enumerationValue>
                        <enumerationValue key="listMonth">List Month</enumerationValue>
                        <enumerationValue key="listYear">List Year</enumerationValue>
                    </enumerationValues>
                </property>
                <property key="timeFormatViews" type="translatableString" required="false">
                    <caption>Custom time format</caption>
                    <category>Extra</category>
                    <description>Please refer to http://fullcalendar.io/docs/text/timeFormat/</description>
                </property>
                <property key="dateFormatViews" type="translatableString" required="false">
                    <caption>Custom date format</caption>
                    <category>Extra</category>
                    <description>Please refer to http://fullcalendar.io/docs/text/columnFormat/</description>
                </property>
                <property key="titleFormatViews" type="string" required="false">
                    <caption>Custom title format</caption>
                    <category>Extra</category>
                    <description>Please refer to http://fullcalendar.io/docs/text/titleFormat/</description>
                </property>
                <property key="labelViews" type="translatableString" required="false">
                    <caption>Label</caption>
                    <category>Extra</category>
                    <description>Caption used for the 'calendar view' button.</description>
                </property>
                <property key="eventLimit" type="string" defaultValue="-1" required="false">
                    <caption>Event limit</caption>
                    <category>Event</category>
                    <description>The maximum number of events to display on a single day. When there are too many events, a link that looks like "+2 more" is displayed.</description>
                </property>
            </properties>
        </property>

        <!-- VIEW CHANGE -->
        <property key="onviewchangemf" type="microflow" required="false" entityProperty="contextEntity">
            <caption>On view change</caption>
            <category>View Change</category>
            <description>Microflow triggered when a new date-range is rendered, or when the view type switches.(http://fullcalendar.io/docs/display/viewRender/)</description>
            <returnType type="Void" />
        </property>
        <property key="viewChangeEntity" type="entity" required="false" allowNonPersistableEntities="true">
            <caption>Entity</caption>
            <category>View Change</category>
            <description>The entity being passed to the on view change microflow. Reflecting the view change start and end date.</description>
        </property>
        <property key="viewStartAttr" type="attribute" entityProperty="viewChangeEntity" required="false">
            <caption>Start date</caption>
            <category>View Change</category>
            <description>The starting date of the view (fullcalendar's intervalStart of the view). E.g. first day of the month when rendering month view.</description>
            <attributeTypes>
                <attributeType name="DateTime" />
            </attributeTypes>
        </property>
        <property key="viewEndAttr" type="attribute" entityProperty="viewChangeEntity" required="false">
            <caption>End date</caption>
            <category>View Change</category>
            <description>The ending date of the view (fullcalendar's intervalEnd of the view). E.g. last day of the month when rendering month view</description>
            <attributeTypes>
                <attributeType name="DateTime" />
            </attributeTypes>
        </property>

        <!-- SCHEDULER -->
        <property key="schedulerLicenseKey" type="string">
            <caption>Scheduler License Key</caption>
            <category>Scheduler</category>
            <description>Read the following licence agreement http://fullcalendar.io/scheduler/license/ and get a license.</description>
        </property>
        <property key="resourceEntity" type="entity">
            <caption>Resource Entity</caption>
            <category>Scheduler</category>
            <description>The resource entity (used for Scheduler).</description>
        </property>
        <property key="resourceEventPath" type="entity" isPath="yes" pathType="reference" entityProperty="eventEntity">
            <caption>Resource reference</caption>
            <category>Scheduler</category>
            <description>The association from the resource to the event</description>
        </property>
        <property key="resourceLabelText" type="string">
            <caption>Resource Label Title</caption>
            <category>Scheduler</category>
            <description>Title of the resources column</description>
        </property>
        <property key="resourceTitle" type="attribute" isPath="optional" pathType="reference" entityProperty="resourceEntity">
            <caption>Resource Title</caption>
            <category>Scheduler</category>
            <description>Title of the resource</description>
            <attributeTypes>
                <attributeType name="String" />
            </attributeTypes>
        </property>
        <property key="groupEntity" type="entity" required="false">
            <caption>Group Entity</caption>
            <category>Scheduler</category>
            <description>The group entity (used for Scheduler).</description>
        </property>
        <property key="groupResourcePath" type="entity" isPath="yes" pathType="reference" entityProperty="resourceEntity" required="false">
            <caption>Group resource reference</caption>
            <category>Scheduler</category>
            <description>The path from the resource to the group</description>
        </property>
        <property key="groupTitle" type="attribute" isPath="optional" pathType="reference" entityProperty="groupEntity" required="false">
            <caption>Group Title</caption>
            <category>Scheduler</category>
            <description>Title of the group</description>
            <attributeTypes>
                <attributeType name="String" />
            </attributeTypes>
        </property>
    </properties>
</widget>