Files
gerrit/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api.js
Viktar Donich cf9b55c704 plugin.deprecated.onAction partial support
As a part of "stepping stone" to simplify migration of plugins that
target GWT UI primarily. Provides self.deprecated.install method that
moves deprecated API such as `self.deprecated.popup()` and
`self.deprecated.onAction()` to `self.popup()` and `self.onAction()`
respectively.

``` js
Gerrit.install(plugin => {
  if (Polymer) {
    // Promote deprecated APIs to default locations.
    // Not recommended, only as a part of migrating GWT plugins to PG UI.
    plugin.deprecated.install();
  }
  plugin.onAction('change', 'find-owners', (context) => {
    console.log(context.change);
    console.log(context.revision);
  });
});
```

Provides partial support for self.onAction with methods:
- popup(element)
- hide()
- refresh()
- textfield()
- br()
- msg(text)
- div(...elements)
- button(label, callbacks)
- checkbox()
- label(checkbox, title)
- call(payload, onSuccess)

Populates plugin-provided change revision actions and puts them in
overflow menu.

Feature: Issue 5329
Change-Id: Id4528de9e48469d67904cfda8d1c5a22b15e8311
(cherry picked from commit 172acf7e18)
2017-12-05 15:07:19 +01:00

84 lines
2.7 KiB
JavaScript

// Copyright (C) 2016 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
(function(window) {
'use strict';
function GrChangeActionsInterface(plugin, el) {
this.plugin = plugin;
this._el = el;
this.RevisionActions = el.RevisionActions;
this.ChangeActions = el.ChangeActions;
this.ActionType = el.ActionType;
}
GrChangeActionsInterface.prototype.addPrimaryActionKey = function(key) {
if (this._el.primaryActionKeys.includes(key)) { return; }
this._el.push('primaryActionKeys', key);
};
GrChangeActionsInterface.prototype.removePrimaryActionKey = function(key) {
this._el.primaryActionKeys = this._el.primaryActionKeys.filter(k => {
return k !== key;
});
};
GrChangeActionsInterface.prototype.setActionOverflow = function(type, key,
overflow) {
return this._el.setActionOverflow(type, key, overflow);
};
GrChangeActionsInterface.prototype.setActionPriority = function(type, key,
priority) {
return this._el.setActionPriority(type, key, priority);
};
GrChangeActionsInterface.prototype.setActionHidden = function(type, key,
hidden) {
return this._el.setActionHidden(type, key, hidden);
};
GrChangeActionsInterface.prototype.add = function(type, label) {
return this._el.addActionButton(type, label);
};
GrChangeActionsInterface.prototype.remove = function(key) {
return this._el.removeActionButton(key);
};
GrChangeActionsInterface.prototype.addTapListener = function(key, handler) {
this._el.addEventListener(key + '-tap', handler);
};
GrChangeActionsInterface.prototype.removeTapListener = function(key,
handler) {
this._el.removeEventListener(key + '-tap', handler);
};
GrChangeActionsInterface.prototype.setLabel = function(key, text) {
this._el.setActionButtonProp(key, 'label', text);
};
GrChangeActionsInterface.prototype.setEnabled = function(key, enabled) {
this._el.setActionButtonProp(key, 'enabled', enabled);
};
GrChangeActionsInterface.prototype.getActionDetails = function(action) {
return this._el.getActionDetails(action) ||
this._el.getActionDetails(this.plugin.getPluginName() + '~' + action);
};
window.GrChangeActionsInterface = GrChangeActionsInterface;
})(window);