summaryrefslogtreecommitdiffstats
path: root/documentation/components/components-passwordfield.asciidoc
diff options
context:
space:
mode:
authorMarkus Koivisto <markus@vaadin.com>2016-01-22 14:55:18 +0200
committerMarkus Koivisto <markus@vaadin.com>2016-01-22 14:55:18 +0200
commit99d6de546c74f0eed230ea8253dda6b85109d2e7 (patch)
tree10fc21c557566fe3241e6e13499df18d80f8dcb2 /documentation/components/components-passwordfield.asciidoc
parent610736d9f373d4b37fd39ff8f90aabd13eab7926 (diff)
downloadvaadin-framework-99d6de546c74f0eed230ea8253dda6b85109d2e7.tar.gz
vaadin-framework-99d6de546c74f0eed230ea8253dda6b85109d2e7.zip
Add documentation to master branch
Change-Id: I2504bb10f1ae73ec0cbc08b7ba5a88925caa1674
Diffstat (limited to 'documentation/components/components-passwordfield.asciidoc')
-rw-r--r--documentation/components/components-passwordfield.asciidoc54
1 files changed, 54 insertions, 0 deletions
diff --git a/documentation/components/components-passwordfield.asciidoc b/documentation/components/components-passwordfield.asciidoc
new file mode 100644
index 0000000000..1280de7529
--- /dev/null
+++ b/documentation/components/components-passwordfield.asciidoc
@@ -0,0 +1,54 @@
+---
+title: PasswordField
+order: 11
+layout: page
+---
+
+[[components.passwordfield]]
+= [classname]#PasswordField#
+
+ifdef::web[]
+[.sampler]
+image:{live-demo-image}[alt="Live Demo", link="http://demo.vaadin.com/sampler/#ui/data-input/text-input/password-field]
+endif::web[]
+
+The [classname]#PasswordField# is a variant of [classname]#TextField# that hides
+the typed input from visual inspection.
+
+
+[source, java]
+----
+PasswordField tf = new PasswordField("Keep it secret");
+----
+See the http://demo.vaadin.com/book-examples-vaadin7/book#component.passwordfield.basic[on-line example, window="_blank"].
+
+The result is shown in <<figure.components.passwordfield.basic>>.
+
+[[figure.components.passwordfield.basic]]
+.[classname]#PasswordField#
+image::img/passwordfield-basic.png[]
+
+You should note that the [classname]#PasswordField# hides the input only from
+"over the shoulder" visual observation. Unless the server connection is
+encrypted with a secure connection, such as HTTPS, the input is transmitted in
+clear text and may be intercepted by anyone with low-level access to the
+network. Also phishing attacks that intercept the input in the browser may be
+possible by exploiting JavaScript execution security holes in the browser.
+
+[[components.passwordfield.css]]
+== CSS Style Rules
+
+
+[source, css]
+----
+.v-textfield { }
+----
+
+The [classname]#PasswordField# does not have its own CSS style name but uses the
+same [literal]#++v-textfield++# style as the regular [classname]#TextField#. See
+<<dummy/../../../framework/components/components-textfield#components.textfield.css,"CSS
+Style Rules">> for information on styling it.
+
+CSS Styling
+
+