-
Notifications
You must be signed in to change notification settings - Fork 942
/
widget_button.py
129 lines (98 loc) · 4.21 KB
/
widget_button.py
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
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
"""Button class.
Represents a button in the frontend using a widget. Allows user to listen for
click events on the button and trigger backend code when the clicks are fired.
"""
from .domwidget import DOMWidget
from .widget import CallbackDispatcher, register, widget_serialization
from .widget_core import CoreWidget
from .widget_style import Style
from .trait_types import Color, InstanceDict
from traitlets import Unicode, Bool, CaselessStrEnum, Instance, validate, default
import warnings
@register
class ButtonStyle(Style, CoreWidget):
"""Button style widget."""
_model_name = Unicode('ButtonStyleModel').tag(sync=True)
button_color = Color(None, allow_none=True, help="Color of the button").tag(sync=True)
font_weight = Unicode(help="Button text font weight.").tag(sync=True)
@register
class Button(DOMWidget, CoreWidget):
"""Button widget.
This widget has an `on_click` method that allows you to listen for the
user clicking on the button. The click event itself is stateless.
Parameters
----------
description: str
description displayed next to the button
tooltip: str
tooltip caption of the toggle button
icon: str
font-awesome icon name
disabled: bool
whether user interaction is enabled
"""
_view_name = Unicode('ButtonView').tag(sync=True)
_model_name = Unicode('ButtonModel').tag(sync=True)
description = Unicode(help="Button label.").tag(sync=True)
tooltip = Unicode(help="Tooltip caption of the button.").tag(sync=True)
disabled = Bool(False, help="Enable or disable user changes.").tag(sync=True)
icon = Unicode('', help="Font-awesome icon name, without the 'fa-' prefix.").tag(sync=True)
button_style = CaselessStrEnum(
values=['primary', 'success', 'info', 'warning', 'danger', ''], default_value='',
help="""Use a predefined styling for the button.""").tag(sync=True)
style = InstanceDict(ButtonStyle).tag(sync=True, **widget_serialization)
def __init__(self, **kwargs):
super(Button, self).__init__(**kwargs)
self._click_handlers = CallbackDispatcher()
self.on_msg(self._handle_button_msg)
@validate('icon')
def _validate_icon(self, proposal):
"""Strip 'fa-' if necessary'"""
value = proposal['value']
if value.startswith('fa-'):
warnings.warn("icons names no longer start with 'fa-', "
"just use the class name itself (for example, 'check' instead of 'fa-check')", DeprecationWarning)
value = value[3:]
return value
def on_click(self, callback, remove=False):
"""Register a callback to execute when the button is clicked.
The callback will be called with one argument, the clicked button
widget instance.
Parameters
----------
remove: bool (optional)
Set to true to remove the callback from the list of callbacks.
"""
self._click_handlers.register_callback(callback, remove=remove)
def click(self):
"""Programmatically trigger a click event.
This will call the callbacks registered to the clicked button
widget instance.
"""
self._click_handlers(self)
def _handle_button_msg(self, _, content, buffers):
"""Handle a msg from the front-end.
Parameters
----------
content: dict
Content of the msg.
"""
if content.get('event', '') == 'click':
self.click()
def __copy__(self):
cls = self.__class__
result = cls.__new__(cls)
result.__init__()
new_state = {key: value for key, value in self.get_state().items() if
not key.startswith('_') and
not key == 'layout' and
not key == 'style'}
for key, value in new_state.items():
setattr(result, key, value)
result.layout = self.layout
result.style = self.style
for callback in self._click_handlers.callbacks:
result.on_click(callback, remove=False)
return result