[Commits] r2801 - in sandbox/gxm/geoext/gxm/doc/source: . gxm gxm/data gxm/widgets
commits at geoext.org
commits at geoext.org
Mon Aug 8 16:16:46 CEST 2011
Author: marcjansen
Date: 2011-08-08 16:16:45 +0200 (Mon, 08 Aug 2011)
New Revision: 2801
Removed:
sandbox/gxm/geoext/gxm/doc/source/gxm.rst
sandbox/gxm/geoext/gxm/doc/source/gxm/Button.rst
sandbox/gxm/geoext/gxm/doc/source/gxm/GXM/
sandbox/gxm/geoext/gxm/doc/source/gxm/data.rst
Modified:
sandbox/gxm/geoext/gxm/doc/source/gxm/data/LayerStore.rst
sandbox/gxm/geoext/gxm/doc/source/gxm/widgets/LayerList.rst
Log:
[gxm] documentation updates
Deleted: sandbox/gxm/geoext/gxm/doc/source/gxm/Button.rst
===================================================================
--- sandbox/gxm/geoext/gxm/doc/source/gxm/Button.rst 2011-08-08 14:13:23 UTC (rev 2800)
+++ sandbox/gxm/geoext/gxm/doc/source/gxm/Button.rst 2011-08-08 14:16:45 UTC (rev 2801)
@@ -1,53 +0,0 @@
-
-.. currentmodule:: GeoExt
-
-:class:`GeoExt.Action`
-================================================================================
-
-
-.. cssclass:: meta
-
-
-Extends
- * `Ext.Action <http://dev.sencha.com/deploy/dev/docs/?class=Ext.Action>`_
-
-
-
-
-
-
-
-.. class:: Action(config)
-
- Create a GeoExt.Action instance. A GeoExt.Action is created
- to insert an OpenLayers control in a toolbar as a button or
- in a menu as a menu item. A GeoExt.Action instance can be
- used like a regular Ext.Action, look at the Ext.Action API
- doc for more detail.
-
-
-
-Example Use
------------
-
-Sample code to create a toolbar with an OpenLayers control into it.
-
-.. code-block:: javascript
-
- var action = new GeoExt.Action({
- text: "max extent",
- control: new OpenLayers.Control.ZoomToMaxExtent(),
- map: map
- });
- var toolbar = new Ext.Toolbar([action]);
-
-
-
-
-
-
-
-
-
-
-
Modified: sandbox/gxm/geoext/gxm/doc/source/gxm/data/LayerStore.rst
===================================================================
--- sandbox/gxm/geoext/gxm/doc/source/gxm/data/LayerStore.rst 2011-08-08 14:13:23 UTC (rev 2800)
+++ sandbox/gxm/geoext/gxm/doc/source/gxm/data/LayerStore.rst 2011-08-08 14:16:45 UTC (rev 2801)
@@ -51,6 +51,33 @@
``String`` The direction to order the store by if no :attr:`sorters`.
Defaults to `DESC`.
+.. describe:: sorterFn
+
+ ``Function`` The method used to sort store items. The method will
+ be called with two objects (instances of the configured :attr:`model`)
+ and should implement logic that determines ordering of the passed
+ objects. Your method should return
+
+ * ``1`` if the first object is greater than the second object
+ * ``-1`` if the second object is greater than the first
+ * ``0`` if they are equal.
+
+ Here is an example method:
+
+ .. code-block:: javascript
+
+ function(obj_1, obj_2) {
+ var layer_1 = obj_1.getLayer(),
+ layer_2 = obj_2.getLayer(),
+ idx_1 = layer_1.getZIndex(),
+ idx_2 = layer_2.getZIndex(),
+ res = (idx_1 > idx_2 ? 1 : (idx_1 < idx_2 ? -1 : 0));
+ return res;
+ }
+
+ You can further control the sort direction by :attr:`sortDirection`.
+
+
.. describe:: sorters
``Array(Ext.util.Sorter)`` An array of `Sorters <http://dev.sencha.com/deploy/touch/docs/?class=Ext.util.Sorter>`_
@@ -60,12 +87,9 @@
on top inside of lists that make use of this store.
The configuration of the single sorter can also be configured using the
- :attr:`sortField` and :attr:`sortDirection` configuration properties.
+ :attr:`sortDirection` configuration properties.
-.. describe:: sortField
- ``String`` The field to order the store by if no :attr:`sorters`.
- Defaults to `zindex`.
@@ -73,5 +97,3 @@
-
-
Deleted: sandbox/gxm/geoext/gxm/doc/source/gxm/data.rst
===================================================================
--- sandbox/gxm/geoext/gxm/doc/source/gxm/data.rst 2011-08-08 14:13:23 UTC (rev 2800)
+++ sandbox/gxm/geoext/gxm/doc/source/gxm/data.rst 2011-08-08 14:16:45 UTC (rev 2801)
@@ -1,8 +0,0 @@
-GXM.data
-========
-
-.. toctree::
- :maxdepth: 2
- :glob:
-
- data/*
\ No newline at end of file
Modified: sandbox/gxm/geoext/gxm/doc/source/gxm/widgets/LayerList.rst
===================================================================
--- sandbox/gxm/geoext/gxm/doc/source/gxm/widgets/LayerList.rst 2011-08-08 14:13:23 UTC (rev 2800)
+++ sandbox/gxm/geoext/gxm/doc/source/gxm/widgets/LayerList.rst 2011-08-08 14:16:45 UTC (rev 2801)
@@ -29,7 +29,7 @@
Example Use
-----------
-Sample code to create a GXM.Button that controls zooms in:
+Sample code to create a GXM.LayerList:
.. code-block:: javascript
@@ -85,6 +85,27 @@
listed for `Ext.List <http://dev.sencha.com/deploy/touch/docs/?class=Ext.List>`_.
+.. attribute:: LayerList.activeBaselayerCls
+
+ ``String`` The CSS class that the list item of the currently active
+ baselayer will get.
+
+ Defaults to ``gxm-active-baselayer-indicator``.
+
+.. attribute:: LayerList.inactiveBaselayerCls
+
+ ``String`` The CSS class that the list items of the currently inactive
+ baselayers will get.
+
+ Defaults to ``gxm-inactive-baselayer-indicator``.
+
+.. attribute:: LayerList.invisibleOverlayCls
+
+ ``String`` The CSS class that the list items forcurrently invisible
+ overlay layers will get.
+
+ Defaults to ``gxm-invisible-overlay-indicator``.
+
.. attribute:: LayerList.layers
:class:``GXM.data.LayerStore`` The layerstore this list uses.
@@ -97,9 +118,16 @@
``GXM.MapPanel`` The MapPanel of this list.
+.. attribute:: LayerList.visibleOverlayCls
+ ``String`` The CSS class that the list items for currently visible
+ overlay layers will get.
+
+ Defaults to ``gxm-visible-overlay-indicator``.
+
+
Deleted: sandbox/gxm/geoext/gxm/doc/source/gxm.rst
===================================================================
--- sandbox/gxm/geoext/gxm/doc/source/gxm.rst 2011-08-08 14:13:23 UTC (rev 2800)
+++ sandbox/gxm/geoext/gxm/doc/source/gxm.rst 2011-08-08 14:16:45 UTC (rev 2801)
@@ -1,11 +0,0 @@
-GXM
-===
-
-.. toctree::
- :maxdepth: 2
- :glob:
-
- gxm/*
- gxm/widgets/*
- gxm/data/*
- gxm/data/model*
More information about the Commits
mailing list