Blame view

src/main/config/component/schedule.xml 24.1 KB
bernard authored
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//AJAX4JSF//CDK Generator config/EN"
        "http://labs.jboss.com/jbossrichfaces/component-config.dtd"
        [
                <!ENTITY commonViewAttributes SYSTEM "commonViewAttributes.ent">
                <!ENTITY listeners SYSTEM "listeners.ent">
                ]
        >
<components>
    <component>
        <name>org.richfaces.Schedule</name>
        <family>org.richfaces.Schedule</family>
        <classname>org.richfaces.component.html.HtmlSchedule</classname>
        <superclass>org.richfaces.component.UISchedule</superclass>
        <description>
            <![CDATA[
                    ]]>
        </description>
        <renderer generate="true" override="true">
            <name>org.richfaces.renderkit.ScheduleRenderer</name>
            <template>org/richfaces/htmlSchedule.jspx</template>
            <superclass>org.richfaces.renderkit.ScheduleRendererBase</superclass>
        </renderer>
        <tag>
            <name>schedule</name>
            <classname>org.richfaces.taglib.ScheduleTag</classname>
            <superclass>
                org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
            </superclass>
        </tag>
        <taghandler generate="true">
            <classname>org.richfaces.taglib.ScheduleTagHandler</classname>
            <superclass>org.richfaces.taglib.ScheduleTagHandlerBase</superclass>
        </taghandler>
        <!--
          -->
        &ui_component_attributes;
        &commonViewAttributes;
        <!--&ui_data_attributes;-->
        <!--TODO how about reRender ajaxSingle and others?-->
        <!--TODO add style attribute-->
        <property>
            <name>switchType</name>
            <classname>java.lang.String</classname>
            <description>
                Available options:
                <ul>
                    <li>ajax</li>
                    <li>server</li>
                    <li>client</li>
                </ul>
            </description>
            <defaultvalue>"ajax"</defaultvalue>
        </property>
        <property>
            <name>view</name>
            <classname>java.lang.String</classname>
            <description>
                Schedule has a number of different "views",
                or ways of displaying days and events.
                The following 5 views are all built in to schedule:
                <ul>
                    <li>month</li>
                    <li>basicWeek</li>
                    <li>basicDay</li>
                    <li>agendaWeek</li>
                    <li>agendaDay</li>
                </ul>
                default: 'month'
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>headerLeft</name>
            <classname>java.lang.String</classname>
            <description>
                Defines the buttons and title at the top of the calendar.
                Values separated by a comma will be displayed adjacently.
                Values separated by a space will be displayed with a small gap in between.
                Strings can contain any of the following values:
                <ul>
                    <li>
                        <b>title</b>
                        - text containing the current month/week/day
                    </li>
                    <li>
                        <b>prev</b>
                        - button for moving the calendar back one month/week/day
                    </li>
                    <li>
                        <b>next</b>
                        - button for moving the calendar forward one month/week/day
                    </li>
                    <li>
                        <b>prevYear</b>
                        - button for moving the calendar back on year
                    </li>
                    <li>
                        <b>nextYear</b>
                        - button for moving the calendar forward one year
                    </li>
                    <li>
                        <b>today</b>
                        - button for moving the calendar to the current month/week/day
                    </li>
                    <li>
                        <i>a view name</i>
                        - button that will switch the calendar to any of the available views; see defaultView
                    </li>
                </ul>
                default: 'title'
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>headerCenter</name>
            <classname>java.lang.String</classname>
            <description>
                Defines the buttons and title at the top of the calendar.
                Values separated by a comma will be displayed adjacently.
                Values separated by a space will be displayed with a small gap in between.
                Strings can contain any of the following values:
                <ul>
                    <li>
                        <b>title</b>
                        - text containing the current month/week/day
                    </li>
                    <li>
                        <b>prev</b>
                        - button for moving the calendar back one month/week/day
                    </li>
                    <li>
                        <b>next</b>
                        - button for moving the calendar forward one month/week/day
                    </li>
                    <li>
                        <b>prevYear</b>
                        - button for moving the calendar back on year
                    </li>
                    <li>
                        <b>nextYear</b>
                        - button for moving the calendar forward one year
                    </li>
                    <li>
                        <b>today</b>
                        - button for moving the calendar to the current month/week/day
                    </li>
                    <li>
                        <i>a view name</i>
                        - button that will switch the calendar to any of the available views; see defaultView
                    </li>
                </ul>
                default: ''
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>headerRight</name>
            <classname>java.lang.String</classname>
            <description>
                Defines the buttons and title at the top of the calendar.
                Values separated by a comma will be displayed adjacently.
                Values separated by a space will be displayed with a small gap in between.
                Strings can contain any of the following values:
                <ul>
                    <li>
                        <b>title</b>
                        - text containing the current month/week/day
                    </li>
                    <li>
                        <b>prev</b>
                        - button for moving the calendar back one month/week/day
                    </li>
                    <li>
                        <b>next</b>
                        - button for moving the calendar forward one month/week/day
                    </li>
                    <li>
                        <b>prevYear</b>
                        - button for moving the calendar back on year
                    </li>
                    <li>
                        <b>nextYear</b>
                        - button for moving the calendar forward one year
                    </li>
                    <li>
                        <b>today</b>
                        - button for moving the calendar to the current month/week/day
                    </li>
                    <li>
                        <i>a view name</i>
                        - button that will switch the calendar to any of the available views; see defaultView
                    </li>
                </ul>
                default: 'today prev,next'
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>allDaySlot</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Determines if the "all-day" slot is displayed at the top of the calendar.
                When hidden with false, all-day events will not be displayed in agenda views.
                default: true
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>allDayText</name>
            <classname>java.lang.String</classname>
            <description>
                The text titling the "all-day" slot at the top of the calendar.
                default: 'all-day'
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>axisFormat</name>
            <classname>java.lang.String</classname>
            <description>
                Determines the time-text that will be displayed on the vertical axis of the agenda views.
                The default value will produce times that look like "5pm" and "5:30pm".
                default: 'h(:mm)tt'
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>slotMinutes</name>
            <classname>java.lang.Integer</classname>
            <description>
                The frequency for displaying time slots, in minutes.
                The default will make a slot every half hour.
                default: 30
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>defaultEventMinutes</name>
            <classname>java.lang.Integer</classname>
            <description>
                Determines the length (in minutes) an event appears to be when it has an unspecified end date.
                By default, if an Event Object has no end, it will appear to be 2 hours.
                This option only affects events that appear in the agenda slots, meaning they have allDay set to true.
                default: 120
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>firstHour</name>
            <classname>java.lang.Integer</classname>
            <description>
                Determines the first hour that will be visible in the scroll pane.
                Values must be from 0-23, where 0=midnight, 1=1am, etc.
                The user will be able to scroll upwards to see events before this time.
                If you want to prevent users from doing this, use the minTime option instead.
                default: 6
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>minTime</name>
            <classname>java.lang.String</classname>
            <description>
                Determines the first hour/time that will be displayed, even when the scrollbars have been scrolled all
                the way up.
                This can be a number like 5 (which means 5am), a string like '5:30' (which means 5:30am) or a string
                like '5:30am'.
                default: 0
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>maxTime</name>
            <classname>java.lang.String</classname>
            <description>
                Determines the last hour/time (exclusively) that will be displayed, even when the scrollbars have been
                scrolled all the way down.
                This can be a number like 22 (which means 10pm), a string like '22:30' (which means 10:30pm) or a string
                like '10:30pm'.
                default: 24
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>firstDay</name>
            <classname>java.lang.Integer</classname>
            <description>
                The day that each week begins.
                The value must be a number that represents the day of the week.
                Sunday=0, Monday=1, Tuesday=2, etc.
                default: 0
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>isRTL</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Displays the calendar in right-to-left mode.
                default: false
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>showWeekends</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Whether to include Saturday/Sunday columns in any of the calendar views.
                default: true
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>height</name>
            <classname>java.lang.Integer</classname>
            <description>
                Will make the entire calendar (including header) a pixel height.
                By default, this option is unset and the calendar's height is calculated by aspectRatio.
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>contentHeight</name>
            <classname>java.lang.Integer</classname>
            <description>
                Will make the calendar's content area a pixel height.
                By default, this option is unset and the calendar's height is calculated by aspectRatio.
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>aspectRatio</name>
            <classname>java.lang.Double</classname>
            <description>
                Determines the width-to-height aspect ratio of the calendar.
                A calendar is a block-level element that fills its entire avaiable width. The calendar’s height,
                however, is determined by this ratio of width-to-height. (Hint: larger numbers make smaller heights).
                default: 1.35
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>allDayByDefault</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Determines the default value for each Event Object's allDay property, when it is unspecified.
                default: true
            </description>
            <defaultvalue>null</defaultvalue>
        </property>

        <property>
            <name>editable</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Determines whether the events on the calendar can be modified.
                This determines if the events can be dragged and resized.
                Enables/disables both at the same time.
                If you don't want both, use editable in conjunction with disableDragging and disableResizing.
                This option can be overridden on a per-event basis with the Event Object editable property.
                default: false
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
bernard authored
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
            <name>selectable</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Allows a user to highlight multiple days or timeslots by clicking and dragging.
                To let the user make selections by clicking and dragging, this option must be set to true.
                default: false
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>selectHelper</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Whether to draw a "placeholder" event while the user is dragging.
                A value of true will draw a "placeholder" event while the user
                is dragging (similar to what Google Calendar does for its week
                and day views). A value of false (the default) will draw
                the standard highlighting over each cell.
                default: false
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>unselectAuto</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Whether clicking elsewhere on the page will cause the current
                selection to be cleared.
                This option can only take effect when selectable is set to true.
                default: true
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>unselectCancel</name>
            <classname>java.lang.String</classname>
            <description>
                A way to specify elements that will ignore the unselectAuto option.
                Clicking on elements that match this jQuery selector will prevent
                the current selection from being cleared (due to the unselectAuto option).
                This option is useful if you have a "Create an event" form that
                shows up in response to the user making a selection. When the user
                clicks on this form, you probably don't want to the current selection
                to go away. Thus, you should add a class to your form such as "my-form",
                and set the unselectAuto option to ".my-form".
                default: ''
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
bernard authored
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
            <name>disableDragging</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Disables all event dragging, even when events are editable.
                default: false
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>disableResizing</name>
            <classname>java.lang.Boolean</classname>
            <description>
                Disables all event resizing, even when events are editable.
                default: false
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>dragRevertDuration</name>
            <classname>java.lang.Integer</classname>
            <description>
                Time in millisecond it takes for an event to revert to its original position after an unsuccessful drag.
                default: 500
            </description>
            <defaultvalue>null</defaultvalue>
        </property>

        <property>
            <name>date</name>
            <classname>java.util.Date</classname>
            <description>
                The initial date when schedule loads.
                default:
                <i>current date</i>
            </description>
            <defaultvalue>null</defaultvalue>
        </property>

        <property>
            <name>onItemSelected</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onItemDragStart</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onItemDragStop</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onItemResizeStart</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onItemResizeStop</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onItemDrop</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onItemResized</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onItemMouseover</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onItemMouseout</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onViewDisplay</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
            <name>onDateSelected</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
