Schedule - Context Menu

4 Dec 201713 minutes to read

Scheduler provides default context menu options for both appointments as well as work cells. It also allows to define additional custom context menu options.

The options that are available under contextMenuSettings are as follows,

enable - Enables/disables the context menu option in Scheduler.
menuItems - Contains the sub-menu collections related to both the appointment and cells.

The menu items contains two separate collection based on the appointment and cells.

Appointment

The appointment collection includes the following options.

Open Appointment (default)

Delete Appointment (default)

Print Appointment

Categorize

Cells

The default options available within the cell collection includes -

New Appointment

New Recurring Appointment

Today

Go to date

Settings (View, TimeMode, Work Hours)

The following code snippet shows how to enable the context menu settings in Scheduler and to make use of it with default available options.

JAVASCRIPT

<?php
    require_once '../EJ/AutoLoad.php';

    $data = array(
        array(
            'Id' => 1,
            'Subject' => 'Music Class',
            'StartTime' => new DateTime('2016/5/5 12:00'),
            'EndTime' => new DateTime('2016/5/5 14:30')
        )
    );
    $menuData = '{
        appointment: [
            { "id": "open", "text": "Open Appointment" },
            { "id": "delete", "text": "Delete Appointment" }
        ],
        cells: [
            { "id": "new", "text": "New Appointment" },
            { "id": "recurrence", "text": "New Recurring Appointment" },
            { "id": "today", "text": "Today" },
            { "id": "goToDate", "text": "Go to date" },
            { "id": "settings", "text": "Settings" },
            { "id": "view", "text": "View", "parentId": "settings" },
            { "id": "timeMode", "text": "TimeMode", "parentId": "settings" },
            { "id": "view_Day", "text": "Day", "parentId": "view" },
            { "id": "view_Week", "text": "Week", "parentId": "view" },
            { "id": "view_Workweek", "text": "Workweek", "parentId": "view" },
            { "id": "view_Month", "text": "Month", "parentId": "view" },
            { "id": "timeMode_Hour12", "text": "12 Hours", "parentId": "timeMode" },
            { "id": "timeMode_Hour24", "text": "24 Hours", "parentId": "timeMode" },
            { "id": "workhours", "text": "Work Hours", "parentId": "settings" }
        ]
    }';
    $contextData = new EJ\Schedule\ContextMenuSetting();
    $contextData->enable(true)->menuItems($menuData);

    $appointment = new EJ\Schedule\AppointmentSetting();
    $appointment->dataSource($data);

    $schedule = new EJ\Schedule('defaultSchedule');
    echo $schedule->width('100%')->height('525px')->currentDate(new DateTime('2017/6/5'))->contextMenuSettings($contextData)->appointmentSettings($appointment)->render();
?>

NOTE

In agenda view, only the appointment menu items shows up in the context menu options. For default menu items, the id must be defined the same as mentioned in the above code example – as we have processed the menus based on this id within our source.

Apart from the default available options, it is also possible to add custom menu options to the context-menu of both the appointment and cell collection.

The following code example depicts how to add the custom menu items to the appointment and cell collection of the context menu settings.

JAVASCRIPT

<?php
    require_once '../EJ/AutoLoad.php';

    $data = array(
        array(
            'Id' => 1,
            'Subject' => 'Music Class',
            'StartTime' => new DateTime('2016/5/5 12:00'),
            'EndTime' => new DateTime('2016/5/5 14:30')
        )
    );
    $menuData = '{
        appointment: [
            { "id": "open", "text": "Open Appointment" },
            { "id": "delete", "text": "Delete Appointment" },
            { "id": "option1", "text": "User Option 1" }
        ],
        cells: [
            { "id": "celloption1", "text": "Custom Option 1" }
        ]
    }';
    $contextData = new EJ\Schedule\ContextMenuSetting();
    $contextData->enable(true)->menuItems($menuData);

    $appointment = new EJ\Schedule\AppointmentSetting();
    $appointment->dataSource($data);

    $schedule = new EJ\Schedule('defaultSchedule');
    echo $schedule->width('100%')->height('525px')->currentDate(new DateTime('2017/6/5'))->contextMenuSettings($contextData)->appointmentSettings($appointment)->render();
?>

NOTE

The id given for the custom menu items must be unique in both the appointment and cell collection.

