Package org.nuiton.jaxx.widgets.config.model

Class ConfigUIModelBuilder

java.lang.Object

org.nuiton.jaxx.widgets.config.model.ConfigUIModelBuilder

public class ConfigUIModelBuilder
extends Object

A builder of ConfigUIModel Created: 22 déc. 2009

Since:

2.5.11

Author:

Tony Chemit - dev@tchemit.fr

Constructor Summary

Constructors

Constructor	Description
ConfigUIModelBuilder()

Method Summary

Modifier and Type	Method	Description
ConfigUIModelBuilder	addCategory(String categoryName, String categoryLabel)	Add a new category, and set it as current.
ConfigUIModelBuilder	addCategory(String categoryName, String categoryLabel, String defaultCallback)	Add a new category, and set it as current.
ConfigUIModelBuilder	addOption(io.ultreia.java4all.config.ConfigOptionDef def)	Add a new option, and set it as current.
ConfigUIModelBuilder	addOption(io.ultreia.java4all.config.ConfigOptionDef def, String propertyName)	Deprecated. since 2.5.29, prefer use the setOptionPropertyName(String) method instead, will be removed soon
protected void	checkCurrent(Object o, String type)
protected void	checkNoCurrent(Object o, String type)
protected void	checkNotNull(Object o, String method, String parameter)
ConfigUIModelBuilder	createModel(com.google.common.base.Supplier<io.ultreia.java4all.config.ApplicationConfig> config)	Deprecated. since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon
ConfigUIModelBuilder	createModel(com.google.common.base.Supplier<io.ultreia.java4all.config.ApplicationConfig> config, File configFile)	Deprecated. since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon
ConfigUIModelBuilder	createModel(io.ultreia.java4all.config.ApplicationConfig config)	Deprecated. since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon
ConfigUIModelBuilder	createModel(io.ultreia.java4all.config.ApplicationConfig config, File configFile)	Deprecated. since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon
ConfigUIModelBuilder	createModel(Object configurationBean, io.ultreia.java4all.config.ApplicationConfig config)	Deprecated. since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon
ConfigUIModelBuilder	createModel(Object configurationBean, io.ultreia.java4all.config.ApplicationConfig config, File configFile)	Create a new model and set it as current model.
protected CategoryModel	flushCategory()
ConfigUIModel	flushModel()	Flush the model and return it.
protected OptionModel	flushOption()
ConfigUIModelBuilder	registerCallBack(String name, String description, Icon icon, Runnable action)	Registers a new callback.
ConfigUIModelBuilder	setCategory(CategoryModel categoryModel)	Set the given category as current category.
ConfigUIModelBuilder	setCategoryDefaultCallBack(String categoryDefaultCallBack)	Sets the default callback to use for this category (the call back will be add to all options of this category until you set another one or nullify it).
ConfigUIModelBuilder	setCloseAction(Runnable runnable)
ConfigUIModelBuilder	setFinalizer(CallBackFinalizer finalizer)	Sets the callback finalizet
ConfigUIModelBuilder	setModel(ConfigUIModel model)	Set the given model as current model.
ConfigUIModelBuilder	setOption(OptionModel optionModel)	Sets the given option as current option.
ConfigUIModelBuilder	setOptionCallBack(String name)	Registers the current option into a known callback.
ConfigUIModelBuilder	setOptionEditor(TableCellEditor editor)	Set the editor on the current option.
ConfigUIModelBuilder	setOptionPropertyName(String propertyName)	Set the propertyName on the current option.
ConfigUIModelBuilder	setOptionRenderer(TableCellRenderer renderer)	Set the renderer on the current option.
ConfigUIModelBuilder	setOptionShortLabel(String shortLabel)	Set the short label on the current option.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigUIModelBuilder

public ConfigUIModelBuilder()

Method Detail

createModel

public ConfigUIModelBuilder createModel(Object configurationBean,
                                        io.ultreia.java4all.config.ApplicationConfig config,
                                        File configFile)
                                 throws IllegalStateException,
                                        NullPointerException

Create a new model and set it as current model.

Parameters:

configurationBean - configuration bean used in model (optional)

config - the configuration used in model (can not be null)

configFile - configuration file where to save (can not be null)

Returns:

the builder

Throws:

IllegalStateException - if there is already a current model

NullPointerException - if config or configFile is null

Since:

2.33

createModel

@Deprecated
public ConfigUIModelBuilder createModel(com.google.common.base.Supplier<io.ultreia.java4all.config.ApplicationConfig> config)
                                 throws IllegalStateException,
                                        NullPointerException

