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: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Forms\Field\Props;

/**
 * Trait for classes:
 * - `\MvcCore\Ext\Forms\Fields\Button`
 *    - `\MvcCore\Ext\Forms\Fields\SubmitButton`
 *    - `\MvcCore\Ext\Forms\Fields\ResetButton`
 * - `\MvcCore\Ext\Forms\Fields\Color`
 * - `\MvcCore\Ext\Forms\Fields\Date`
 *    - `\MvcCore\Ext\Forms\Fields\DateTime`
 *    - `\MvcCore\Ext\Forms\Fields\Month`
 *    - `\MvcCore\Ext\Forms\Fields\Time`
 *    - `\MvcCore\Ext\Forms\Fields\Week`
 * - `\MvcCore\Ext\Forms\Fields\File`
 * - `\MvcCore\Ext\Forms\Fields\Checkbox`
 * - `\MvcCore\Ext\Forms\Fields\Image`
 * - `\MvcCore\Ext\Forms\Fields\Number`
 *    - `\MvcCore\Ext\Forms\Fields\Range`
 * - `\MvcCore\Ext\Forms\Fields\ResetInput`
 * - `\MvcCore\Ext\Forms\Fields\Select`
 *    - `\MvcCore\Ext\Forms\Fields\CountrySelect`
 * - `\MvcCore\Ext\Forms\Fields\SubmitInput`
 * - `\MvcCore\Ext\Forms\Fields\Text`
 *    - `\MvcCore\Ext\Forms\Fields\Email`
 *    - `\MvcCore\Ext\Forms\Fields\Password`
 *    - `\MvcCore\Ext\Forms\Fields\Search`
 *    - `\MvcCore\Ext\Forms\Fields\Tel`
 *    - `\MvcCore\Ext\Forms\Fields\Url`
 * - `\MvcCore\Ext\Forms\Fields\Textarea`
 * - `\MvcCore\Ext\Forms\FieldsGroup`
 *    - `\MvcCore\Ext\Forms\CheckboxGroup`
 *    - `\MvcCore\Ext\Forms\RadioGroup`
 */
trait TabIndex {

    /**
     * An integer attribute indicating if the element can take input focus (is focusable), 
     * if it should participate to sequential keyboard navigation, and if so, at what 
     * position. You can set `auto` string value to get next form tab-index value automatically. 
     * Tab-index for every field in form is better to index from value `1` or automatically and 
     * moved to specific higher value by place, where is form currently rendered by form 
     * instance method `$form->SetBaseTabIndex()` to move tab-index for each field into 
     * final values. Tab-index can takes several values:
     * - a negative value means that the element should be focusable, but should not be 
     *   reachable via sequential keyboard navigation;
     * - 0 means that the element should be focusable and reachable via sequential 
     *   keyboard navigation, but its relative order is defined by the platform convention;
     * - a positive value means that the element should be focusable and reachable via 
     *   sequential keyboard navigation; the order in which the elements are focused is 
     *   the increasing value of the tab-index. If several elements share the same tab-index, 
     *   their relative order follows their relative positions in the document.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-tab-index
     * @var int|string|NULL
     */
    protected $tabIndex = NULL;

    /**
     * Get an integer attribute indicating if the element can take input focus (is focusable), 
     * if it should participate to sequential keyboard navigation, and if so, at what 
     * position. You can set `auto` string value to get next form tab-index value automatically. 
     * Tab-index for every field in form is better to index from value `1` or automatically and 
     * moved to specific higher value by place, where is form currently rendered by form 
     * instance method `$form->SetBaseTabIndex()` to move tab-index for each field into 
     * final values. Tab-index can takes several values:
     * - a negative value means that the element should be focusable, but should not be 
     *   reachable via sequential keyboard navigation;
     * - 0 means that the element should be focusable and reachable via sequential 
     *   keyboard navigation, but its relative order is defined by the platform convention;
     * - a positive value means that the element should be focusable and reachable via 
     *   sequential keyboard navigation; the order in which the elements are focused is 
     *   the increasing value of the tab-index. If several elements share the same tab-index, 
     *   their relative order follows their relative positions in the document.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-tab-index
     * @return int|string|NULL
     */
    public function GetTabIndex () {
        return $this->tabIndex;
    }

    /**
     * Set an integer attribute indicating if the element can take input focus (is focusable), 
     * if it should participate to sequential keyboard navigation, and if so, at what 
     * position. You can set `auto` string value to get next form tab-index value automatically. 
     * Tab-index for every field in form is better to index from value `1` or automatically and 
     * moved to specific higher value by place, where is form currently rendered by form 
     * instance method `$form->SetBaseTabIndex()` to move tab-index for each field into 
     * final values. Tab-index can takes several values:
     * - a negative value means that the element should be focusable, but should not be 
     *   reachable via sequential keyboard navigation;
     * - 0 means that the element should be focusable and reachable via sequential 
     *   keyboard navigation, but its relative order is defined by the platform convention;
     * - a positive value means that the element should be focusable and reachable via 
     *   sequential keyboard navigation; the order in which the elements are focused is 
     *   the increasing value of the tab-index. If several elements share the same tab-index, 
     *   their relative order follows their relative positions in the document.
     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-tab-index
     * @param int|string $tabIndex 
     * @return \MvcCore\Ext\Forms\Field
     */
    public function SetTabIndex ($tabIndex = 'auto') {
        /** @var $this \MvcCore\Ext\Forms\Field */
        if ($tabIndex === 'auto' || is_int($tabIndex)) {
            $this->tabIndex = $tabIndex;
        } else {
            $this->throwNewInvalidArgumentException(
                'Property `tabindex` is possible to configure only with `auto` string or integer. `'.$tabIndex.'` value given.'
            );
        }
        return $this;
    }

    /**
     * Check after field is added into form, if field 
     * has defined any value for pattern property and if it does,
     * add automatically build in pattern validator.
     * @return void
     */
    protected function preDispatchTabIndex () {
        if ($this->tabIndex === 'auto') 
            $this->tabIndex = $this->form->GetFieldNextAutoTabIndex();
    }
}