summaryrefslogtreecommitdiffstats
path: root/documentation/components/components-richtextarea.asciidoc
diff options
context:
space:
mode:
authorIlia Motornyi <elmot@vaadin.com>2015-12-03 14:59:05 +0000
committerVaadin Code Review <review@vaadin.com>2015-12-03 14:59:12 +0000
commit2af72ba9636bec70046394c41744f89ce4572e35 (patch)
treeccb3dc2d2239585f8c3f79eb5f131ff61ca9ce86 /documentation/components/components-richtextarea.asciidoc
parent8aa5fabe89f2967e966a64842a608eceaf80d08f (diff)
downloadvaadin-framework-2af72ba9636bec70046394c41744f89ce4572e35.tar.gz
vaadin-framework-2af72ba9636bec70046394c41744f89ce4572e35.zip
Revert "Merge branch 'documentation'"7.6.0.beta2
This reverts commit f6874bde3d945c8b2d1b5c17ab50e2d0f1f8ff00. Change-Id: I67ee1c30ba3e3bcc3c43a1dd2e73a822791514bf
Diffstat (limited to 'documentation/components/components-richtextarea.asciidoc')
-rw-r--r--documentation/components/components-richtextarea.asciidoc123
1 files changed, 0 insertions, 123 deletions
diff --git a/documentation/components/components-richtextarea.asciidoc b/documentation/components/components-richtextarea.asciidoc
deleted file mode 100644
index 6d71757c9c..0000000000
--- a/documentation/components/components-richtextarea.asciidoc
+++ /dev/null
@@ -1,123 +0,0 @@
----
-title: RichTextArea
-order: 12
-layout: page
----
-
-[[components.richtextarea]]
-= [classname]#RichTextArea#
-
-The [classname]#RichTextArea# field allows entering or editing formatted text.
-The toolbar provides all basic editing functionalities. The text content of
-[classname]#RichTextArea# is represented in HTML format.
-[classname]#RichTextArea# inherits [classname]#TextField# and does not add any
-API functionality over it. You can add new functionality by extending the
-client-side components [classname]#VRichTextArea# and
-[classname]#VRichTextToolbar#.
-
-As with [classname]#TextField#, the textual content of the rich text area is the
-[classname]#Property# of the field and can be set with [methodname]#setValue()#
-and read with [methodname]#getValue()#.
-
-
-[source, java]
-----
-// Create a rich text area
-final RichTextArea rtarea = new RichTextArea();
-rtarea.setCaption("My Rich Text Area");
-
-// Set initial content as HTML
-rtarea.setValue("<h1>Hello</h1>\n" +
- "<p>This rich text area contains some text.</p>");
-----
-
-.Rich Text Area Component
-image::img/richtextarea-example1.png[]
-
-Above, we used context-specific tags such as [literal]#++<h1>++# in the initial
-HTML content. The rich text area component does not allow creating such tags,
-only formatting tags, but it does preserve them unless the user edits them away.
-Any non-visible whitespace such as the new line character ( [literal]#++\n++#)
-are removed from the content. For example, the value set above will be as
-follows when read from the field with [methodname]#getValue()#:
-
-
-[source, html]
-----
-<h1>Hello</h1> <p>This rich text area contains some text.</p>
-----
-
-
-[WARNING]
-.Cross-Site Scripting Warning
-====
-The user input from a [classname]#RichTextArea# is transmitted as HTML from the
-browser to server-side and is not sanitized. As the entire purpose of the
-[classname]#RichTextArea# component is to allow input of formatted text, you can
-not sanitize it just by removing all HTML tags. Also many attributes, such as
-[parameter]#style#, should pass through the sanitization.
-
-See
-<<dummy/../../../framework/advanced/advanced-security#advanced.security.sanitizing,"Sanitizing
-User Input to Prevent Cross-Site Scripting">> for more details on Cross-Site
-scripting vulnerabilities and sanitization of user input.
-
-====
-
-
-
-ifdef::web[]
-[[components.richtextarea.localization]]
-== Localizing RichTextArea Toolbars
-
-The rich text area is one of the few components in Vaadin that contain textual
-labels. The selection boxes in the toolbar are in English and currently can not
-be localized in any other way than by inheriting or reimplementing the
-client-side [classname]#VRichTextToolbar# widget. The buttons can be localized
-simply with CSS by downloading a copy of the toolbar background image, editing
-it, and replacing the default toolbar. The toolbar is a single image file from
-which the individual button icons are picked, so the order of the icons is
-different from the rendered. The image file depends on the client-side
-implementation of the toolbar.
-
-
-[source, css]
-----
-.v-richtextarea-richtextexample .gwt-ToggleButton
-.gwt-Image {
- background-image: url(img/richtextarea-toolbar-fi.png)
- !important;
-}
-----
-
-.Regular English and a Localized Rich Text Area Toolbar
-image::img/richtextarea-toolbar-whitebg.png[]
-
-endif::web[]
-
-== CSS Style Rules
-
-
-[source, css]
-----
-.v-richtextarea { }
-.v-richtextarea .gwt-RichTextToolbar { }
-.v-richtextarea .gwt-RichTextArea { }
-----
-
-The rich text area consists of two main parts: the toolbar with overall style
-[literal]#++.gwt-RichTextToolbar++# and the editor area with style
-[literal]#++.gwt-RichTextArea++#. The editor area obviously contains all the
-elements and their styles that the HTML content contains. The toolbar contains
-buttons and drop-down list boxes with the following respective style names:
-
-
-[source, css]
-----
-.gwt-ToggleButton { }
-.gwt-ListBox { }
-----
-
-
-
-