diff -r 000000000000 -r 639991d0808a java/cewolf-1.0/src/site/taglib.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/java/cewolf-1.0/src/site/taglib.html Sat Feb 28 21:31:02 2009 +0100 @@ -0,0 +1,461 @@ +Cewolf Tag Library

Cewolf Tag Library (0.13.0)

This tag library is designed to describe charts of all kinds.

+ <plot> +

+The plot tag is nested inside a complex chart to define a nested or layerd plot instance. +data +

Attributes
type
+The type of the plot. One of xyarea, xyline, xyshapesandlines , +scatter, xyverticalbar, step, candlestick, highlow, signal, +verticlebar, area, line, shapesandlines +
required=true
rtexprvalue=true
xaxislabel
+Title of the plot's x-axis. This attributes is +only used for horizontally combined charts. +
required=false
rtexprvalue=true
yaxislabel
+Title of the plot's y-axis. This attributes is +only used for vertically combined charts. +
required=false
rtexprvalue=true

+ <img> +

+ optional childs: + + <map>
 +This tag is a specialized HTML img tag. It renders the chart +which has been specified by a <chart> tag in the same page. +map +

Attributes
renderer
+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. +
required=true
rtexprvalue=true
chartid
+The id of the chart to render. +
required=true
rtexprvalue=true
width
+Width of the rendered chart image in pixel. +
required=true
rtexprvalue=true
height
+Height of the rendered chart image in pixel. +
required=true
rtexprvalue=true
mime
+The MIME type of the image. Currently image/png (default),image/svg and image/jpeg are supported. +
default=image/png
required=false
rtexprvalue=true
alt
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
hspace
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
vspace
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
align
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
border
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
ismap
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
longdesc
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
usemap
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
class
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
dir
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
lang
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onclick
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
ondbclick
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onkeydown
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onkeypress
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onkeyup
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmousedown
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmousemove
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmouseout
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmouseover
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmouseup
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
style
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
htmltitle
+Corresponds to appropriate HMTL <img> title attribute. +
required=false
rtexprvalue=true
removeAfterRender
+Remove image after rendering (defaults to false). WARNING. This may cause problems if your users expect to save the images or paste them into other applications such as WORD. +
required=false
rtexprvalue=true
forceSessionId
+Forces jsessionid to be added to image url. (Defaults to True) +
required=false
rtexprvalue=true
timeout
+Sets the timeout value used in the LongTermSessionStorage obj. Value is in seconds. Default is 5 Minutes. +
required=false
rtexprvalue=true

+ <imgurl> +

+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. +img +

Attributes
var
+Name of the page scope attribute to hold the URL. If not specified the URL is printed to the page outstream. +
required=false
rtexprvalue=true
renderer
+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. +
required=true
rtexprvalue=true
chartid
+The id of the chart to render. +
required=true
rtexprvalue=true
width
+Width of the rendered chart image in pixel. +
required=true
rtexprvalue=true
height
+Height of the rendered chart image in pixel. +
required=true
rtexprvalue=true
mime
+The MIME type of the image. Currently image/png (default),image/svg and image/jpeg are supported. +
default=image/png
required=false
rtexprvalue=true

+ <chart> +

+ optional childs: + + <chartpostprocessor>
 +Root tag of a chart description. + +data +chartpostprocessor +

Attributes
id
+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. +
required=true
rtexprvalue=true
type
+Type of the chart. One of area, areaxy, horizontalbar, horizontalbar3d, +line, pie, scatter, stackedhorizontalbar, stackedverticalbar, +stackedverticalbar3d, timeseries, verticalbar, verticalbar3d, xy, +candlestick, highlow, gantt, wind, signal, verticalxybar, pie3d +
required=true
rtexprvalue=true
title
+Title of the chart which is displayed on the chart panel +above the plot pane. +
required=false
rtexprvalue=true
xaxislabel
+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. +
required=false
rtexprvalue=true
yaxislabel
+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. +
required=false
rtexprvalue=true
background
+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. +
required=false
rtexprvalue=true
backgroundimagealpha
+Chart's backgound alpha blending value as a float. Value ranges +from 0.0 to 1.0. +0.0 +/chart[backgroundimagealpha] +
type=java.lang.Float
default=0.0
required=false
rtexprvalue=true
antialias
+Antialiased rendering of the chart. +true +/chart[backgroundimagealpha] +
default=true
required=false
rtexprvalue=true
showlegend
+Boolean value to switch on or off the legend display inside of this panel. +true +
default=true
required=false
rtexprvalue=true
legendanchor
+Sets the anchor of the legend inside of the panel. Possible values +are 'north', 'south', 'west', 'east'. +Ignored if showlegned is 'false'. +'south' +
default='south'
required=false
rtexprvalue=true

+ <overlaidchart> +

+ optional childs: + + <chartpostprocessor>
 +Root tag of a overlaid-chart description. + +data +chartpostprocessor +

Attributes
id
+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. +
required=true
rtexprvalue=true
type
+Type of the chart. In this version only overlaidxy is supported. +
required=true
rtexprvalue=true
title
+Title of the chart which is displayed on the chart panel +above the plot pane. +
required=false
rtexprvalue=true
xaxistype
+Type of the domain axis. Possible values: date, number +
required=true
rtexprvalue=true
xaxislabel
+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. +
required=false
rtexprvalue=true
yaxistype
+Type of the range axis. Possible values: date, number +
required=false
rtexprvalue=true
yaxislabel
+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. +
required=false
rtexprvalue=true
background
+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. +
required=false
rtexprvalue=true
backgroundimagealpha
+Chart's backgound alpha blending value as a float. Value ranges +from 0.0 to 1.0. +0.0 +/chart[backgroundimagealpha] +
type=java.lang.Float
default=0.0
required=false
rtexprvalue=true
antialias
+Antialiased rendering of the chart. +true +/chart[backgroundimagealpha] +
default=true
required=false
rtexprvalue=true
showlegend
+Boolean value to switch on or off the legend display inside of this panel. +true +
default=true
required=false
rtexprvalue=true
legendanchor
+Sets the anchor of the legend inside of the panel. Possible values +are 'north', 'south', 'west', 'east'. +Ignored if showlegned is 'false'. +'south' +
default='south'
required=false
rtexprvalue=true

