| java.lang.Object
 com.flexive.shared.structure.FxStructureOption
| FxStructureOption | | public class FxStructureOption implements Serializable(Code) | | Option for structure elements (groups, properties, assignments)
author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
| Method Summary | |
| public static void | clearOption(List<FxStructureOption> options, String key)
| | public static List<FxStructureOption> | cloneOptions(List<FxStructureOption> options)
| | public boolean | equals(Object o)
| | public static List<FxStructureOption> | getEmptyOptionList(int capacity)
| | public String | getKey()
| | public static FxStructureOption | getOption(String key, List<FxStructureOption> options)
Get an option entry for the given key, if the key is invalid or not found a FxStructureOption object
will be returned with set set to false, overrideable set to false and value
set to an empty String. | | public static List<FxStructureOption> | getUnmodifieableOptions(List<FxStructureOption> options)
| | public String | getValue()
| | public static boolean | hasOption(String key, List<FxStructureOption> options)
| | public int | hashCode()
| | public boolean | isOverrideable()
| | public boolean | isSet()
| | public boolean | isValueTrue()
| | public static void | setOption(List<FxStructureOption> options, String key, boolean overrideable, String value)
| | public static void | setOption(List<FxStructureOption> options, String key, boolean overrideable, boolean value)
|
| OPTION_HTML_EDITOR | | final public static String OPTION_HTML_EDITOR(Code) | | |
| OPTION_MULTILANG | | final public static String OPTION_MULTILANG(Code) | | |
| OPTION_MULTILINE | | final public static String OPTION_MULTILINE(Code) | | |
| OPTION_SEARCHABLE | | final public static String OPTION_SEARCHABLE(Code) | | |
| OPTION_SHOW_OVERVIEW | | final public static String OPTION_SHOW_OVERVIEW(Code) | | |
| overrideable | | protected boolean overrideable(Code) | | |
| FxStructureOption | | public FxStructureOption(String key, boolean overrideable, boolean set, String value)(Code) | | Ctor
Parameters:
key - key identifying the option
Parameters:
overrideable - is the option overridable in assignments
Parameters:
set - is the option set? (non-existing options are returned as not-set options!)
Parameters:
value - the options value |
| FxStructureOption | | public FxStructureOption(FxStructureOption o)(Code) | | Copy Constructor
Parameters:
o - an FxStructureOption |
| clearOption | | public static void clearOption(List<FxStructureOption> options, String key)(Code) | | Clear the option with the given key - removing it from the list if it exists
Parameters:
options - list options to clear the option for
Parameters:
key - key of the option to remove |
| equals | | public boolean equals(Object o)(Code) | | Checks for equality
if the option's values equal this |
| getEmptyOptionList | | public static List<FxStructureOption> getEmptyOptionList(int capacity)(Code) | | Get a list of empty options
Parameters:
capacity - desired capacity list of empty options |
| getKey | | public String getKey()(Code) | | Get the option key
option key |
| getOption | | public static FxStructureOption getOption(String key, List<FxStructureOption> options)(Code) | | Get an option entry for the given key, if the key is invalid or not found a FxStructureOption object
will be returned with set set to false, overrideable set to false and value
set to an empty String.
Parameters:
key - option key
Parameters:
options - the available options the found option or an object that indicates that the option is not set |
| getUnmodifieableOptions | | public static List<FxStructureOption> getUnmodifieableOptions(List<FxStructureOption> options)(Code) | | Convert a list of options to an unmodifieable list
Parameters:
options - list to convert unmodifieable list of options |
| getValue | | public String getValue()(Code) | | Get the value assigned to the option
value assigned to the option |
| hasOption | | public static boolean hasOption(String key, List<FxStructureOption> options)(Code) | | Check if an option is set for the requested key
Parameters:
key - option key
Parameters:
options - the available options if an option is set for the requested key |
| hashCode | | public int hashCode()(Code) | | |
| isOverrideable | | public boolean isOverrideable()(Code) | | Is the option overrideable (in assignments)?
option overrideable (in assignments)? |
| isSet | | public boolean isSet()(Code) | | Is the option set, will return false if an unknown option is requested
if option is set, will return false if an unknown option is requested |
| isValueTrue | | public boolean isValueTrue()(Code) | | Convenience method to check if value is set to true
if value is set to true |
| setOption | | public static void setOption(List<FxStructureOption> options, String key, boolean overrideable, String value)(Code) | | Set or add a String value in a list of options
Parameters:
options - list of existing options
Parameters:
key - option key
Parameters:
overrideable - should the option be overrideable?
Parameters:
value - String value to set for the option |
| setOption | | public static void setOption(List<FxStructureOption> options, String key, boolean overrideable, boolean value)(Code) | | Set or add a boolean value in a list of options
Parameters:
options - list of existing options
Parameters:
key - option key
Parameters:
overrideable - should the option be overrideable?
Parameters:
value - boolean value to set for the option (will be converted internally to a String) |
|
|