Deprecated.

since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon

Create a new model and set it as current model.

Parameters:

config - the configuration used in model

Returns:

the builder

Throws:

IllegalStateException - if there is already a current model

NullPointerException - if config is null

createModel

@Deprecated
public ConfigUIModelBuilder createModel(com.google.common.base.Supplier<io.ultreia.java4all.config.ApplicationConfig> config,
                                        File configFile)
                                 throws IllegalStateException,
                                        NullPointerException

Deprecated.

since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon

Create a new model and set it as current model.

Parameters:

config - the configuration used in model

configFile - configuration file where to save (can not be null)

Returns:

the builder

Throws:

IllegalStateException - if there is already a current model

NullPointerException - if config or configFile is null

Since:

2.5.21

createModel

@Deprecated
public ConfigUIModelBuilder createModel(Object configurationBean,
                                        io.ultreia.java4all.config.ApplicationConfig config)
                                 throws IllegalStateException,
                                        NullPointerException

Deprecated.

since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon

Create a new model and set it as current model.

Parameters:

configurationBean - configuration bean used in model

config - the configuration used in model

Returns:

the builder

Throws:

IllegalStateException - if there is already a current model

NullPointerException - if there is some null parameters

createModel

@Deprecated
public ConfigUIModelBuilder createModel(io.ultreia.java4all.config.ApplicationConfig config)
                                 throws IllegalStateException,
                                        NullPointerException

Deprecated.

since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon

Create a new model and set it as current model.

Parameters:

config - the configuration used in model

Returns:

the builder

Throws:

IllegalStateException - if there is already a current model

NullPointerException - if config is null

createModel

@Deprecated
public ConfigUIModelBuilder createModel(io.ultreia.java4all.config.ApplicationConfig config,
                                        File configFile)
                                 throws IllegalStateException,
                                        NullPointerException

Deprecated.

since 2.33, prefer use the createModel(Object, ApplicationConfig, File) method instead, will be removed soon

Create a new model and set it as current model.

Parameters:

config - the configuration used in model

configFile - configuration file where to save (can not be null)

Returns:

the builder

Throws:

IllegalStateException - if there is already a current model

NullPointerException - if config or configFile is null

Since:

2.5.21

addCategory

public ConfigUIModelBuilder addCategory(String categoryName,
                                        String categoryLabel)
                                 throws IllegalStateException,
                                        NullPointerException

Add a new category, and set it as current. Note: As side effets, if a previous category, then store it to the model.

Parameters:

categoryName - the name of the new category (can not to be null)

categoryLabel - the label of the new category (can not to be null)

Returns:

the builder

Throws:

IllegalStateException - if there is not a current model, nor category

NullPointerException - if any of parameter is null

addCategory

public ConfigUIModelBuilder addCategory(String categoryName,
                                        String categoryLabel,
                                        String defaultCallback)
                                 throws IllegalStateException,
                                        NullPointerException

Add a new category, and set it as current. Note: As side effets, if a previous category, then store it to the model.

Parameters:

categoryName - the name of the new category (can not to be null)

categoryLabel - the label of the new category (can not to be null)

Returns:

the builder

Throws:

IllegalStateException - if there is not a current model, nor category

NullPointerException - if any of parameter is null

addOption

public ConfigUIModelBuilder addOption(io.ultreia.java4all.config.ConfigOptionDef def)
                               throws IllegalStateException,
                                      NullPointerException

Add a new option, and set it as current. Note: As side effets, if a previous option, then store it to the model.

Parameters:

def - the def ot the new option

Returns:

the builder

Throws:

IllegalStateException - if there is not a current model, nor category

NullPointerException - if any of parameter is null

addOption

@Deprecated
public ConfigUIModelBuilder addOption(io.ultreia.java4all.config.ConfigOptionDef def,
                                      String propertyName)
                               throws IllegalStateException,
                                      NullPointerException

Deprecated.

since 2.5.29, prefer use the setOptionPropertyName(String) method instead, will be removed soon

Add a new option with a propertyName, and set it as current. Note: As side effets, if a previous option, then store it to the model. Note: This method is a short-cut for addOption(ConfigOptionDef) then setOptionPropertyName(String).

Parameters:

def - the def ot the new option

propertyName - the propertyName to set on the option

Returns:

the builder

Throws:

IllegalStateException - if there is not a current model, nor category

NullPointerException - if any of parameter is null

setOptionPropertyName