+ <combinedchart> +

+ optional childs: + + <chartpostprocessor>
 +Root tag of a combined-chart description. + +plot +chartpostprocessor +

Attributes
id
+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. +
required=true
rtexprvalue=true
type
+Type of the chart. One of combinedxy +
required=true
rtexprvalue=true
layout
+Layout of the chart. Either vertical or horizontal +
required=true
rtexprvalue=true
title
+Title of the chart which is displayed on the chart panel +above the plot pane. +
required=false
rtexprvalue=true
xaxislabel
+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. +
required=false
rtexprvalue=true
yaxislabel
+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. +
required=false
rtexprvalue=true
background
+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. +
required=false
rtexprvalue=true
backgroundimagealpha
+Chart's backgound alpha blending value as a float. Value ranges +from 0.0 to 1.0. +0.0 +/chart[backgroundimagealpha] +
type=java.lang.Float
default=0.0
required=false
rtexprvalue=true
antialias
+Antialiased rendering of the chart. +true +/chart[backgroundimagealpha] +
default=true
required=false
rtexprvalue=true
showlegend
+Boolean value to switch on or off the legend display inside of this panel. +true +
default=true
required=false
rtexprvalue=true
legendanchor
+Sets the anchor of the legend inside of the panel. Possible values +are 'north', 'south', 'west', 'east'. +Ignored if showlegned is 'false'. +'south' +
default='south'
required=false
rtexprvalue=true

+ <legend> +

+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. +

Attributes
renderer
+Path to rendering servlet relative to web apps root URL +(e.g. servlet/cewolf). +
required=true
rtexprvalue=true
id
+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. +
required=true
rtexprvalue=true
width
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
height
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
mime
+The MIME type of the image. Currently image/png (default) and image/svg are supported. +image/png +
default=image/png
required=false
rtexprvalue=true
alt
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
hspace
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
vspace
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
align
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
border
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
ismap
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
longdesc
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
usemap
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
class
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
dir
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
lang
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onclick
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
ondbclick
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onkeydown
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onkeypress
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onkeyup
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmousedown
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmousemove
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmouseout
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmouseover
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
onmouseup
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
style
+Corresponds to appropriate HMTL <img> attribute. +
required=false
rtexprvalue=true
htmltitle
+Corresponds to appropriate HMTL <img> title attribute. +
required=false
rtexprvalue=true
removeAfterRender
+Remove image after rendering (defaults to false). WARNING. This may cause problems if your users expect to save the images or paste them into other applications such as WORD. +
required=false
rtexprvalue=true
forceSessionId
+Forces jsessionid to be added to image url. (Defaults to True) +
required=false
rtexprvalue=true
timeout
+Sets the timeout value used in the LongTermSessionStorage obj. Value is in seconds. Default is 5 Minutes. +
required=false
rtexprvalue=true

+ <data> +

+ optional childs: + + <producer>
 +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). +producer +

Attributes

+ <producer> +

+ optional childs: + + <param>
 +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). +param +

Attributes
id
+ID under which an object of type DatasetProducer can be found in +pageContext. This object is used to retrieve the dataset of the chart. +
required=true
rtexprvalue=true
usecache
+Determines if formally produced data should be reused if possible. +true +
default=true
required=false
rtexprvalue=true

+ <chartpostprocessor> +

+ optional childs: + + <param>
 +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. +param +

Attributes
id
+ID under which an object of type ChartPostProcessor can be found in +pageContext. This object is used to postprocess the rendered chart. +
required=true
rtexprvalue=true

+ <param> +

+Name/value-pair to paramterize a surrounding tag whose handler must +implement the Parameterized interface. +

Attributes
name
+Name of the param +
required=true
rtexprvalue=true
value
+Value of the param. Must be serializable. +
type=java.io.Serializable
required=true
rtexprvalue=true

+ <gradientpaint> +

+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. +point +

Attributes
cyclic
+Does the gradient cycle repeatedly between the two colors C1 and C2. +false +
default=false
required=false
rtexprvalue=true

+ <point> +

+Defines a point with x and y coordinates and a color. +colorpaint +

Attributes
x
+The x coordinate of the point. +
required=true
rtexprvalue=true
y
+The y coordinate of the point. +
required=true
rtexprvalue=true
color
+ +
required=false
rtexprvalue=true

+ <colorpaint> +

+Fills the area defined by the parent tag with a color. +

Attributes
color
+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%. +
required=true
rtexprvalue=true

+ <texturepaint> +

+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. +

Attributes
image
+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. +
required=true
rtexprvalue=true
width
+The width of the texture. +
required=true
rtexprvalue=true
height
+The height of the texture. +
required=true
rtexprvalue=true

+ <map> +

+This tag defines an image and tooltip map for the parent img tag. +img +

Attributes
linkgeneratorid
+The ID of the class which implements the appropriate de.laures.cewolf.LinkGenerator. +
required=false
rtexprvalue=true
tooltipgeneratorid
+The ID of the class which implements the appropriate com.jrefinery.chart.tooltips.ToolTipGenerator. +
required=false
rtexprvalue=true

SourceForge Logo \ No newline at end of file