HSLF docs updated: added a note on using HSLF when graphical environment is not avaiable

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@535929 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/documentation/content/xdocs/hslf/how-to-shapes.xml b/src/documentation/content/xdocs/hslf/how-to-shapes.xml
index 243935b5368d1bc9ab7600d449f259f23ba6c815..fd3d6c3bb6c00cb034c339a66e2c0622cb338472 100644 (file)
--- a/src/documentation/content/xdocs/hslf/how-to-shapes.xml
+++ b/src/documentation/content/xdocs/hslf/how-to-shapes.xml
@@ -118,6 +118,13 @@
                 </section>
                 <anchor id="Shapes"/>
                 <section><title>Drawing a shape on a slide</title>
+        <warning>
+    To work with graphic objects HSLF uses Java2D classes
+    that may throw exceptions if graphical environment is not available. In case if graphical environment
+    is not available, you must tell Java that you are running in headless mode and
+    set the following system property: <code> java.awt.headless=true </code>
+    (either via <code>-Djava.awt.headless=true</code> startup parameter or via <code>System.setProperty("java.awt.headless", "true")</code>).
+        </warning>
                    <p>
                      When you add a shape, you usually specify the dimensions of the shape and the position
                      of the upper left corner of the bounding box for the shape relative to the upper left