← Back to branch summary

~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to lib/lp/app/javascript/configutils.js

  • Committer: Launchpad Patch Queue Manager
  • Date: 2011-04-12 13:17:34 UTC
  • mfrom: (12775.3.11 bug-736002)
  • Revision ID: launchpad@pqm.canonical.com-20110412131734-td8mjeehq8z93uzs
[r=jtv][bug=736002] Speed up +bugtarget-portlet-tags-content.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/lp/app/javascript/configutils.js
1
 
/* Copyright (c) 2011, Canonical Ltd. All rights reserved. */
2
 
 
3
 
YUI().add('lp.configutils', function(Y) {
4
 
    /**
5
 
     * The configutils module provides objects for managing the config
6
 
     * or settings of a web page or widget.
7
 
     *
8
 
     * Widgets that want to be accessed from a settings/config
9
 
     * icon should extend BaseConfigUtil and provide a callback that
10
 
     * will run when the icon is clicked.
11
 
     *
12
 
     * @module lp.configutils
13
 
     */
14
 
 
15
 
    // Constants
16
 
    var CONTENT_BOX = 'contentBox',
17
 
        EMPTY_FN = function() {};
18
 
 
19
 
    /**
20
 
     * BaseConfigUtil is the base object that every FooConfigUtil
21
 
     * object should extend.
22
 
     *
23
 
     * @class BaseConfigUtil
24
 
     * @extends Widget
25
 
     * @constructor
26
 
     */
27
 
    function BaseConfigUtil() {
28
 
        BaseConfigUtil.superclass.constructor.apply(this, arguments);
29
 
    }
30
 
 
31
 
    BaseConfigUtil.NAME = 'baseconfigutil';
32
 
 
33
 
    BaseConfigUtil.ATTRS = {
34
 
        /**
35
 
         * A reference to the anchor element created during renderUI.
36
 
         *
37
 
         * @attribute anchor
38
 
         * @type Y.Node
39
 
         * @default null
40
 
         */
41
 
        anchor: {
42
 
            value: null
43
 
        }
44
 
    };
45
 
 
46
 
    Y.extend(BaseConfigUtil, Y.Widget, {
47
 
 
48
 
        /**
49
 
         * Hook for subclasses to do something when the settings
50
 
         * icon is clicked.
51
 
         */
52
 
        _handleClick: EMPTY_FN,
53
 
 
54
 
        /**
55
 
         * Hook for subclasses to do work after renderUI.
56
 
         */
57
 
        _extraRenderUI: EMPTY_FN,
58
 
 
59
 
        /**
60
 
         * Create the anchor element that will display the settings icon.
61
 
         *
62
 
         * @method renderUI
63
 
         */
64
 
        renderUI: function() {
65
 
            var anchor = Y.Node.create(
66
 
                '<a></a>').addClass('sprite').addClass('config');
67
 
            anchor.set('title', 'Customise visible bug information');
68
 
            this.set('anchor', anchor);
69
 
            var content = this.get(CONTENT_BOX);
70
 
            content.append(anchor);
71
 
            this._extraRenderUI();
72
 
        },
73
 
 
74
 
        /**
75
 
         * Wire up the anchor element to _handleClick.
76
 
         *
77
 
         * Objects that extend BaseConfigUtil should create their own
78
 
         * _handleClick method.
79
 
         *
80
 
         * @method bindUI
81
 
         */
82
 
        bindUI: function() {
83
 
            // Do some work here to set up click handlers.
84
 
            // Add the a element to ATTRS.
85
 
            var anchor = this.get('anchor');
86
 
            var that = this;
87
 
            anchor.on('click', function(e) {
88
 
                that._handleClick(e);
89
 
            });
90
 
        }
91
 
 
92
 
    });
93
 
 
94
 
    var configutils = Y.namespace('lp.configutils');
95
 
    configutils.BaseConfigUtil = BaseConfigUtil;
96
 
 
97
 
}, '0.1', {'requires': ['widget']});