Merge pull request #16 from gravitystorm/documentation
authorRichard Fairhurst <richard@systemeD.net>
Fri, 30 Sep 2011 20:44:16 +0000 (13:44 -0700)
committerRichard Fairhurst <richard@systemeD.net>
Fri, 30 Sep 2011 20:44:16 +0000 (13:44 -0700)
Documentation

1  2 
build.xml
net/systemeD/controls/DataGridWarningField.as

diff --combined build.xml
index 8e7b87fd5978c2332124a3055d1e95eb3aa30a7f,eabba0879081f6ffcc8401afb20d9f1f92386c42..07e43f6b541ab8ae6c81d99ae574cce3684568c5
+++ b/build.xml
@@@ -1,4 -1,4 +1,4 @@@
 -<project name="Potlatch2 ├╝ber compile system" default="debug">
 +<project name="Potlatch 2" default="debug">
  
    <!-- load properties from the environment -->
    <property environment="env" />
@@@ -45,7 -45,7 +45,7 @@@
    </target>
  
    <!-- Build and output potlatch2.swf in release mode -->
 -  <target name="release" depends="init">
 +  <target name="release" depends="init"> <!-- FIXME convention is dist not release -->
      <mxmlc file="potlatch2.mxml">
        <load-config filename="${FLEX_HOME}/frameworks/flex-config.xml"/>
        <source-path path-element="${FLEX_HOME}/frameworks"/>
        <arg line="-source-path ."/>
        <arg line="-doc-sources net/systemeD/"/>
        <arg line="-external-library-path=lib/"/>
 +      <arg line="-target-player 10.0.0"/>
        <arg line="-exclude-classes ${org_classes} ${it_classes} ${hxasm_classes} ${com_classes}"/>
        <arg line="-output resources/docs/"/>
        <arg line="-window-title 'Halcyon and Potlatch2 Developer documentation'" />
        <arg line="-main-title 'Halcyon and Potlatch2 Developer documentation'" />
        <arg line="-footer 'Found an error? Help us fix it. http://wiki.openstreetmap.org/wiki/Potlatch2'"/>
-       <arg line="-package net.systemeD.controls 'Custom-built controls used in Poltatch2'" />
+       <arg line="-package net.systemeD.controls 'Custom-built controls used in Potlatch2'" />
        <arg line="-package net.systemeD.halcyon 'The AS3 rendering library'" />
        <arg line="-package net.systemeD.halcyon.connection 'The connection to the main OSM server, and the entities'" />
        <arg line="-package net.systemeD.halcyon.connection.actions 'The undoable actions that apply to OSM data'" />
@@@ -77,6 -76,7 +77,7 @@@
        <arg line="-package net.systemeD.potlatch2 'The OpenStreetMap editor'" />
        <arg line="-package net.systemeD.potlatch2.collections 'Singletons for handling collections loaded from config files'" />
        <arg line="-package net.systemeD.potlatch2.controller 'The various controller states that p2 can be in'" />
+       <arg line="-package net.systemeD.potlatch2.find 'The search dialog for jumping to another place'" />
        <arg line="-package net.systemeD.potlatch2.help 'The Help dialog'" />
        <arg line="-package net.systemeD.potlatch2.mapfeatures 'The engine behind the mapfeatures parsing'" />
        <arg line="-package net.systemeD.potlatch2.mapfeatures.editors 'The various widgets used in the Simple panel'" />
         
        <!-- Sets java.awt.headless=true so font compilation works in headless environments -->
        <compiler.headless-server>true</compiler.headless-server>
 +      <target-player>10.0.0</target-player>
       </mxmlc>
       
       <echo message="The ${test.application.name}.swf test runner has been created in ${test.bin.dir}" />
      <deployLocale locale="pl_PL" />
    </target>
  
 +
 +  <target name="clean"
 +    description="clean up" >
 +    <!-- Delete the ${build} and ${dist} directory trees -->
 +    <!--
 +
 +    FIXME what is supposed to be cleaned?
 +
 +    <delete dir="${build}"/>
 +    <delete dir="${dist}"/>
 +
 +    -->
 +  </target>
 +
 +
  </project>
index 47ac69959275068037a8aeb154a97cac14507e6a,a337cc479b49ad09c0a9ae684ce4a68295dad63f..caa14235bc37877564c8c928727eca6b499b1960
@@@ -3,12 -3,19 +3,20 @@@ package net.systemeD.controls 
        import mx.controls.listClasses.*;
        import flash.display.DisplayObject;
        import mx.controls.Image;
-  
+     /**
+     * The DataGridWarningField is a custom Label component that highlights values containing semicolons.
+     * It does so using colour and a warning icon. Simply use in place of a standard Label component, or use
+     * as a custom itemRenderer for a DataGridColumn.
+     *
+     * @see PromptingTextInputWarning
+     */
        public class DataGridWarningField extends Label {
  
                private var _image:Image;
                [Embed(source="../../../embedded/warning.png")] private var warningIcon:Class;
 +              private var _whiteList:Array = ["source","collection_times","service_times","smoking_hours","opening_hours"];
  
                function DataGridWarningField():void {
                        super();
@@@ -26,8 -33,8 +34,8 @@@
  
                override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void {
                        super.updateDisplayList(unscaledWidth, unscaledHeight);
 - 
 -                      if (data.value && data.value.indexOf(';')>-1) {
 +
 +                      if (data.value && (_whiteList.indexOf(data.key)==-1) && (data.value.indexOf(';')>-1)) { 
                                setStyle('color',0xFF0000);
                                _image.visible=true;
                                _image.x = width -_image.width -5;