[mapguide-commits] r7137 - trunk/MgDev/Common/PlatformBase/MapLayer

[svn_mapguide at osgeo.org]

Author: jng
Date: 2012-10-19 07:27:27 -0700 (Fri, 19 Oct 2012)
New Revision: 7137

Modified:
   trunk/MgDev/Common/PlatformBase/MapLayer/LayerGroup.h
Log:
#655: Expose MgLayerGroup.SetExpandInLegend() to the public API. Previous concerns about making this public involves unsupported interactions with the (now deprecated) DWF viewer. Notes about this unsupported interaction have been made for this particular API

Modified: trunk/MgDev/Common/PlatformBase/MapLayer/LayerGroup.h
===================================================================
--- trunk/MgDev/Common/PlatformBase/MapLayer/LayerGroup.h	2012-10-19 13:06:44 UTC (rev 7136)
+++ trunk/MgDev/Common/PlatformBase/MapLayer/LayerGroup.h	2012-10-19 14:27:27 UTC (rev 7137)
@@ -406,6 +406,35 @@
     ///
     virtual void SetLegendLabel(CREFSTRING legendLabel);
 
+    //////////////////////////////////////////////////////////////////
+    /// \brief
+    /// Specifies whether the entry for the group should initially
+    /// be expanded in the legend, if possible.
+    ///
+    /// <!-- Syntax in .Net, Java, and PHP -->
+    /// \htmlinclude DotNetSyntaxTop.html
+    /// bool SetExpandInLegend(bool expandInLegend);
+    /// \htmlinclude SyntaxBottom.html
+    /// \htmlinclude JavaSyntaxTop.html
+    /// boolean SetExpandInLegend(boolean expandInLegend);
+    /// \htmlinclude SyntaxBottom.html
+    /// \htmlinclude PHPSyntaxTop.html
+    /// bool SetExpandInLegend(bool expandInLegend);
+    /// \htmlinclude SyntaxBottom.html
+    ///
+    /// \param expandInLegend (boolean/bool)
+    /// Indicates whether this group is expanded in the legend
+    ///
+    /// \remarks 
+    /// This method is reserved only for calls from the web tier invoked by the AJAX
+    /// viewer. Invocation from the (now deprecated) DWF viewer is not supported
+    ///
+    /// \since 2.5
+    ///
+    /// \return
+    /// Returns nothing.
+    virtual void SetExpandInLegend(bool expandInLegend);
+
 INTERNAL_API:
 
     //////////////////////////////////////////////////////////////////
@@ -450,13 +479,6 @@
 
     //////////////////////////////////////////////////////////////////
     /// \brief
-    /// Specifies whether the entry for the group should initially
-    /// be expanded in the legend, if possible.
-    ///
-    virtual void SetExpandInLegend(bool expandInLegend);
-
-    //////////////////////////////////////////////////////////////////
-    /// \brief
     /// Sets the type of the layer group
     ///
     virtual void SetLayerGroupType(INT32 layerGroupType);