diff --git a/docs/manual/OptionalTasks/image-classdiagram.gif b/docs/manual/OptionalTasks/image-classdiagram.gif new file mode 100644 index 000000000..fa4b81e8d Binary files /dev/null and b/docs/manual/OptionalTasks/image-classdiagram.gif differ diff --git a/docs/manual/OptionalTasks/image.html b/docs/manual/OptionalTasks/image.html new file mode 100644 index 000000000..2570c97a3 --- /dev/null +++ b/docs/manual/OptionalTasks/image.html @@ -0,0 +1,209 @@ + + + + +Image Task + + + + +

Image

+

Description

+

Applies a chain of image operations on a set of files.

+

Requires Java Advanced Image API from Sun.

+ +
Overview of used datatypes
+Class-Diagram + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
failonerror Boolean value. If false, note errors to the output but keep going. no (defaults to true)
srcdir Directory containing the images. yes, unless nested fileset is used
encoding Image encoding type.
+ Valid (caseinsensitive) are: jpg, jpeg, tif, tiff +
no (defaults to JPEG)
overwrite Boolean value. Sets whether or not to overwrite + a file if there is naming conflict. + no (defaults to false)
gc Boolean value. Enables garbage collection after + each image processed. + no (defaults to false)
destdir Directory where the result images are stored. no (defaults to value of srcdir)
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
caseSensitive Boolean value. Sets case sensitivity of the file system. no (defaults to false)
followSymlinks Boolean value. Sets whether or not symbolic links hsould be followed. no (defaults to true)
+ +

Parameters specified as nested elements

+

This task forms an implicit FileSet and +supports all attributes of <fileset> as well as the +nested <include>, <exclude> and +<patternset> elements.

+ + +

ImageOperation

+

Adds an ImageOperation to chain.

+
Nested Elements
+ImageOperation can handle nested Rotate, Draw, Rectangle, Text and Scale objects. + +

Rotate

+

Adds a Rotate ImageOperation to chain.

+
Parameters
+ + + + + + + + + + + +
AttributeDescriptionRequired
angle Float value. Sets the angle of rotation in degrees. no (defaults to 0.0F)
+ +

Scale

+

Adds a Scale ImageOperation to chain.

+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
keepproportions Boolean value. Sets whether the proportion heigth/width should be kept. no (defaults to false)
width Sets the width of the image, either as an integer or a %. no (defaults to 100%)
heigth Sets the height of the image, either as an integer or a %. no (defaults to 100%)
+ +

Draw

+

Adds a Draw ImageOperation to chain. DrawOperation DataType objects can be +nested inside the Draw object.

+
Parameters
+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
xloc X-Position where to draw nested image elements. no (defaults to 0)
yloc Y-Position where to draw nested image elements. no (defaults to 0)
+ +

Examples

+ +
+<image srcdir="src" includes="*.png">
+    <scale keepproportions="true" width="40"/>
+</image>
+
+

Creates a thumbnail for all PNG-files in src in the size of 40 pixel keeping the proportions +and stores the src.

+ +
+<image srcdir="src" destdir="dest" includes="*.png">
+    <scale keepproportions="true" width="40"/>
+</image>
+
+

Same as above but stores the result in dest.

+ +
+
+ +
+

Copyright © 2003 Apache Software +Foundation. All rights Reserved.

+ + + + + diff --git a/docs/manual/install.html b/docs/manual/install.html index 462d7bb5e..b1c80acb9 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -424,6 +424,12 @@

Library Dependencies

http://www.jcraft.com/jsch/index.html + + JAI - Java Advanded Imaging + image task + http://java.sun.com/products/java-media/jai/ +

diff --git a/docs/manual/optionaltasklist.html b/docs/manual/optionaltasklist.html index 1d1e59605..49b62f18c 100644 --- a/docs/manual/optionaltasklist.html +++ b/docs/manual/optionaltasklist.html @@ -28,6 +28,7 @@

Optional Tasks

Echoproperties
FTP
IContract
+Image
Jarlib-available
Jarlib-display
Jarlib-manifest