public ConfigUIModelBuilder setOptionPropertyName(String propertyName)
                                           throws IllegalStateException,
                                                  NullPointerException

Set the propertyName on the current option.

Parameters:

propertyName - the propertyName to set in the current option.

Returns:

the builder

Throws:

IllegalStateException - if there is not a current option set.

NullPointerException - if any of parameter is null

See Also:

OptionModel.setPropertyName(String)

setOptionShortLabel

public ConfigUIModelBuilder setOptionShortLabel(String shortLabel)
                                         throws IllegalStateException,
                                                NullPointerException

Set the short label on the current option.

Parameters:

shortLabel - the propertyName to set in the current option.

Returns:

the builder

Throws:

IllegalStateException - if there is not a current option set.

NullPointerException - if any of parameter is null

Since:

2.5.29

See Also:

OptionModel.setShortLabel(String)

setOptionEditor

public ConfigUIModelBuilder setOptionEditor(TableCellEditor editor)
                                     throws IllegalStateException,
                                            NullPointerException

Set the editor on the current option.

Parameters:

editor - the editor to set in the current option.

Returns:

the builder

Throws:

IllegalStateException - if there is not a current option set.

NullPointerException - if any of parameter is null

See Also:

OptionModel.setEditor(TableCellEditor)

setOptionRenderer

public ConfigUIModelBuilder setOptionRenderer(TableCellRenderer renderer)
                                       throws IllegalStateException,
                                              NullPointerException

Set the renderer on the current option.

Parameters:

renderer - the renderer to set in the current option.

Returns:

the builder

Throws:

IllegalStateException - if there is not a current option set.

NullPointerException - if any of parameter is null

See Also:

OptionModel.setRenderer(TableCellRenderer)

registerCallBack

public ConfigUIModelBuilder registerCallBack(String name,
                                             String description,
                                             Icon icon,
                                             Runnable action)

Registers a new callback. Note: the order of registred callback is used to determine the higher priority of callback to launch if required.

Parameters:

name - the unique name of a callback

description - the i18n key to describe the action

icon - the icon of the callBack (used in ui)

action - the action of the callback

Returns:

the builder

setOptionCallBack

public ConfigUIModelBuilder setOptionCallBack(String name)

Registers the current option into a known callback.

Parameters:

name - the name of the callback

Returns:

the builder

setFinalizer

public ConfigUIModelBuilder setFinalizer(CallBackFinalizer finalizer)

Sets the callback finalizet

Parameters:

finalizer - callback finalize

Returns:

the builder

See Also:

CallBackFinalizer

setCategoryDefaultCallBack

public ConfigUIModelBuilder setCategoryDefaultCallBack(String categoryDefaultCallBack)

Sets the default callback to use for this category (the call back will be add to all options of this category until you set another one or nullify it).

Parameters:

categoryDefaultCallBack - default callbakc name for the category

Returns:

the buider

flushModel

public ConfigUIModel flushModel()
                         throws IllegalStateException

Flush the model and return it. Note: As a side effect, nothing is available in the builder after this operation. To reuse the builder on a model, use the dedicated setter.

Returns:

the final model

Throws:

IllegalStateException - if there is not a current model set.

setModel

public ConfigUIModelBuilder setModel(ConfigUIModel model)
                              throws IllegalStateException

Set the given model as current model. Note: As side effets, il will clean current category and option.

Parameters:

model - the model to use

Returns:

the buider

Throws:

IllegalStateException - if there is already a current model

setCategory

public ConfigUIModelBuilder setCategory(CategoryModel categoryModel)
                                 throws IllegalStateException

Set the given category as current category. Note: As side effets, il will clean current option.

Parameters:

categoryModel - the category to use

Returns:

the buider

Throws:

IllegalStateException - if there is not a current model or a current category

setOption

public ConfigUIModelBuilder setOption(OptionModel optionModel)
                               throws IllegalStateException

Sets the given option as current option.

Parameters:

optionModel - the option to use

Returns:

the buider

Throws:

IllegalStateException - if there is not a current model, nor category, or a current option

setCloseAction

public ConfigUIModelBuilder setCloseAction(Runnable runnable)

flushCategory

protected CategoryModel flushCategory()

flushOption

protected OptionModel flushOption()

checkCurrent

protected void checkCurrent(Object o,
                            String type)

checkNoCurrent

protected void checkNoCurrent(Object o,
                              String type)

checkNotNull

protected void checkNotNull(Object o,
                            String method,
                            String parameter)