1 /*
2 * Copyright (c) 2010, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javafx.scene.web;
27
28
29 import javafx.css.StyleableProperty;
30
31 import javafx.scene.control.Control;
32
33 import javafx.print.PrinterJob;
34 import javafx.scene.control.Skin;
35
36
37 /**
38 * A control that allows for users to edit text, and apply styling to this text.
39 * The underlying data model is HTML, although this is not shown visually to the
40 * end-user.
41 * @since JavaFX 2.0
42 */
43 public class HTMLEditor extends Control {
44
45 /**
46 * Creates a new instance of the HTMLEditor control.
47 */
48 public HTMLEditor() {
49 ((StyleableProperty)super.skinClassNameProperty()).applyStyle(
50 null,
51 "javafx.scene.web.HTMLEditorSkin"
52 );
53 getStyleClass().add("html-editor");
54 }
55
56 @Override protected Skin<?> createDefaultSkin() {
57 return new HTMLEditorSkin(this);
58 }
59
60 /**
61 * Returns the HTML content of the editor.
62 */
63 public String getHtmlText() {
64 return ((HTMLEditorSkin)getSkin()).getHTMLText();
65 }
66
67 /**
68 * Sets the HTML content of the editor. Note that if the contentEditable
69 * property on the <body> tag of the provided HTML is not set to true, the
70 * HTMLEditor will become read-only. You can ensure that the text remains
71 * editable by ensuring the body appears as such:
72 * <code>
73 * <body contentEditable="true">
74 * </code>
75 *
76 * @param htmlText The full HTML markup to put into the editor. This should
77 * include all normal HTML elements, starting with
78 * <code><html></code>, and including a <code><body></code>.
79 */
80 public void setHtmlText(String htmlText) {
81 ((HTMLEditorSkin)getSkin()).setHTMLText(htmlText);
82 }
83
84 /**
85 * Prints the content of the editor using the given printer job.
86 * <p>This method does not modify the state of the job, nor does it call
87 * {@link PrinterJob#endJob}, so the job may be safely reused afterwards.
88 *
89 * @param job printer job used for printing
90 * @since JavaFX 8.0
91 */
92 public void print(PrinterJob job) {
93 ((HTMLEditorSkin)getSkin()).print(job);
94 }
95 }