SourceForge: jiu/jiu: changeset 50:306014bbfae6
Added some documentation for MapToArbitraryPaletteDialog.PaletteType. java-1.5
authorKnut Arild Erstad <knutae@gmail.com>
Sat Aug 08 22:30:03 2009 +0200 (3 months ago)
branchjava-1.5
changeset 50306014bbfae6
parent 495ea3208526f8
child 5186f7e131326d
Added some documentation for MapToArbitraryPaletteDialog.PaletteType.
net/sourceforge/jiu/gui/awt/dialogs/MapToArbitraryPaletteDialog.java
     1.1 --- a/net/sourceforge/jiu/gui/awt/dialogs/MapToArbitraryPaletteDialog.java	Sat Aug 08 22:17:16 2009 +0200
     1.2 +++ b/net/sourceforge/jiu/gui/awt/dialogs/MapToArbitraryPaletteDialog.java	Sat Aug 08 22:30:03 2009 +0200
     1.3 @@ -19,6 +19,8 @@
     1.4  import java.awt.Panel;
     1.5  import java.awt.event.ActionEvent;
     1.6  import java.awt.event.ActionListener;
     1.7 +
     1.8 +import net.sourceforge.jiu.apps.StringIndexConstants;
     1.9  import net.sourceforge.jiu.apps.Strings;
    1.10  import net.sourceforge.jiu.color.dithering.ErrorDiffusionDithering.ErrorDiffusionType;
    1.11  import net.sourceforge.jiu.util.EnumHelper;
    1.12 @@ -34,6 +36,9 @@
    1.13  public class MapToArbitraryPaletteDialog extends Dialog implements
    1.14  	ActionListener
    1.15  {
    1.16 +	/**
    1.17 +	 * Enumerates the supported palette types.
    1.18 +	 */
    1.19  	public enum PaletteType
    1.20  	{
    1.21  		FILE (Strings.PALETTE_FROM_FILE),
    1.22 @@ -50,6 +55,10 @@
    1.23  			this.stringConstant = stringConstant;
    1.24  		}
    1.25  		
    1.26 +		/**
    1.27 +		 * Get a string resource index which describes the enum value.
    1.28 +		 * @return a {@link StringIndexConstants} value.
    1.29 +		 */
    1.30  		public int getStringConstant()
    1.31  		{
    1.32  			return stringConstant;