[Laszlo-checkins] r8379 - in openlaszlo/trunk: WEB-INF/lps/lfc/helpers WEB-INF/lps/lfc/kernel/swf docs/src/nav docs/src/reference docs/src/xsl lps/components/charts lps/components/charts/addon lps/components/charts/barchart lps/components/charts/columnchart lps/components/charts/common lps/components/charts/linechart lps/components/charts/piechart lps/components/charts/styles lps/components/extensions/views
dda@openlaszlo.org
dda at openlaszlo.org
Mon Mar 24 15:26:04 PDT 2008
Author: dda
Date: 2008-03-24 15:25:48 -0700 (Mon, 24 Mar 2008)
New Revision: 8379
Modified:
openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzFont.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/kernel/swf/LzAudio.as
openlaszlo/trunk/docs/src/nav/toc.xml
openlaszlo/trunk/docs/src/reference/wrappers.xml
openlaszlo/trunk/docs/src/xsl/lzx2js2doc.xsl
openlaszlo/trunk/lps/components/charts/addon/library.lzx
openlaszlo/trunk/lps/components/charts/addon/zoomarea.lzx
openlaszlo/trunk/lps/components/charts/barchart/barchart.lzx
openlaszlo/trunk/lps/components/charts/columnchart/columnchart.lzx
openlaszlo/trunk/lps/components/charts/common/axis.lzx
openlaszlo/trunk/lps/components/charts/common/chart.lzx
openlaszlo/trunk/lps/components/charts/common/datalabel.lzx
openlaszlo/trunk/lps/components/charts/common/datamarker.lzx
openlaszlo/trunk/lps/components/charts/common/dataseries.lzx
openlaszlo/trunk/lps/components/charts/common/datatip.lzx
openlaszlo/trunk/lps/components/charts/common/horizontalaxis.lzx
openlaszlo/trunk/lps/components/charts/common/label.lzx
openlaszlo/trunk/lps/components/charts/common/legend.lzx
openlaszlo/trunk/lps/components/charts/common/library.lzx
openlaszlo/trunk/lps/components/charts/common/rectangularchart.lzx
openlaszlo/trunk/lps/components/charts/common/valueline.lzx
openlaszlo/trunk/lps/components/charts/common/valuepoints.lzx
openlaszlo/trunk/lps/components/charts/common/valueregion.lzx
openlaszlo/trunk/lps/components/charts/common/verticalaxis.lzx
openlaszlo/trunk/lps/components/charts/library.lzx
openlaszlo/trunk/lps/components/charts/linechart/linechart.lzx
openlaszlo/trunk/lps/components/charts/piechart/piechart.lzx
openlaszlo/trunk/lps/components/charts/piechart/piechartplotarea.lzx
openlaszlo/trunk/lps/components/charts/styles/chartstyle.lzx
openlaszlo/trunk/lps/components/extensions/views/LzTextFormat.lzx
Log:
Change 20080324-dda-f by dda at lester.local on 2008-03-24 17:45:39 EDT
in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc2
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: doc: Add charts and some minor cleanups in HTML/Media category
New Features:
Bugs Fixed: LPP-4935 (complete), LPP-5396 (partial)
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)
Documentation:
See details.
Release Notes:
Details:
- To Contents tab under HTML, replaced LzTextFormat (deprecated) by textformat.
- To Contents tab under Charts, copied list from 3.4.
- Insert @access public judiciously in charts sources.
- In charts sources, worked around a couple problems where <include>
was not always working to pick up contents of needed files.
This was done by inserting a couple of redundant <include> tags
to pick up the needed files. The two problems:
-- <include href="../xxx/file.lzx"> is silently failing to open the file.
I made some primitive attempts to fix in the xsl before deciding to workaround.
-- <include href="piechartplotarea.lzx"> is failing to get included content when used from piechart.lzx.
Did some prelim diagnosis, but still do not know the reason.
- Also corrected an errant include of legend.lzx in piechart.lzx (it was probably
already included elsewhere, allowing it to work).
- Changed the file headers for LzAudio.lzs and LzFont.lzs files to be @access public
in an attempt to produce content for these files. LzFont.html is now produced,
and is referenced from TOC.
- fixed a couple typos in content.
Tests:
Testing content:
Did 'ant reference' in docs/src and checked all the links in the changed sections of the TOC.
Testing charts:
Did 'ant clean; ant; at the top of the tree to rebuild everything (especially charts).
Checked that the doc chart examples run.
Regression:
did smokecheck SWF8/DHTML
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzFont.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzFont.lzs 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/helpers/LzFont.lzs 2008-03-24 22:25:48 UTC (rev 8379)
@@ -4,7 +4,7 @@
* Use is subject to license terms.
*
* @affects lzfont
- * @access private
+ * @access public
* @topic LFC
* @subtopic Helpers
*/
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/kernel/swf/LzAudio.as
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/kernel/swf/LzAudio.as 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/kernel/swf/LzAudio.as 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,7 +1,7 @@
/**
* LzAudio.as
*
- * @copyright Copyright 2001-2006 Laszlo Systems, Inc. All Rights Reserved.
+ * @copyright Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
*
* @topic Kernel
@@ -10,6 +10,7 @@
/**
* @shortdesc This service manages audio resource playback.
+ * @access public
*
*/
var LzAudio = new Object;
Modified: openlaszlo/trunk/docs/src/nav/toc.xml
===================================================================
--- openlaszlo/trunk/docs/src/nav/toc.xml 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/docs/src/nav/toc.xml 2008-03-24 22:25:48 UTC (rev 8379)
@@ -102,7 +102,6 @@
<category title="HTML Markup">
- <item title="LzTextFormat" href="lz.LzTextFormat.html" />
<item title="a" href="tag-a.html"/>
<item title="b" href="tag-b.html"/>
<item title="br" href="tag-br.html"/>
@@ -111,12 +110,13 @@
<item title="img" href="tag-img.html"/>
<item title="p" href="tag-p.html"/>
<item title="pre" href="tag-pre.html"/>
+ <item title="textformat" href="lz.textformat.html" />
<item title="u" href="tag-u.html"/>
</category>
<category title="Media" >
<item title="audio" href="tag-audio.html"/>
- <!-- TODO: [2008-01-28 dda] <item title="font (LzFont)" href="lz.LzFont.html" /> -->
+ <item title="font" href="LzFont.html" />
<item title="face" href="tag-face.html"/>
<item title="frame" href="tag-frame.html"/>
<item title="image" href="lz.image.html"/>
@@ -222,7 +222,42 @@
</category>
<category title="Charts and Graphs">
- <item title="TODO [LPP-4935]" />
+ <item title="axisstyle" href="lz.axisstyle.html"/>
+ <item title="barchart" href="lz.barchart.html"/>
+ <item title="basestyle" href="lz.basestyle.html"/>
+ <item title="chart" href="lz.chart.html"/>
+ <item title="chartbgstyle" href="lz.chartbgstyle.html"/>
+ <item title="chartstyle" href="lz.chartstyle.html"/>
+ <item title="axis" href="lz.axis.html"/>
+ <item title="columnchart" href="lz.columnchart.html"/>
+ <item title="datacolumn" href="lz.datacolumn.html"/>
+ <item title="datamarker" href="lz.datamarker.html"/>
+ <item title="datalabel" href="lz.datalabel.html"/>
+ <item title="dataseries" href="lz.dataseries.html"/>
+ <item title="datastyle" href="lz.datastyle.html"/>
+ <item title="datastylelist" href="lz.datastylelist.html"/>
+ <item title="datatip" href="lz.datatip.html"/>
+ <item title="horizontalaxis" href="lz.horizontalaxis.html"/>
+ <item title="label" href="lz.label.html"/>
+ <item title="labelstyle" href="lz.labelstyle.html"/>
+ <item title="legend" href="lz.legend.html"/>
+ <item title="linechart" href="lz.linechart.html"/>
+ <item title="linestyle" href="lz.linestyle.html"/>
+ <item title="piechart" href="lz.piechart.html"/>
+ <item title="piechartplotarea" href="lz.piechartplotarea.html"/>
+ <item title="plotstyle" href="lz.plotstyle.html"/>
+ <item title="pointstyle" href="lz.pointstyle.html"/>
+ <item title="rectangularchart" href="lz.rectangularchart.html"/>
+ <item title="regionstyle" href="lz.regionstyle.html"/>
+ <item title="tickstyle" href="lz.tickstyle.html"/>
+ <item title="valueline" href="lz.valueline.html"/>
+ <item title="valuelinestyle" href="lz.valuelinestyle.html"/>
+ <item title="valuepoints" href="lz.valuepoints.html"/>
+ <item title="valuepointstyle" href="lz.valuepointstyle.html"/>
+ <item title="valueregion" href="lz.valueregion.html"/>
+ <item title="valueregionstyle" href="lz.valueregionstyle.html"/>
+ <item title="verticalaxis" href="lz.verticalaxis.html"/>
+ <item title="zoomarea" href="lz.zoomarea.html"/>
</category>
<category title="Audio Video">
Modified: openlaszlo/trunk/docs/src/reference/wrappers.xml
===================================================================
--- openlaszlo/trunk/docs/src/reference/wrappers.xml 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/docs/src/reference/wrappers.xml 2008-03-24 22:25:48 UTC (rev 8379)
@@ -207,9 +207,9 @@
<tagname>text</tagname>.</p>
<example>
-<canvas height="30">
+<canvas height="100">
<text multiline="true">
- <p>A pararaph.</p>
+ <p>A paragraph.</p>
<p>Another one.</p>
</text>
</canvas>
Modified: openlaszlo/trunk/docs/src/xsl/lzx2js2doc.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/lzx2js2doc.xsl 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/docs/src/xsl/lzx2js2doc.xsl 2008-03-24 22:25:48 UTC (rev 8379)
@@ -68,6 +68,12 @@
<xsl:param name="path"/>
<xsl:param name="unitid"/>
<xsl:if test="contains($path,'library.lzx')">
+ <!-- TODO [dda 2008-03-24] handle include href="../xxx/name.lzx"
+ To do that, need to create a URI for the parent directory,
+ and pass that as a second arg to document().
+ For now, we require (for doc) that there be at least one
+ 'straight' include of each doc without ..
+ -->
<xsl:variable name="doc" select="document(@href)"/>
<xsl:variable name="newpath" select="concat(substring-before($path,'library.lzx'), at href)"/>
<xsl:apply-templates select="$doc" mode="nested">
Modified: openlaszlo/trunk/lps/components/charts/addon/library.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/addon/library.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/addon/library.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,13 +1,14 @@
<!---
- @topic Charting And Graphing
- @subtopic Add-on
+ @access public
+ @topic Components
+ @subtopic Charts
-->
<library>
<include href="zoomarea.lzx" />
<include href="slider/slider.lzx" />
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2005-2007 Laszlo Systems, Inc. All Rights Reserved. *
+* Copyright 2005-2008 Laszlo Systems, Inc. All Rights Reserved. *
* Use is subject to license terms. *
* X_LZ_COPYRIGHT_END ****************************************************** -->
<!-- @LZX_VERSION@ -->
Modified: openlaszlo/trunk/lps/components/charts/addon/zoomarea.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/addon/zoomarea.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/addon/zoomarea.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,7 +1,13 @@
-<library>
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
+<library>
<!--- An abstract class that provide basic zooming ability.
Allow subclasses to modify the look and feel
and action to be taken
+ @access public
-->
<class name="basezoomarea" visible="false">
<!--- the chart instance -->
Modified: openlaszlo/trunk/lps/components/charts/barchart/barchart.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/barchart/barchart.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/barchart/barchart.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/chartstyle.lzx"/>
<include href="../common/dataseries.lzx"/>
@@ -10,7 +15,10 @@
<include href="barchartplotarea.lzx"/>
<include href="../common/datalabel.lzx"/>
- <!--- A chart class that renders horizontal bars. Inherits from the chart class. (Warning: Of beta quality.) -->
+ <!--- A chart class that renders horizontal bars.
+ Inherits from the chart class. (Warning: Of beta quality.)
+ @access public
+ -->
<class name="barchart" extends="rectangularchart">
<!--- @keyword private -->
<method name="init">
@@ -178,7 +186,7 @@
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/columnchart/columnchart.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/columnchart/columnchart.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/columnchart/columnchart.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/chartstyle.lzx"/>
<include href="../common/dataseries.lzx"/>
@@ -9,7 +14,11 @@
<include href="../common/databar.lzx"/>
<include href="columnchartplotarea.lzx"/>
- <!--- A chart class that renders vertical bars. Inherits from the chart class. (Warning: Of beta quality.) -->
+ <!---
+ A chart class that renders vertical bars.
+ Inherits from the chart class. (Warning: Of beta quality.)
+ @access public
+ -->
<class name="columnchart" extends="rectangularchart">
<!--- @keyword private -->
<method name="init">
@@ -167,7 +176,7 @@
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/common/axis.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/axis.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/axis.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/strokestyle.lzx"/>
<include href="../common/label.lzx"/>
@@ -5,6 +10,7 @@
<include href="extensions/drawview.lzx"/>
<!--- A abstract class that represents one of the axes of a rectangular chart. In general, axis isn't instantiated directly
+ @access public
-->
<class name="axis" extends="drawview">
<!--- Data Column that is used to override the values of Tic Marks labels -->
@@ -555,7 +561,7 @@
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/common/chart.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/chart.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/chart.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="datatip.lzx"/>
<include href="charts/styles/styleparser.lzx"/>
@@ -13,6 +18,7 @@
the relevant dataseries to each axis. Relevent dataseries
for the chart must have columns for each of the axes
that the chart cares about.
+ @access public
-->
<class name="chart" extends="basecomponent">
<!--- @keywords private -->
Modified: openlaszlo/trunk/lps/components/charts/common/datalabel.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/datalabel.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/datalabel.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,7 +1,15 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="label.lzx"/>
<!-- Begin Data Label Class -->
- <!--- Represents the data text which appears on a computerized note -->
+ <!---
+ Represents the data text which appears on a computerized note
+ @access public
+ -->
<class name="datalabel" extends="label">
<!--- @keyword private -->
@@ -24,7 +32,7 @@
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/common/datamarker.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/datamarker.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/datamarker.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,6 +1,14 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="extensions/drawview.lzx"/>
- <!--- datamarker for the chart -->
+ <!---
+ datamarker for the chart
+ @access public
+ -->
<class name="datamarker" extends="drawview">
<!--- @keywords private -->
<attribute name="locationx" type="number" value="0"/>
@@ -135,7 +143,7 @@
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved. *
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved. *
* Use is subject to license terms. *
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/common/dataseries.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/dataseries.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/dataseries.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,6 +1,12 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<!--- datacolumn contain a list of values of a series. List of values typically are data for x series,
y series, tooltip series and datalabel series.
+ @access public
-->
<class name="datacolumn">
<!--- the name of the column in the datapath for the series -->
@@ -182,7 +188,9 @@
</class>
<!---
- A dataseries in a container for dataseries and datacolumn. dataseries can be nested.
+ A dataseries in a container for dataseries and datacolumn.
+ dataseries can be nested.
+ @access public
-->
<class name="dataseries">
<!--- enable the dataseries -->
Modified: openlaszlo/trunk/lps/components/charts/common/datatip.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/datatip.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/datatip.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,7 +1,15 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="label.lzx"/>
- <!--- tooltip is a tool tip to be use be the chart elements such as the plot area -->
+ <!---
+ tooltip is a tool tip to be use be the chart elements such as the plot area
+ @access public
+ -->
<class name="datatip" visible="false" extends="label" enableCache="false">
<!--- sets visible to true and positioned the object
@keyword private-->
@@ -34,7 +42,7 @@
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved. *
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved. *
* Use is subject to license terms. *
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/common/horizontalaxis.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/horizontalaxis.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/horizontalaxis.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/strokestyle.lzx"/>
<include href="../common/label.lzx"/>
@@ -3,5 +8,8 @@
<include href="axis.lzx"/>
<!-- Begin Horizontal Axis Class -->
- <!--- Represents the X-axis on the rectangular chart extends from Axis class-->
+ <!---
+ Represents the X-axis on the rectangular chart extends from Axis class
+ @access public
+ -->
<class name="horizontalaxis" extends="axis">
<!--- @keyword private-->
@@ -223,7 +231,7 @@
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/common/label.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/label.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/label.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/chartstyle.lzx"/>
<include href="extensions/drawview.lzx"/>
@@ -2,4 +7,6 @@
<!-- Begin Data Label Class -->
- <!--- An abstract class that applies all features label.
- -->
+ <!---
+ An abstract class that applies all features label.
+ @access public
+ -->
<class name="label" extends="drawview">
@@ -138,7 +145,7 @@
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/common/legend.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/legend.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/legend.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/strokestyle.lzx"/>
<include href="../piechart/piepiece.lzx"/>
@@ -4,7 +9,10 @@
<include href="utils/layouts/simplelayout.lzx"/>
<include href="extensions/drawview.lzx"/>
- <!--- simple legend class -->
+ <!---
+ simple legend class
+ @access public
+ -->
<class name="legend" extends="drawview" datapath="">
<!--- @keyword private -->
<attribute name="topmargin" type="number" value="5"/>
Modified: openlaszlo/trunk/lps/components/charts/common/library.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/library.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/library.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,6 +1,7 @@
<!---
- @topic Charting And Graphing
- @subtopic Common
+ @access public
+ @topic Components
+ @subtopic Charts
-->
<library>
<include href="axis.lzx" />
@@ -24,7 +25,7 @@
<include href="virtualdrawview.lzx" />
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2005-2007 Laszlo Systems, Inc. All Rights Reserved. *
+* Copyright 2005-2008 Laszlo Systems, Inc. All Rights Reserved. *
* Use is subject to license terms. *
* X_LZ_COPYRIGHT_END ****************************************************** -->
<!-- @LZX_VERSION@ -->
Modified: openlaszlo/trunk/lps/components/charts/common/rectangularchart.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/rectangularchart.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/rectangularchart.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="chart.lzx"/>
<include href="horizontalaxis.lzx"/>
@@ -2,3 +7,6 @@
<include href="verticalaxis.lzx"/>
- <!--- class that provides all common features for the rectangular charts like line, bar and column -->
+ <!---
+ class that provides all common features for the rectangular charts like line, bar and column
+ @access public
+ -->
<class name="rectangularchart" extends="chart" clip="true">
Modified: openlaszlo/trunk/lps/components/charts/common/valueline.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/valueline.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/valueline.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../common/label.lzx"/>
<include href="extensions/drawview.lzx"/>
@@ -2,3 +7,6 @@
- <!--- Represents a line in the chart -->
+ <!---
+ Represents a line in the chart
+ @access public
+ -->
<class name="valueline" extends="drawview">
Modified: openlaszlo/trunk/lps/components/charts/common/valuepoints.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/valuepoints.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/valuepoints.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="label.lzx"/>
<include href="datamarker.lzx"/>
@@ -2,3 +7,6 @@
- <!--- Represents a value point in the chart -->
+ <!---
+ Represents a value point in the chart
+ @access public
+ -->
<class name="valuepoints">
Modified: openlaszlo/trunk/lps/components/charts/common/valueregion.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/valueregion.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/valueregion.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,6 +1,14 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="extensions/drawview.lzx"/>
- <!--- Represents a region of values in the chart -->
+ <!---
+ Represents a region of values in the chart
+ @access public
+ -->
<class name="valueregion" extends="drawview">
<!--- enable the rendering of the value region in the chart -->
<attribute name="regionEnabled" value="true"/>
Modified: openlaszlo/trunk/lps/components/charts/common/verticalaxis.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/common/verticalaxis.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/common/verticalaxis.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/strokestyle.lzx"/>
<include href="../common/label.lzx"/>
@@ -3,5 +8,7 @@
<include href="axis.lzx"/>
<!-- Begin Vertical Axis Class -->
-<!--- Represents the Y axis on the rectangular chart, extends from Axis class -->
+<!--- Represents the Y axis on the rectangular chart, extends from Axis class
+ @access public
+ -->
<class name="verticalaxis" extends="axis">
<!--- @keyword private-->
@@ -153,7 +160,7 @@
<!-- End Vertical Axis Class -->
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/library.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/library.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/library.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,6 +1,7 @@
<!---
- @topic Charting And Graphing
- @subtopic Chart Types
+ @access public
+ @topic Components
+ @subtopic Charts
-->
<library>
<include href="common/library.lzx" />
@@ -9,9 +10,22 @@
<include href="columnchart/columnchart.lzx" />
<include href="linechart/linechart.lzx" />
<include href="piechart/piechart.lzx" />
+
+ <!-- TODO [dda 2008-03-24] The following include is required for doctools.
+ It's implicitly included from other files, but include "../anything"
+ is not handled well by our xsl.
+ -->
+ <include href="styles/chartstyle.lzx"/>
+
+ <!-- TODO [dda 2008-03-24] The following include is required for doctools.
+ For some reason, without it, piechartplotarea is not generated,
+ even though it is included by piechart/piechart.lzx.
+ -->
+ <include href="piechart/piechartplotarea.lzx"/>
+
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved. *
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved. *
* Use is subject to license terms. *
* X_LZ_COPYRIGHT_END ****************************************************** -->
<!-- @LZX_VERSION@ -->
Modified: openlaszlo/trunk/lps/components/charts/linechart/linechart.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/linechart/linechart.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/linechart/linechart.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/chartstyle.lzx"/>
<include href="../common/dataseries.lzx"/>
@@ -14,7 +19,11 @@
<include href="linechartplotarea.lzx"/>
- <!--- A chart class that renders as lines. Inherits from the chart class. (Warning: Of beta quality.) -->
+ <!--- A chart class that renders as lines.
+ Inherits from the chart class.
+ (Warning: Of beta quality.)
+ @access public
+ -->
<class name="linechart" extends="rectangularchart">
<!--- @keyword private -->
<method name="init">
@@ -199,7 +208,7 @@
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/piechart/piechart.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/piechart/piechart.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/piechart/piechart.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/chartstyle.lzx"/>
<include href="../common/dataseries.lzx"/>
@@ -5,13 +10,16 @@
<include href="../common/virtualdrawview.lzx"/>
<include href="../common/datalabel.lzx"/>
<include href="../common/chart.lzx"/>
- <include href="charts/common/legend.lzx"/>
+ <include href="../common/legend.lzx"/>
<include href="piepiece.lzx"/>
<include href="piechartplotarea.lzx"/>
- <!--- A pie chart represents a chart that is displayed in the 2D
+ <!---
+ A pie chart represents a chart that is displayed in the 2D
polar plane. This class inherits immediately from chart class
- and can be instantiated directly. (Warning: Of beta quality.)-->
+ and can be instantiated directly. (Warning: Of beta quality.)
+ @access public
+ -->
<class name="piechart" extends="chart">
<!--- @keywords private -->
@@ -150,9 +158,9 @@
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
<!-- @LZX_VERSION@
- -->
\ No newline at end of file
+ -->
Modified: openlaszlo/trunk/lps/components/charts/piechart/piechartplotarea.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/piechart/piechartplotarea.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/piechart/piechartplotarea.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,3 +1,8 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
<include href="../styles/strokestyle.lzx"/>
<include href="../common/viewspoolmanager.lzx"/>
@@ -3,5 +8,8 @@
<include href="extensions/drawview.lzx"/>
- <!--- A pie chart plot area where the pie slices are rendered -->
+ <!---
+ A pie chart plot area where the pie slices are rendered
+ @access public
+ -->
<class name="piechartplotarea" extends="drawview">
<!--- Array that holds the attributes regarding the dimension and position
@@ -124,7 +132,7 @@
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN
***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved.
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved.
* Use is subject to license terms.
* X_LZ_COPYRIGHT_END
****************************************************** -->
Modified: openlaszlo/trunk/lps/components/charts/styles/chartstyle.lzx
===================================================================
--- openlaszlo/trunk/lps/components/charts/styles/chartstyle.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/charts/styles/chartstyle.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,8 +1,15 @@
+<!---
+ @access public
+ @topic Components
+ @subtopic Charts
+ -->
<library>
-<!--- base style for all chart style -->
+<!--- base style for all chart styles
+ @access public
+ -->
<class name="basestyle" extends="view" opacity="0">
- <!--- below are the methods copied over from the style class of basecomponents -->
+ <!-- below are the methods copied over from the style class of basecomponents -->
<!--- set a specific style attribute, generating an onstylechanged event
-->
@@ -74,7 +81,9 @@
</method>
</class>
-<!--- style for point and datamarker -->
+<!--- style for point and datamarker
+ @access public
+ -->
<class name="pointstyle" extends="basestyle" width="5" height="5">
<!--- RGB color -->
<attribute name="color" type="color" value="black"/>
@@ -92,7 +101,9 @@
<attribute name="lineWidth" type="number" value="0"/>
</class>
-<!--- style for point or border -->
+<!--- style for point or border
+ @access public
+ -->
<class name="linestyle" extends="basestyle" >
<!--- pixel size for the stroke of the line -->
<attribute name="size" type="number" value="1"/>
@@ -104,7 +115,9 @@
<attribute name="type" type="string" value="solid" />
</class>
-<!--- style for a region -->
+<!--- style for a region
+ @access public
+ -->
<class name="regionstyle" extends="basestyle" stretches="both">
<!--- RGB color on the axis line -->
<attribute name="color" type="color" value="0xFF0000"/>
@@ -117,7 +130,9 @@
</class>
-<!--- style object used for anything that contains a label within the chart. -->
+<!--- style object used for anything that contains a label within the chart.
+ @access public
+ -->
<class name="labelstyle" extends="basestyle" >
<!--- size of border of label background -->
<attribute name="linesize" type="number" value="null"/>
@@ -144,7 +159,9 @@
<!--- tickstyle is used by the axis style to render major and minor ticks on a chart.
- NOTE: tickstyle extends linestyle -->
+ NOTE: tickstyle extends linestyle
+ @access public
+ -->
<class name="tickstyle" extends="linestyle" >
<!--- length of tick in pixels perpendicualr to the axis -->
<attribute name="length" type="number" value="5"/>
@@ -156,7 +173,9 @@
</class>
<!--- valuelinestyle is used to set style to the
- NOTE: valuelinestyle extends basestyle -->
+ NOTE: valuelinestyle extends basestyle
+ @access public
+ -->
<class name="valuelinestyle" extends="basestyle" >
<?STRUCTURE ...
<linestyle name="line" /> <!--- instance of linestyle -->
@@ -166,7 +185,9 @@
</class>
<!--- valuepointstyle is used to set style to the
- NOTE: valuelinestyle extends basestyle -->
+ NOTE: valuelinestyle extends basestyle
+ @access public
+ -->
<class name="valuepointstyle" extends="basestyle" >
<?STRUCTURE ...
<pointstyle name="point"/> <!--- an instance of pointstyle -->
@@ -175,7 +196,9 @@
?>
</class>
-<!--- style for axis -->
+<!--- style for axis
+ @access public
+ -->
<class name="axisstyle" extends="basestyle" >
<!--- direction of the axis: x or y -->
<attribute name="direction" value="y | x" type="string" />
@@ -191,7 +214,9 @@
</class>
-<!--- style for plot area -->
+<!--- style for plot area
+ @access public
+ -->
<class name="plotstyle" extends="basestyle">
<!--- size of border of the plot area -->
<attribute name="linesize" type="number" value="0"/>
@@ -203,7 +228,9 @@
<attribute name="opacity" type="number" value="1"/>
</class>
-<!--- style for chart background -->
+<!--- style for chart background
+ @access public
+ -->
<class name="chartbgstyle" extends="basestyle">
<?STRUCTURE ...
<linestyle name="line"/> <!--- instance of linestyle -->
@@ -211,7 +238,9 @@
?>
</class>
-<!--- dataseriesstyle is used for drawing the appearance of a dataseries -->
+<!--- dataseriesstyle is used for drawing the appearance of a dataseries
+ @access public
+ -->
<class name="datastyle" extends="basestyle" >
<?STRUCTURE ...
@@ -225,7 +254,9 @@
</class>
-<!--- valueregionstyle is used for drawing the appearance of a value region -->
+<!--- valueregionstyle is used for drawing the appearance of a value region
+ @access public
+ -->
<class name="valueregionstyle" extends="basestyle" >
<?STRUCTURE ...
@@ -237,7 +268,9 @@
</class>
-<!--- style for chart, contain nested level of style extend from basestyle -->
+<!--- style for chart, contain nested level of style extend from basestyle
+ @access public
+ -->
<class name="chartstyle" extends="basestyle" >
<!--- @keyword private -->
<attribute name="datastyleindex" value="0" type="number"/>
@@ -302,7 +335,9 @@
<event name="onversion" />
</class>
-<!--- list of datastyle -->
+<!--- list of datastyle
+ @access public
+ -->
<class name="datastylelist" extends="basestyle">
</class>
Modified: openlaszlo/trunk/lps/components/extensions/views/LzTextFormat.lzx
===================================================================
--- openlaszlo/trunk/lps/components/extensions/views/LzTextFormat.lzx 2008-03-24 22:24:00 UTC (rev 8378)
+++ openlaszlo/trunk/lps/components/extensions/views/LzTextFormat.lzx 2008-03-24 22:25:48 UTC (rev 8379)
@@ -1,9 +1,9 @@
<library>
-<!--- @keyword deprecated
- An object to specify the format of a text object. Used only in
- Javascript by richinputtext.setTextFormat
- (deprecating 5/17/2007 - use textformat instead, per LPP-3406)
+<!---
+ An object to specify the format of a text object. Used only in
+ Javascript by richinputtext.setTextFormat.
+ @shortdesc Formats rich text
-->
<class name="textformat" extends="node">
@@ -51,12 +51,16 @@
</method>
</class>
+<!---
+ LzTextFormat is deprecated. Use 'textformat' instead.
+ @keyword deprecated
+-->
<class name="LzTextFormat" extends="textformat"
oninit="Debug.warn('`LzTextFormat` is deprecated. Use `textformat`.')"/>
</library>
<!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved. *
+* Copyright 2001-2008 Laszlo Systems, Inc. All Rights Reserved. *
* Use is subject to license terms. *
* X_LZ_COPYRIGHT_END ****************************************************** -->
<!-- @LZX_VERSION@ -->
More information about the Laszlo-checkins
mailing list