summaryrefslogtreecommitdiffstats
path: root/chrome/browser/resources/print_preview/margin_textbox.js
blob: 8e8948d9f82ef13ebda798c8abd8561ebeafcf8a (plain)
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
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

cr.define('print_preview', function() {
  'strict';

  function MarginTextbox(groupName) {
    var box = document.createElement('input');
    box.__proto__ = MarginTextbox.prototype;
    box.setAttribute('type', 'text');
    box.className = MarginTextbox.CSS_CLASS_MARGIN_TEXTBOX;
    box.value = '0';
    box.setAttribute('aria-label', localStrings.getString(groupName));

    // @type {string} Specifies which margin this line refers to.
    box.marginGroup = groupName;
    // @type {boolean} True if the displayed value is valid.
    box.isValid = true;
    // @type {number} Timer used to detect when the user stops typing.
    box.timerId_ = null;
    // @type {number} The last valid value in points.
    box.lastValidValueInPoints = 0;
    // @type {number} The upper allowed limit for the corresponding margin.
    box.valueLimit = null;

    box.addEventListeners_();
    return box;
  }

  MarginTextbox.CSS_CLASS_MARGIN_TEXTBOX = 'margin-box';
  // Keycode for the "Escape" key.
  MarginTextbox.ESCAPE_KEYCODE = 27;
  // Keycode for the "Enter" key.
  MarginTextbox.ENTER_KEYCODE = 13;

  MarginTextbox.prototype = {
    __proto__: HTMLInputElement.prototype,

    /**
     * @type {number} The margin value currently in the textbox.
     */
    get margin() {
      return print_preview.extractMarginValue(this.value);
    },

    /**
     * Sets the contents of the textbox.
     * @param {number} newValueInPoints The value to be displayed in points.
     * @private
     */
    setValue_: function(newValueInPoints) {
      this.value =
          print_preview.convertPointsToLocaleUnitsText(newValueInPoints);
    },

    /**
     * Updates the state of |this|.
     * @param {number} value The margin value in points.
     * @param {number} valueLimit The upper allowed value for the margin.
     * @param {boolean} keepDisplayedValue True if the currently displayed value
     *     should not be updated.
     */
    update: function(value, valueLimit, keepDisplayedValue) {
      this.lastValidValueInPoints = value;
      if (!keepDisplayedValue)
        this.setValue_(this.lastValidValueInPoints);

      this.valueLimit = valueLimit;
      this.validate();
    },

    /**
     * Updates |this| while dragging is in progress.
     * @param {number} dragDeltaInPoints The difference in points between the
     *     margin value before dragging started and now.
     */
    updateWhileDragging: function(dragDeltaInPoints) {
      var validity = this.validateDelta(dragDeltaInPoints);

      if (validity == print_preview.marginValidationStates.WITHIN_RANGE)
        this.setValue_(this.lastValidValueInPoints + dragDeltaInPoints);
      else if (validity == print_preview.marginValidationStates.TOO_SMALL)
        this.setValue_(0);
      else if (validity == print_preview.marginValidationStates.TOO_BIG)
        this.setValue_(this.valueLimit);

      this.validate();
      this.updateColor();
    },

    /**
     * @param {number} dragDeltaInPoints The difference in points between the
     *     margin value before dragging started and now.
     * @return {number} An appropriate value from enum |marginValidationStates|.
     */
    validateDelta: function(dragDeltaInPoints) {
      var newValue = this.lastValidValueInPoints + dragDeltaInPoints;
      return print_preview.validateMarginValue(newValue, this.valueLimit);
    },

    /**
     * Updates |this.isValid|.
     */
    validate: function() {
      this.isValid =
          print_preview.validateMarginText(this.value, this.valueLimit) ==
              print_preview.marginValidationStates.WITHIN_RANGE;
    },

    /**
     * Updates the background color depending on |isValid| by adding/removing
     * the appropriate CSS class.
     * @param {boolean} isValid True if the margin is valid.
     */
    updateColor: function() {
      this.isValid ? this.classList.remove('invalid') :
                     this.classList.add('invalid');
    },

    /**
     * Draws this textbox.
     */
    draw: function() {
      this.updateColor();
    },

    /**
     * Adds event listeners for various events.
     * @private
     */
    addEventListeners_: function() {
      this.oninput = this.resetTimer_.bind(this);
      this.onblur = this.onBlur_.bind(this);
      this.onkeypress = this.onKeyPressed_.bind(this);
      this.onkeyup = this.onKeyUp_.bind(this);
      this.onfocus = function() {
        cr.dispatchSimpleEvent(document, customEvents.MARGIN_TEXTBOX_FOCUSED);
      };
    },

    /**
     * Executes whenever a blur event occurs.
     * @private
     */
    onBlur_: function() {
      clearTimeout(this.timerId_);
      this.validate();
      if (!this.isValid) {
        this.setValue_(this.lastValidValueInPoints);
        this.validate();
      }

      this.updateColor();
      cr.dispatchSimpleEvent(document, customEvents.UPDATE_SUMMARY);
      cr.dispatchSimpleEvent(document, customEvents.UPDATE_PRINT_BUTTON);
      cr.dispatchSimpleEvent(this, customEvents.MARGINS_MAY_HAVE_CHANGED);
    },

    /**
     * Executes whenever a keypressed event occurs. Note: Only the "Enter" key
     * event is handled. The "Escape" key does not result in such event,
     * therefore it is handled by |this.onKeyUp_|.
     * @param {KeyboardEvent} e The event that triggered this listener.
     * @private
     */
    onKeyPressed_: function(e) {
      if (e.keyCode == MarginTextbox.ENTER_KEYCODE)
        this.blur();
    },

    /**
     * Executes whenever a keyup event occurs. Note: Only the "Escape"
     * key event is handled.
     * @param {KeyboardEvent} e The event that triggered this listener.
     * @private
     */
    onKeyUp_: function(e) {
      if (e.keyCode == MarginTextbox.ESCAPE_KEYCODE) {
        this.setValue_(this.lastValidValueInPoints);
        this.validate();
        this.updateColor();
        cr.dispatchSimpleEvent(document, customEvents.UPDATE_SUMMARY);
        cr.dispatchSimpleEvent(document, customEvents.UPDATE_PRINT_BUTTON);
      }
    },

    /**
     * Resetting the timer used to detect when the user stops typing in order
     * to update the print preview.
     * @private
     */
    resetTimer_: function() {
      clearTimeout(this.timerId_);
      this.timerId_ = window.setTimeout(
          this.onTextValueMayHaveChanged.bind(this), 1000);
    },

    /**
     * Executes whenever the user stops typing or when a drag session associated
     * with |this| ends.
     */
    onTextValueMayHaveChanged: function() {
      this.validate();
      this.updateColor();
      cr.dispatchSimpleEvent(document, customEvents.UPDATE_SUMMARY);
      cr.dispatchSimpleEvent(document, customEvents.UPDATE_PRINT_BUTTON);

      if (!this.isValid)
        return;
      cr.dispatchSimpleEvent(this, customEvents.MARGINS_MAY_HAVE_CHANGED);
    }

  };

  return {
    MarginTextbox: MarginTextbox
  };
});