Skip to content

Commit f7abdc9

Browse files
jasongroutjasongrout
authored
Merge pull request #3118 from davidbrochart/rename_pwidget
Rename pWidget to lmWidget
2 parents 2bcc618 + e6f9f37 commit f7abdc9

File tree

11 files changed

+91
-76
lines changed

11 files changed

+91
-76
lines changed

‎packages/base/src/widget.ts

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -886,6 +886,16 @@ export class DOMWidgetView extends WidgetView {
886886
this.updateTooltip();
887887
}
888888

889+
/**
890+
* Getter for backward compatibility.
891+
*
892+
* pWidget is deprecated and will be removed in the future,
893+
* please use lmWidget instead.
894+
*/
895+
get pWidget(): Widget {
896+
return this.lmWidget;
897+
}
898+
889899
setLayout(layout: LayoutModel, oldLayout?: LayoutModel): void {
890900
if (layout) {
891901
this.layoutPromise = this.layoutPromise.then(oldLayoutView => {
@@ -904,12 +914,12 @@ export class DOMWidgetView extends WidgetView {
904914
// Post (asynchronous) so layout changes can take
905915
// effect first.
906916
MessageLoop.postMessage(
907-
this.pWidget,
917+
this.lmWidget,
908918
Widget.ResizeMessage.UnknownSize
909919
);
910920
});
911921
MessageLoop.postMessage(
912-
this.pWidget,
922+
this.lmWidget,
913923
Widget.ResizeMessage.UnknownSize
914924
);
915925
return view;
@@ -1034,21 +1044,21 @@ export class DOMWidgetView extends WidgetView {
10341044
}
10351045

10361046
_setElement(el: HTMLElement): void {
1037-
if (this.pWidget) {
1038-
this.pWidget.dispose();
1047+
if (this.lmWidget) {
1048+
this.lmWidget.dispose();
10391049
}
10401050

10411051
this.$el = el instanceof $ ? el : $(el);
10421052
this.el = this.$el[0];
1043-
this.pWidget = new JupyterLuminoWidget({
1053+
this.lmWidget = new JupyterLuminoWidget({
10441054
node: el,
10451055
view: this
10461056
});
10471057
}
10481058

10491059
remove(): any {
1050-
if (this.pWidget) {
1051-
this.pWidget.dispose();
1060+
if (this.lmWidget) {
1061+
this.lmWidget.dispose();
10521062
}
10531063
return super.remove();
10541064
}
@@ -1063,9 +1073,9 @@ export class DOMWidgetView extends WidgetView {
10631073

10641074
private _comm_live_update(): void {
10651075
if (this.model.comm_live) {
1066-
this.pWidget.removeClass('jupyter-widgets-disconnected');
1076+
this.lmWidget.removeClass('jupyter-widgets-disconnected');
10671077
} else {
1068-
this.pWidget.addClass('jupyter-widgets-disconnected');
1078+
this.lmWidget.addClass('jupyter-widgets-disconnected');
10691079
}
10701080
}
10711081

@@ -1081,7 +1091,7 @@ export class DOMWidgetView extends WidgetView {
10811091
}
10821092
el: HTMLElement; // Override typing
10831093
'$el': any;
1084-
pWidget: Widget;
1094+
lmWidget: Widget;
10851095
layoutPromise: Promise<any>;
10861096
stylePromise: Promise<any>;
10871097
}

‎packages/controls/src/widget_audio.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export class AudioView extends DOMWidgetView {
3535
* Called when view is rendered.
3636
*/
3737
super.render();
38-
this.pWidget.addClass('jupyter-widgets');
38+
this.lmWidget.addClass('jupyter-widgets');
3939
this.update(); // Set defaults.
4040
}
4141

‎packages/controls/src/widget_box.ts

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,18 @@ export class VBoxModel extends BoxModel {
6060

6161
export class BoxView extends DOMWidgetView {
6262
_createElement(tagName: string): HTMLElement {
63-
this.pWidget = new JupyterLuminoPanelWidget({ view: this });
64-
return this.pWidget.node;
63+
this.lmWidget = new JupyterLuminoPanelWidget({ view: this });
64+
return this.lmWidget.node;
6565
}
6666

6767
_setElement(el: HTMLElement): void {
68-
if (this.el || el !== this.pWidget.node) {
68+
if (this.el || el !== this.lmWidget.node) {
6969
// Boxes don't allow setting the element beyond the initial creation.
7070
throw new Error('Cannot reset the DOM element.');
7171
}
7272

73-
this.el = this.pWidget.node;
74-
this.$el = $(this.pWidget.node);
73+
this.el = this.lmWidget.node;
74+
this.$el = $(this.lmWidget.node);
7575
}
7676

7777
initialize(parameters: WidgetView.IInitializeParameters): void {
@@ -80,9 +80,9 @@ export class BoxView extends DOMWidgetView {
8080
this.listenTo(this.model, 'change:children', this.update_children);
8181
this.listenTo(this.model, 'change:box_style', this.update_box_style);
8282

83-
this.pWidget.addClass('jupyter-widgets');
84-
this.pWidget.addClass('widget-container');
85-
this.pWidget.addClass('widget-box');
83+
this.lmWidget.addClass('jupyter-widgets');
84+
this.lmWidget.addClass('widget-container');
85+
this.lmWidget.addClass('widget-box');
8686
}
8787

8888
render(): void {
@@ -98,7 +98,7 @@ export class BoxView extends DOMWidgetView {
9898
// Notify all children that their sizes may have changed.
9999
views.forEach(view => {
100100
MessageLoop.postMessage(
101-
view.pWidget,
101+
view.lmWidget,
102102
Widget.ResizeMessage.UnknownSize
103103
);
104104
});
@@ -117,13 +117,13 @@ export class BoxView extends DOMWidgetView {
117117
// we insert a dummy element so the order is preserved when we add
118118
// the rendered content later.
119119
const dummy = new Widget();
120-
this.pWidget.addWidget(dummy);
120+
this.lmWidget.addWidget(dummy);
121121

122122
return this.create_child_view(model)
123123
.then((view: DOMWidgetView) => {
124124
// replace the dummy widget with the new one.
125-
const i = ArrayExt.firstIndexOf(this.pWidget.widgets, dummy);
126-
this.pWidget.insertWidget(i, view.pWidget);
125+
const i = ArrayExt.firstIndexOf(this.lmWidget.widgets, dummy);
126+
this.lmWidget.insertWidget(i, view.lmWidget);
127127
dummy.dispose();
128128
return view;
129129
})
@@ -137,6 +137,7 @@ export class BoxView extends DOMWidgetView {
137137

138138
children_views: ViewList<DOMWidgetView> | null;
139139
pWidget: JupyterLuminoPanelWidget;
140+
lmWidget: JupyterLuminoPanelWidget;
140141

141142
static class_map = {
142143
success: ['alert', 'alert-success'],
@@ -152,7 +153,7 @@ export class HBoxView extends BoxView {
152153
*/
153154
initialize(parameters: WidgetView.IInitializeParameters): void {
154155
super.initialize(parameters);
155-
this.pWidget.addClass('widget-hbox');
156+
this.lmWidget.addClass('widget-hbox');
156157
}
157158
}
158159

@@ -162,7 +163,7 @@ export class VBoxView extends BoxView {
162163
*/
163164
initialize(parameters: WidgetView.IInitializeParameters): void {
164165
super.initialize(parameters);
165-
this.pWidget.addClass('widget-vbox');
166+
this.lmWidget.addClass('widget-vbox');
166167
}
167168
}
168169

@@ -172,9 +173,9 @@ export class GridBoxView extends BoxView {
172173
*/
173174
initialize(parameters: WidgetView.IInitializeParameters): void {
174175
super.initialize(parameters);
175-
this.pWidget.addClass('widget-gridbox');
176+
this.lmWidget.addClass('widget-gridbox');
176177
// display needn't be set to flex and grid
177-
this.pWidget.removeClass('widget-box');
178+
this.lmWidget.removeClass('widget-box');
178179
}
179180
}
180181

‎packages/controls/src/widget_controller.ts

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -329,18 +329,18 @@ export class ControllerModel extends CoreDOMWidgetModel {
329329
*/
330330
export class ControllerView extends DOMWidgetView {
331331
_createElement(tagName: string): HTMLElement {
332-
this.pWidget = new JupyterLuminoPanelWidget({ view: this });
333-
return this.pWidget.node;
332+
this.lmWidget = new JupyterLuminoPanelWidget({ view: this });
333+
return this.lmWidget.node;
334334
}
335335

336336
_setElement(el: HTMLElement): void {
337-
if (this.el || el !== this.pWidget.node) {
337+
if (this.el || el !== this.lmWidget.node) {
338338
// Boxes don't allow setting the element beyond the initial creation.
339339
throw new Error('Cannot reset the DOM element.');
340340
}
341341

342-
this.el = this.pWidget.node;
343-
this.$el = $(this.pWidget.node);
342+
this.el = this.lmWidget.node;
343+
this.$el = $(this.lmWidget.node);
344344
}
345345

346346
initialize(parameters: WidgetView.IInitializeParameters): void {
@@ -367,11 +367,11 @@ export class ControllerView extends DOMWidgetView {
367367

368368
this.axis_box = new Panel();
369369
this.axis_box.node.style.display = 'flex';
370-
this.pWidget.addWidget(this.axis_box);
370+
this.lmWidget.addWidget(this.axis_box);
371371

372372
this.button_box = new Panel();
373373
this.button_box.node.style.display = 'flex';
374-
this.pWidget.addWidget(this.button_box);
374+
this.lmWidget.addWidget(this.button_box);
375375

376376
this.button_views.update(this.model.get('buttons'));
377377
this.axis_views.update(this.model.get('axes'));
@@ -393,7 +393,7 @@ export class ControllerView extends DOMWidgetView {
393393
.then((view: ControllerButtonView) => {
394394
// replace the dummy widget with the new one.
395395
const i = ArrayExt.firstIndexOf(this.button_box.widgets, dummy);
396-
this.button_box.insertWidget(i, view.pWidget);
396+
this.button_box.insertWidget(i, view.lmWidget);
397397
dummy.dispose();
398398
return view;
399399
})
@@ -410,7 +410,7 @@ export class ControllerView extends DOMWidgetView {
410410
.then((view: ControllerAxisView) => {
411411
// replace the dummy widget with the new one.
412412
const i = ArrayExt.firstIndexOf(this.axis_box.widgets, dummy);
413-
this.axis_box.insertWidget(i, view.pWidget);
413+
this.axis_box.insertWidget(i, view.lmWidget);
414414
dummy.dispose();
415415
return view;
416416
})
@@ -430,4 +430,5 @@ export class ControllerView extends DOMWidgetView {
430430
button_box: Panel;
431431
model: ControllerModel;
432432
pWidget: JupyterLuminoPanelWidget;
433+
lmWidget: JupyterLuminoPanelWidget;
433434
}

‎packages/controls/src/widget_image.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ export class ImageView extends DOMWidgetView {
3434
* Called when view is rendered.
3535
*/
3636
super.render();
37-
this.pWidget.addClass('jupyter-widgets');
38-
this.pWidget.addClass('widget-image');
37+
this.lmWidget.addClass('jupyter-widgets');
38+
this.lmWidget.addClass('widget-image');
3939
this.update(); // Set defaults.
4040
}
4141

‎packages/controls/src/widget_int.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@ export class ProgressView extends DescriptionView {
716716
initialize(parameters: WidgetView.IInitializeParameters): void {
717717
super.initialize(parameters);
718718
this.listenTo(this.model, 'change:bar_style', this.update_bar_style);
719-
this.pWidget.addClass('jupyter-widgets');
719+
this.lmWidget.addClass('jupyter-widgets');
720720
}
721721

722722
render(): void {

0 commit comments

Comments
 (0)