To define specific actions for a click made on the custom menu items, the client-side event menuItemClick can be used as depicted in the below code example.

JAVASCRIPT

<?php
    require_once '../EJ/AutoLoad.php';

    $data = array(
        array(
            'Id' => 1,
            'Subject' => 'Music Class',
            'StartTime' => new DateTime('2016/5/5 12:00'),
            'EndTime' => new DateTime('2016/5/5 14:30')
        )
    );
    $menuData = '{
        appointment: [
            { "id": "open", "text": "Open Appointment" },
            { "id": "delete", "text": "Delete Appointment" },
            { "id": "option1", "text": "User Option 1" }
        ]
    }';
    $contextData = new EJ\Schedule\ContextMenuSetting();
    $contextData->enable(true)->menuItems($menuData);

    $appointment = new EJ\Schedule\AppointmentSetting();
    $appointment->dataSource($data);

    $schedule = new EJ\Schedule('defaultSchedule');
    echo $schedule->width('100%')->height('525px')->currentDate(new DateTime('2017/6/5'))->contextMenuSettings($contextData)->appointmentSettings($appointment)->menuItemClick('onMenuItemClick')->render();
?>

function onMenuItemClick(args) {
    //args.events contains information of the clicked menu item.
    if (args.events.ID == "option1")
        alert("Custom menu clicked");
}

Also, it is possible to predict the target on which the right click is made, either on the cells or appointments with the use of the event beforeContextMenuOpen. The below code example shows how to block the display of context menu, when right clicked on the cells by setting args.cancel as true.

JAVASCRIPT

<?php
    require_once '../EJ/AutoLoad.php';

    $data = array(
        array(
            'Id' => 1,
            'Subject' => 'Music Class',
            'StartTime' => new DateTime('2016/5/5 12:00'),
            'EndTime' => new DateTime('2016/5/5 14:30')
        )
    );
    $menuData = '{
        appointment: [
            { "id": "open", "text": "Open Appointment" },
            { "id": "delete", "text": "Delete Appointment" },
            { "id": "option1", "text": "User Option 1" }
        ]
    }';
    $contextData = new EJ\Schedule\ContextMenuSetting();
    $contextData->enable(true)->menuItems($menuData);

    $appointment = new EJ\Schedule\AppointmentSetting();
    $appointment->dataSource($data);

    $schedule = new EJ\Schedule('defaultSchedule');
    echo $schedule->width('100%')->height('525px')->currentDate(new DateTime('2017/6/5'))->contextMenuSettings($contextData)->appointmentSettings($appointment)->beforeContextMenuOpen('onBeforeContextMenuOpen')->render();
?>

function onBeforeContextMenuOpen(args) {
    //args.events.target – target information to depict either cell/appointment
    if ($(args.events.target).hasClass("e-workcells") || $(args.events.target).hasClass("e-monthcells"))
        args.cancel = true;
}

Adding Categorize Option

To include the default categorize option within the context menu, it is necessary to enable the categorizeSettings property as shown in the below code example.

JAVASCRIPT

<?php
    require_once '../EJ/AutoLoad.php';

    $data = array(
        array(
            'Id' => 1,
            'Subject' => 'Music Class',
            'StartTime' => new DateTime('2016/5/5 12:00'),
            'EndTime' => new DateTime('2016/5/5 14:30')
        )
    );
    $menuData = '{
        appointment: [
            { "id": "open", "text": "Open Appointment" },
            { "id": "delete", "text": "Delete Appointment" },
            { "id": "categorize", "text": "Categorize" }
        ]
    }';
    $contextData = new EJ\Schedule\ContextMenuSetting();
    $contextData->enable(true)->menuItems($menuData);

    $categorizeData = new EJ\Schedule\CategorizeSetting();
    $categorizeData->enable(true);

    $appointment = new EJ\Schedule\AppointmentSetting();
    $appointment->dataSource($data);

    $schedule = new EJ\Schedule('defaultSchedule');
    echo $schedule->width('100%')->height('525px')->currentDate(new DateTime('2017/6/5'))->contextMenuSettings($contextData)->categorizeSettings($categorizeData)->appointmentSettings($appointment)->render();
?>

NOTE

The categorize option must be added only to the appointment collection, which displays on right clicking the appointments.

Context Menu

Default Menu Options

Appointment

Cells

Custom Menu Options

Handling Menu Actions

Adding Categorize Option