0.9.3
1.2
Cewolf Tag Library
http://cewolf.sourceforge.net/taglib/cewolf.tld
Cewolf Tag Library
This tag library is designed to describe charts of all kinds.
plot
de.laures.cewolf.taglib.tags.PlotTag
JSP
The plot tag is nested inside a complex chart to define a nested or layerd plot instance.
@required-child data
type
true
true
The type of the plot. One of xyarea, xyline, xyshapesandlines ,
scatter, xyverticalbar, step, candlestick, highlow, signal,
verticlebar, area, line, shapesandlines
xaxislabel
false
true
Title of the plot's x-axis. This attributes is
only used for horizontally combined charts.
yaxislabel
false
true
Title of the plot's y-axis. This attributes is
only used for vertically combined charts.
img
de.laures.cewolf.taglib.tags.ChartImgTag
JSP
This tag is a specialized HTML img tag. It renders the chart
which has been specified by a <chart> tag in the same page.
@optional-child map
renderer
true
true
Path to rendering servlet. Any path that starts with a '/' is assumed to refer to a resource relative to web application root. Otherwise, the path is assumed to refer to resource relative to the current page directory.
chartid
true
true
The id of the chart to render.
width
true
true
Width of the rendered chart image in pixel.
height
true
true
Height of the rendered chart image in pixel.
mime
false
true
The MIME type of the image. Currently image/png (default) and image/svg are supported.
@default image/png
alt
false
true
Corresponds to appropriate HMTL <img> attribute.
timeout
false
true
Sets the timeout value used in the LongTermSessionStorage obj. Value is in seconds.
hspace
false
true
Corresponds to appropriate HMTL <img> attribute.
vspace
false
true
Corresponds to appropriate HMTL <img> attribute.
align
false
true
Corresponds to appropriate HMTL <img> attribute.
border
false
true
Corresponds to appropriate HMTL <img> attribute.
ismap
false
true
Corresponds to appropriate HMTL <img> attribute.
longdesc
false
true
Corresponds to appropriate HMTL <img> attribute.
usemap
false
true
Corresponds to appropriate HMTL <img> attribute.
class
false
true
Corresponds to appropriate HMTL <img> attribute.
dir
false
true
Corresponds to appropriate HMTL <img> attribute.
lang
false
true
Corresponds to appropriate HMTL <img> attribute.
onclick
false
true
Corresponds to appropriate HMTL <img> attribute.
ondbclick
false
true
Corresponds to appropriate HMTL <img> attribute.
onkeydown
false
true
Corresponds to appropriate HMTL <img> attribute.
onkeypress
false
true
Corresponds to appropriate HMTL <img> attribute.
onkeyup
false
true
Corresponds to appropriate HMTL <img> attribute.
onmousedown
false
true
Corresponds to appropriate HMTL <img> attribute.
onmousemove
false
true
Corresponds to appropriate HMTL <img> attribute.
onmouseout
false
true
Corresponds to appropriate HMTL <img> attribute.
onmouseover
false
true
Corresponds to appropriate HMTL <img> attribute.
onmouseup
false
true
Corresponds to appropriate HMTL <img> attribute.
style
false
true
Corresponds to appropriate HMTL <img> attribute.
htmltitle
false
true
Corresponds to appropriate HMTL <img> title attribute.
forceSessionId
false
true
Add JSession id.
removeAfterRender
false
true
Remove image after rendering (defaults to false).
imgurl
de.laures.cewolf.taglib.tags.ChartImgURLTag
de.laures.cewolf.taglib.tags.ChartImgURLTagEI
This tag can be used as the src attribute of a HTML img tag. E.g.:
<img src='<imgurl chartid="foobar" renderer="cewolf" width="100" height="100"/>'>
If the var attribute is used the URL is exposed as a page attribute of type String.
@extends img
var
false
true
Name of the page scope attribute to hold the URL. If not specified the URL is printed to the page outstream.
renderer
true
true
Path to rendering servlet. Any path that starts with a '/' is assumed to refer to a resource relative to web application root. Otherwise, the path is assumed to refer to resource relative to the current page directory.
chartid
true
true
The id of the chart to render.
width
true
true
Width of the rendered chart image in pixel.
height
true
true
Height of the rendered chart image in pixel.
mime
false
true
The MIME type of the image. Currently image/png (default) and image/svg are supported.
@default image/png
chart
de.laures.cewolf.taglib.tags.SimpleChartTag
Root tag of a chart description.
@root
@required-child data
@optional-child chartpostprocessor
id
true
true
ID under which the chart description bean will be stored in the
page to be found by the img tag. Beware of using an
ID which is not yet used for other beans in the page to avoid
compile errors.
type
true
true
Type of the chart. One of area, areaxy, horizontalbar, horizontalbar3d,
line, pie, scatter, stackedarea, stackedhorizontalbar, stackedverticalbar,
stackedverticalbar3d, timeseries, verticalbar, verticalbar3d, xy,
candlestick, highlow, gantt, wind, signal, verticalxybar, pie3d, meter
title
false
true
Title of the chart which is displayed on the chart panel
above the plot pane.
xaxislabel
false
true
Title of the chart's x-axis. This attributes is
ignored if the type attribute of the parent chart tag is one
of pie3d or pie.
yaxislabel
false
true
Title of the chart's y-axis. This attributes is
ignored if the type attribute of the parent chart tag is one
of pie3d or pie.
background
false
true
Background image of the chart panel. The value of this
attribute is the filename of a graphics file relative to the web
application's root directory (e.g. /WEB-INF/img/bg.jpg).
The image must be loadable by the default java.awt.Toolkit of the
servlet container's JVM.
backgroundimagealpha
false
true
java.lang.Float
Chart's backgound alpha blending value as a float. Value ranges
from 0.0 to 1.0.
@default 0.0
@overrides /chart[backgroundimagealpha]
antialias
false
true
Antialiased rendering of the chart.
@default true
@overrides /chart[backgroundimagealpha]
showlegend
false
true
Boolean value to switch on or off the legend display inside of this panel.
@default true
legendanchor
false
true
Sets the anchor of the legend inside of the panel. Possible values
are 'north', 'south', 'west', 'east'.
Ignored if showlegned is 'false'.
@default 'south'
overlaidchart
de.laures.cewolf.taglib.tags.OverlaidChartTag
Root tag of a overlaid-chart description.
@root
@required-child data
@optional-child chartpostprocessor
id
true
true
ID under which the chart description bean will be stored in the
page to be found by the img tag. Beware of using an
ID which is not yet used for other beans in the page to avoid
compile errors.
type
true
true
Type of the chart. In this version only overlaidxy is supported.
title
false
true
Title of the chart which is displayed on the chart panel
above the plot pane.
xaxistype
true
true
Type of the domain axis. Possible values: date, number
xaxislabel
false
true
Title of the chart's x-axis. This attributes is
ignored if the type attribute of the parent chart tag is one
of pie3d or pie.
yaxistype
false
true
Type of the range axis. Possible values: date, number
yaxislabel
false
true
Title of the chart's y-axis. This attributes is
ignored if the type attribute of the parent chart tag is one
of pie3d or pie.
background
false
true
Background image of the chart panel. The value of this
attribute is the filename of a graphics file relative to the web
application's root directory (e.g. /WEB-INF/img/bg.jpg).
The image must be loadable by the default java.awt.Toolkit of the
servlet container's JVM.
backgroundimagealpha
false
true
java.lang.Float
Chart's backgound alpha blending value as a float. Value ranges
from 0.0 to 1.0.
@default 0.0
@overrides /chart[backgroundimagealpha]
antialias
false
true
Antialiased rendering of the chart.
@default true
@overrides /chart[backgroundimagealpha]
showlegend
false
true
Boolean value to switch on or off the legend display inside of this panel.
@default true
legendanchor
false
true
Sets the anchor of the legend inside of the panel. Possible values
are 'north', 'south', 'west', 'east'.
Ignored if showlegned is 'false'.
@default 'south'
combinedchart
de.laures.cewolf.taglib.tags.CombinedChartTag
Root tag of a combined-chart description.
@root
@required-child plot
@optional-child chartpostprocessor
id
true
true
ID under which the chart description bean will be stored in the
page to be found by the img tag. Beware of using an
ID which is not yet used for other beans in the page to avoid
compile errors.
type
true
true
Type of the chart. One of combinedxy
layout
true
true
Layout of the chart. Either vertical or horizontal
title
false
true
Title of the chart which is displayed on the chart panel
above the plot pane.
xaxislabel
false
true
Title of the chart's x-axis. This attributes is
ignored if the type attribute of the parent chart tag is one
of pie3d or pie.
yaxislabel
false
true
Title of the chart's y-axis. This attributes is
ignored if the type attribute of the parent chart tag is one
of pie3d or pie.
background
false
true
Background image of the chart panel. The value of this
attribute is the filename of a graphics file relative to the web
application's root directory (e.g. /WEB-INF/img/bg.jpg).
The image must be loadable by the default java.awt.Toolkit of the
servlet container's JVM.
backgroundimagealpha
false
true
java.lang.Float
Chart's backgound alpha blending value as a float. Value ranges
from 0.0 to 1.0.
@default 0.0
@overrides /chart[backgroundimagealpha]
antialias
false
true
Antialiased rendering of the chart.
@default true
@overrides /chart[backgroundimagealpha]
showlegend
false
true
Boolean value to switch on or off the legend display inside of this panel.
@default true
legendanchor
false
true
Sets the anchor of the legend inside of the panel. Possible values
are 'north', 'south', 'west', 'east'.
Ignored if showlegned is 'false'.
@default 'south'
legend
de.laures.cewolf.taglib.tags.LegendTag
This tag is used to render the legend of a chart in a separate image.
It assumes that somewhere else in the JSP a chart tag defines a chart
with the same ID as this legend tag.
forceSessionId
false
true
Add JSession id.
removeAfterRender
false
true
Remove image after rendering (defaults to false).
renderer
true
true
Path to rendering servlet relative to web apps root URL
(e.g. servlet/cewolf).
id
true
true
ID under which the chart description bean will be stored in the
session to be found by the rendering servlet. Beware of using an
ID which is not yet used for other beans in the session to avoid
overriding.
timeout
false
true
Sets the timeout value used in the LongTermSessionStorage obj. Value is in seconds.
width
false
true
Corresponds to appropriate HMTL <img> attribute.
height
false
true
Corresponds to appropriate HMTL <img> attribute.
mime
false
true
The MIME type of the image. Currently image/png (default) and image/svg are supported.
@default image/png
alt
false
true
Corresponds to appropriate HMTL <img> attribute.
hspace
false
true
Corresponds to appropriate HMTL <img> attribute.
vspace
false
true
Corresponds to appropriate HMTL <img> attribute.
align
false
true
Corresponds to appropriate HMTL <img> attribute.
border
false
true
Corresponds to appropriate HMTL <img> attribute.
ismap
false
true
Corresponds to appropriate HMTL <img> attribute.
longdesc
false
true
Corresponds to appropriate HMTL <img> attribute.
usemap
false
true
Corresponds to appropriate HMTL <img> attribute.
class
false
true
Corresponds to appropriate HMTL <img> attribute.
dir
false
true
Corresponds to appropriate HMTL <img> attribute.
lang
false
true
Corresponds to appropriate HMTL <img> attribute.
onclick
false
true
Corresponds to appropriate HMTL <img> attribute.
ondbclick
false
true
Corresponds to appropriate HMTL <img> attribute.
onkeydown
false
true
Corresponds to appropriate HMTL <img> attribute.
onkeypress
false
true
Corresponds to appropriate HMTL <img> attribute.
onkeyup
false
true
Corresponds to appropriate HMTL <img> attribute.
onmousedown
false
true
Corresponds to appropriate HMTL <img> attribute.
onmousemove
false
true
Corresponds to appropriate HMTL <img> attribute.
onmouseout
false
true
Corresponds to appropriate HMTL <img> attribute.
onmouseover
false
true
Corresponds to appropriate HMTL <img> attribute.
onmouseup
false
true
Corresponds to appropriate HMTL <img> attribute.
style
false
true
Corresponds to appropriate HMTL <img> attribute.
htmltitle
false
true
Corresponds to appropriate HMTL <img> title attribute.
data
de.laures.cewolf.taglib.tags.DataTag
A data tag provides all information needed to retrieve the data which are
needed by the chart. Current version only supports data provided by a
DatasetProducer. In future versions there will be tags to provide data
from a datasource (e.g. via SQL).
@optional-child producer
producer
de.laures.cewolf.taglib.tags.ProducerTag
A data tag provides all information needed to retrieve the data which are
needed by the chart. Current version only supports data provided by a
DatasetProducer. In future versions there will be tags to provide data
from a datasource (e.g. via SQL).
@optional-child param
id
true
true
ID under which an object of type DatasetProducer can be found in
pageContext. This object is used to retrieve the dataset of the chart.
usecache
false
true
Determines if formally produced data should be reused if possible.
@default true
chartpostprocessor
de.laures.cewolf.taglib.tags.ChartPostProcessorTag
A chart postprocessor tag references an object of type ChartProstProcessor
which must be defined in pageContext under the provided ID. This object
is called back after chart generation to post process the chart in any
manner.
@optional-child param
id
true
true
ID under which an object of type ChartPostProcessor can be found in
pageContext. This object is used to postprocess the rendered chart.
param
de.laures.cewolf.taglib.tags.ParamTag
Name/value-pair to paramterize a surrounding tag whose handler must
implement the Parameterized interface.
name
true
true
Name of the param
value
true
true
java.io.Serializable
Value of the param. Must be serializable.
gradientpaint
de.laures.cewolf.taglib.tags.GradientTag
The gradientpaint tag provides a way to fill a shape with a linear
color gradient pattern. If Point P1 with Color C1 and Point P2 with
Color C2 are specified in user space, the Color on the P1, P2
connecting line is proportionally changed from C1 to C2. Any point
P not on the extended P1, P2 connecting line has the color of the
point P' that is the perpendicular projection of P on the extended P1,
P2 connecting line. Points on the extended line outside of the P1,
P2 segment can be colored in one of two ways.
<ul>
<li>If the gradient is cyclic then the points on the extended
P1, P2 connecting line cycle back and forth between the colors C1
and C2.
<li>If the gradient is acyclic then points on the P1 side of
the segment have the constant Color C1 while points on the P2 side
have the constant Color C2.
The two colors are defined in a nested point tag of this tag.
@required-child point
cyclic
false
true
Does the gradient cycle repeatedly between the two colors C1 and C2.
@default false
point
de.laures.cewolf.taglib.tags.PointTag
Defines a point with x and y coordinates and a color.
@extends colorpaint
x
true
true
The x coordinate of the point.
y
true
true
The y coordinate of the point.
color
false
true
@copy
colorpaint
de.laures.cewolf.taglib.tags.ColorTag
Fills the area defined by the parent tag with a color.
color
true
true
The color to be used to fill the parent tag's area.
The color definition is compatible with the
HTML one. E.g. black is '#000000' and red is '#FF0000'. However it
is possible to append two hex numbers for the alpha channel. Thus
'#FF000080' is red with alpha blending of 50%.
texturepaint
de.laures.cewolf.taglib.tags.TextureTag
The texturepaint tag provides a way to fill the area of the parent tag
with a texture that is specified as an image. The texture is anchored to
the upper left corner of the parent tags area.
image
true
true
Image fo the texture. The value of this
attribute is the filename of a graphics file relative to the web
application's root directory (e.g. /WEB-INF/img/bg.jpg).
The image must be loadable by the default java.awt.Toolkit of the
servlet container's JVM.
width
true
true
The width of the texture.
height
true
true
The height of the texture.
map
de.laures.cewolf.taglib.tags.ChartMapTag
This tag defines an image and tooltip map for the parent img tag.
@parent img
linkgeneratorid
false
true
The ID of the class which implements the appropriate de.laures.cewolf.LinkGenerator.
tooltipgeneratorid
false
true
The ID of the class which implements the appropriate com.jrefinery.chart.tooltips.ToolTipGenerator.
useJFreeChartLinkGenerator
false
true
If the links provided by the JFreeChart renderer should be used.
useJFreeChartTooltipGenerator
false
true
If the tooltips provided by the JFreeChart renderer should be used.