diff options
author | elmot <elmot@vaadin.com> | 2015-09-25 16:40:44 +0300 |
---|---|---|
committer | elmot <elmot@vaadin.com> | 2015-09-25 16:40:44 +0300 |
commit | a1b265c318dbda4a213cec930785b81e4c0f7d2b (patch) | |
tree | b149daf5a4f50b4f6446c906047cf86495fe0433 /documentation/components/components-button.asciidoc | |
parent | b9743a48a1bd0394f19c54ee938c6395a80f3cd8 (diff) | |
download | vaadin-framework-a1b265c318dbda4a213cec930785b81e4c0f7d2b.tar.gz vaadin-framework-a1b265c318dbda4a213cec930785b81e4c0f7d2b.zip |
Framework documentation IN
Change-Id: I767477c1fc3745f9e1f58075fe30c9ac8da63581
Diffstat (limited to 'documentation/components/components-button.asciidoc')
-rw-r--r-- | documentation/components/components-button.asciidoc | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/documentation/components/components-button.asciidoc b/documentation/components/components-button.asciidoc new file mode 100644 index 0000000000..93eddfe845 --- /dev/null +++ b/documentation/components/components-button.asciidoc @@ -0,0 +1,65 @@ +--- +title: Button +order: 14 +layout: page +--- + +[[components.button]] += [classname]#Button# + +The [classname]#Button# component is normally used for initiating some action, +such as finalizing input in forms. When the user clicks a button, a +[classname]#Button.ClickEvent# is fired, which can be handled with a +[interfacename]#Button.ClickListener# in the [methodname]#buttonClick()# method. + +You can handle button clicks with an anonymous class as follows: + + +[source, java] +---- +Button button = new Button("Do not press this button"); + +button.addClickListener(new Button.ClickListener() { + public void buttonClick(ClickEvent event) { + Notification.show("Do not press this button again"); + } +}); +---- +See the http://demo.vaadin.com/book-examples-vaadin7/book#component.button.basic[on-line example, window="_blank"]. + +The result is shown in <<figure.component.button.basic>>. The listener can also +be given in the constructor, which is often perhaps simpler. + +[[figure.component.button.basic]] +.Button in Different Styles of Valo Theme +image::img/button-example1.png[] + +If you handle several buttons in the same listener, you can differentiate +between them either by comparing the [classname]#Button# object reference +returned by the [methodname]#getButton()# method of +[classname]#Button.ClickEvent# to a kept reference. For a detailed description +of these patterns together with some examples, please see +<<dummy/../../../framework/architecture/architecture-events#architecture.events,"Events +and Listeners">>. + +== CSS Style Rules + + +[source, css] +---- +.v-button { } + .v-button-wrap { } + .v-button-caption { } +---- + +A button has an overall [literal]#++v-button++# style. The caption has +[literal]#++v-button-caption++# style. There is also an intermediate wrap +element, which may help in styling in some cases. + +Some built-in themes contain a small style, which you can enable by adding +[parameter]#Reindeer.BUTTON_SMALL#, etc. The [classname]#BaseTheme# also has a +[parameter]#BUTTON_LINK# style, which makes the button look like a hyperlink. + + + + |