bernard authored
544 545 546 547 548 549 550 551
            <name>onDateRangeSelected</name>
            <classname>java.lang.String</classname>
            <description>
                <!--TODO add description here-->
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <property>
bernard authored
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
            <name>styleClass</name>
            <classname>java.lang.String</classname>
            <description>
            </description>
            <defaultvalue>null</defaultvalue>
        </property>
        <!--TODO what about buttonText and other language dependant stuff? there is so many attributes there-->

        <property elonly="true" attachedstate="true">
            <name>itemMoveListener</name>
            <classname>javax.faces.el.MethodBinding</classname>
            <!--<methodargs>org.richfaces.component.event.ScheduleItemMoveEvent</methodargs>-->
            <returntype>boolean</returntype>
        </property>

        <property elonly="true" attachedstate="true">
            <name>itemResizeListener</name>
            <classname>javax.faces.el.MethodBinding</classname>
        </property>

        <property elonly="true" attachedstate="true">
            <name>itemSelectedListener</name>
            <classname>javax.faces.el.MethodBinding</classname>
        </property>

        <property elonly="true" attachedstate="true">
            <name>viewChangedListener</name>
            <classname>javax.faces.el.MethodBinding</classname>
        </property>

        <property elonly="true" attachedstate="true">
            <name>dateRangeChangedListener</name>
            <classname>javax.faces.el.MethodBinding</classname>
        </property>

        <property elonly="true" attachedstate="true">
bernard authored
588 589 590 591 592
            <name>dateRangeSelectedListener</name>
            <classname>javax.faces.el.MethodBinding</classname>
        </property>

        <property elonly="true" attachedstate="true">
bernard authored
593 594 595 596 597 598 599 600
            <name>dateSelectedListener</name>
            <classname>javax.faces.el.MethodBinding</classname>
        </property>


    </component>
    &listeners;
</components>