sfExtjsThemePlugin: generator.yml

generator:
  class:              sfExtjsPropelAdminGenerator
  param:
    model_class:      sfJob
    theme:            extjs
    
    # This is used to get to the related editors
    related_tables:
      # A related table
      sf_job_queue:
        # The module with the tables editor
        module_name: sfExtjsJobQueue
        
    fields:
      sf_job_queue_id/name:
        name: Queue
        params:
          # Defines if the field is editable in the grid. Overwrites list_editable from app.yml
          editable: true
          # The renderer code returns the rendered value. The code is executed in a function(value, id, record) where:
          # - value is the field content
          # - id is the record id
          # - record is an array containing all the fields (e.g. record['sf_job_queue-scheduler_name'] returns the value
          #   of the next field in this list.
          # Therefore you can hide fields with list.hide or list.field.params.xtype: hidden and use them in renderers of other fields.
          renderer: "return value;"
      sf_job_queue_id/scheduler_name:
        name: Scheduler
        params:
          editable: false
          renderer: "return value;"
      sf_job_queue_id/status:
        name: Status
        params:
          editable: false
          renderer: "return value;"
      sf_job_queue_id/requested_status:
        name: Requested Status
        params:
          editable: false
          renderer: "return value;"
      name:
        name: Job name
        params:
          editable: true
          # The renderLink function used here is the default function to render
          # edit links. By default the returned link tries to use the addTab function
          # to open a new tab with the edit dialog.
          # To overwrite this behaivour with your own open dialog function, look at
          # 
          renderer: "return renderLink(value, id, record);"
      type:
        name: Type
        params:
          editable: true
      tries:
        name: Tries
        params:
          editable: false
      max_tries:
        name: Max tries
        help: Maximum tries of execution
        params:
          editable: true
      is_recurring:
        name: Recurring
        params:
          editable: true
          renderer: "return ((value == true) ? 'Yes' : 'No');" 
      retry_delay:
         name: Retry Del.
         params:
           editable: true
      params:
        name: Parameters
      message:
        name: Message
      priority:
        name: Priority
        params:
          editable: true
      created_at:
        name: Created
      scheduled_at:
        name: Scheduled
      completed_at:
        name: Completed
      last_tried_at:
        name: Last try
      status:
        name: Exit Status
        
    # In this section the grid view is configured. This includes grouping and actions. 
    list:
      # Title of the Grid. Displayed on the border panel if available.
      title: Job Overview
      
      # If true, selecting multiple items is turned OFF.
      single_select: false
      # The id of a column in this grid that should expand to fill unused space
      auto_expand_column: params

      # Array of fields to be displayed in hidden rows.
      hide: []
      # Array of fields to be displayed in the grid rows.
      display: [ =name, type, tries, max_tries, is_recurring, retry_delay, params, priority, created_at, scheduled_at, last_tried_at, status]
      
      # Grouping options.
      grouping:
        # Make groups out of this fields value.
        field: sf_job_queue_id/name
        # Array of fields displayed in the group header. See list.fields below for formating options.
        display: [sf_job_queue_id/name, sf_job_queue_id/scheduler_name, sf_job_queue_id/status, sf_job_queue_id/requested_status ]
        # Groups are collapsable when true. No option to collapse groups when false.
        collapsable: true
        # An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.
        plugins: []
        
      # Fields to put filters on. The filters are shown in a tab if list_tabbed is true filter_add_handler emptied in app.yml
      # if filter_add_hander is defined as a function(component) then the filter panel is passed to this function. (which can display it somewhere else)
      filters: [ name, type, priority, created_at, scheduled_at, last_tried_at, status]
      
      # Peer method for pager defaults to doSelectJoinAll
      # peer_method: doLeftJoinJobQueue
      # Peer method for pager count.
      # peer_count_method:
      
      # Settings for field behaivour in list view.
      fields:
        sf_job_queue_id/name:
          # Gives the credentials for the field view.
          # credentials:
          # Name definition also possible here
          # name: 
          # Disable the filter for this field. Doesn't work.
          filter_criteria_disabled: false
          # Joins this field value out of two fields. 
          # join_fields
          params:
            # Give the field a custom ID.
            # id:
            # Give the field a custom width.
            # width:
            # Prefix to write before the value. Plain HTML.
            header_valuePrefix: "<b>Queue: "
            # Prefix to write after the value. Plain HTML
            header_valueSuffix: "</b> "
        sf_job_queue_id/scheduler_name:
          params:
            header_valuePrefix: "(<small>Scheduler: "
            header_valueSuffix:
        sf_job_queue_id/status:
          params:
            header_valuePrefix: ", Status: "
            header_valueSuffix:
        sf_job_queue_id/requested_status:
          params:
            header_valuePrefix: ", Requested Status: "
            header_valueSuffix: "</small>)"
        # now imagine, we have a field "message" which we want to show with tinyMCE in the 
        # EDITOR: This code would stand here: (and remember that you have to set use_tinymce true in app.yml)
        # message:
          # params:
            # plugins: [mceEditor]
            #   height: 
            #   width:
            #   xtype:
            # What's the value here?
            #   tinymceSettings:
      
      # List parameters
      params:
        # Default sortable of columns which have no sortable specified (defaults to false)
        default_sortable: true
      
      # The click handler can be used to overwrite the default link given by renderLink renderer.
      # To do so, give grid_open_link (in app.yml) a function(target) and execute the click handler.
      # Execute click handlers.
      object_click: true
      # Execute double click handler
      object_dblclick: true
      # Turn on the context menu.
      
      object_contextmenu:
        # The first menu item
        restartJob:
          # Menu item name.
          name: Restart Job
          # You can define your own icon for the menu action.
          # icon: /path/to/icon
          # Handler function. Called when menu item is clicked.
          handler: "sfExtjsApp.runAction('sfExtjsJob/restart', 'Restart Job');"
        restartQueue:
          name: Restart Queue
          handler: "sfExtjsApp.runAction('sfExtjsJob/restart', 'Restart Job');"
        # This are the predefined menu items for the context menu.
        # _edit:
        #   # Edit has a custom name.
        #   name: Edit this job
        # Delete is not implemented yet.
        # _delete: -
      
      
      # All the actions in the list toolbar. Actions with an _ are predefined.
      # The actions use grid_open_link to open if it is defined in app.yml 
      actions:
        # Predefined create action.
        _create:
          # Custom name for create dialog
          name: Add new Job
        # Predefined delete action with no special settings.
        _delete: -
        # Predefined separator (vert. line).
        _separator: -
        # A custom action
        create_Queue:
          name: Add a new Queue
          # Credentials don't work here yet.
          # credentials: admin
          # handler_function: "alert('Handler pressed');"
          # If list_action_handler is defined as a function(url, action_name, action_title)
          # then you can specify the url parameter throught this handler_url directive:
          # (the other params are filled throught the configuration: action_name = create_Queue, 
          # action_title = "Add a new Queue" in this case)  
          handler_url: "sfExtjsJobQueue/create"
          # The button class: could be btn_create, btn_delete, btn_print, btn_refresh
          class: btn_create
        # Predefined refresh button / action.
        _refresh: -
        # Fills out all unused space in the toolbar.
        _fill: -
        # Opens a html table view which is printable.
        _print: -
        # Hooks to copy and edit a pdf-generator partial.
        _pdf: -
        
    # In this section the edit dialog is configured.
    edit:
      # Title of the Edit window
      title: Edit Job %%name%%
      # Title of the create window
      newtitle: Add new Job
      
      # Array of lists to display
      display: [ sf_job_queue_id/name, =name, type ]
      # Pages are sections of the edit window shown in tabs.
      pages:
        # A page.
        run_configuration:
          # Tab name.
          title: Run Configuration
          # Array of fields on tab.
          display: [ max_tries, is_recurring, retry_delay, priority ]
        parameters:
          title: Job Parameters
          display: [ params ]
        creation_date:
          title: Just to mess with dates
          display: [created_at]
      
      # Actions, only for non-ajax mode.
      # actions:
      #   _save: -
      #   _cancel: -
        
      # Fields in edit pages
      fields:
        # First Field. In this case defined as date in schema.yml
        created_at:
          # Tooltip on edit form.
          help: Override job creation date.
          # somehow this date field is broken and does not load it's value.
          params:
            # The default date format string which can be overriden for localization support. The format must be valid according to Date.parseDate (defaults to 'm/d/y').
            date_format: d.m.y
            # The minimum allowed date. Can be either a Javascript date object or a string date in a valid format (defaults to null).
            # date_min_value: 01/01/2008
            # An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).
            # Currently broken: date_disabled_days: [ 0, 1 ]
            # The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')
            # date_disabled_days_text: You can't create Jobs on saturdays and sundays.
        sf_job_queue_id/name:
          # This is buggy on foreign fields. ToolTip from field "name" is taken.
          help: Select a queue for your job.
        name:
          help: Select a name for your job.
          params:
            required: true
        type:
          name: Job Type
          help: Define a job type
        # fieldname:
        #   name: Name Shown
        #   class: hidden
        # Upload Field
        # upload:
        #   name: Upload file
        #   Only for non-ajax:
        #   upload_dir: 
        #