Mercurial > dive4elements > river
diff flys-client/src/main/java/de/intevation/flys/client/shared/model/Style.java @ 1345:92074508a387
Added documentation.
flys-client/trunk@3003 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Raimund Renkert <raimund.renkert@intevation.de> |
---|---|
date | Tue, 18 Oct 2011 12:33:23 +0000 |
parents | 974c6b3700de |
children | bb91cdf8407b |
line wrap: on
line diff
--- a/flys-client/src/main/java/de/intevation/flys/client/shared/model/Style.java Mon Oct 17 17:33:27 2011 +0000 +++ b/flys-client/src/main/java/de/intevation/flys/client/shared/model/Style.java Tue Oct 18 12:33:23 2011 +0000 @@ -10,18 +10,31 @@ */ public class Style implements Serializable { + /** The theme name. */ protected String name; + /** The facet. */ protected String facet; + /** The theme index. */ protected int index; + /** List of theme attribute settings. */ protected List<StyleSetting> settings; + + /** + * Create a new style for theme attribution. + */ public Style() { settings = new ArrayList<StyleSetting>(); } + + /** + * Append a new style setting. + * @param setting A theme attribution setting. + */ public void appendStyleSetting(StyleSetting setting) { settings.add(setting); } @@ -50,6 +63,11 @@ return this.index; } + + /** + * Getter for a theme attribution setting. + * @return The style setting. + */ public StyleSetting getSetting(String name) { for (int i = 0; i < settings.size (); i++) { if (settings.get(i).getName().equals(name)) { @@ -59,10 +77,22 @@ return null; } + + /** + * Getter for number of settings. + * @return The size of the settings list. + */ public int getNumSettings () { return settings.size(); } + + /** + * Getter for style setting. + * @param i The index in the settings list. + * + * @return The style setting at the given index. + */ public StyleSetting getSetting(int i) { return this.settings.get(i); }