Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> eireneh >> config >> [ choices overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.eireneh.config.choices
Class AbstractChoice  

java.lang.Object
  com.eireneh.config.choices.AbstractChoice

All Implemented Interfaces:

com.eireneh.config.Choice, java.io.Serializable

Direct Known Subclasses:

ActionChoice, BooleanChoice, ClassChoices.Current, HashtableChoice, IntegerChoice, ObjectChoice, OptionsChoice, StringArrayChoice, TextViewChoice

---

public abstract class AbstractChoice

extends java.lang.Object

implements com.eireneh.config.Choice

An AbstractChoice is one that registers itself with AbstractChoice when it starts up, so that we don't need to pass parameters around the place the whole time.

Distribution Licence: Project B is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. The License is available on the internet here, by writing to Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA, Or locally at the Licence link below. The copyright to this program is held by it's authors.

---

Field Summary

 

Fields inherited from interface com.eireneh.config.Choice

PRIORITY_ACCESSOR, PRIORITY_CTOR, PRIORITY_EXTENDER, PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_NORMAL, PRIORITY_SYSTEM

 

Constructor Summary

AbstractChoice()

 

Method Summary
java.lang.String	getHelpText()           Get some help on this Field.
java.lang.String	getType()           This method is used to configure a good way of editing this component.
java.lang.Object	getTypeOptions()           This method is used to configure a the type selected above.
int	getUserLevel()           Gets a default user level (beginner to advanced)
boolean	isSaveable()           Is this Choice OK to write out to a file, or should we use settings in this run of the program, but forget them for next time.
int	priority()           Sometimes we need to ensure that we configure items in a certain order, the config package moves the changes to the application starting with the highest priority, moving to the lowest
boolean	requiresRestart()           Do we need to restart the program in order for this change to have effect?

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface com.eireneh.config.Choice

getString, setString

 

Constructor Detail

AbstractChoice

public AbstractChoice()

Method Detail

getUserLevel

public int getUserLevel()

Gets a default user level (beginner to advanced)

Specified by:

getUserLevel in interface com.eireneh.config.Choice

---

getHelpText

public java.lang.String getHelpText()

Get some help on this Field. In this case we are just providing a default help text, that isn't much use.

Specified by:

getHelpText in interface com.eireneh.config.Choice

---

getType

public java.lang.String getType()

This method is used to configure a good way of editing this component. It returns a MIME style string, which a config ui can use to select a suitable ui tool.

Specified by:

getType in interface com.eireneh.config.Choice

---

getTypeOptions

public java.lang.Object getTypeOptions()

This method is used to configure a the type selected above. The object returned will depend on the type of editor selected. For example an editor of type "options" may need a String array.

Specified by:

getTypeOptions in interface com.eireneh.config.Choice

---

isSaveable

public boolean isSaveable()

Is this Choice OK to write out to a file, or should we use settings in this run of the program, but forget them for next time. A typical use of this is for password configuration.

Specified by:

isSaveable in interface com.eireneh.config.Choice

---

priority

public int priority()

Sometimes we need to ensure that we configure items in a certain order, the config package moves the changes to the application starting with the highest priority, moving to the lowest

Specified by:

priority in interface com.eireneh.config.Choice

---

requiresRestart

public boolean requiresRestart()

Do we need to restart the program in order for this change to have effect?

Specified by:

requiresRestart in interface com.eireneh.config.Choice

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> eireneh >> config >> [ choices overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---