jaxx.runtime.swing.config

Class ConfigUIHelper

java.lang.Object

jaxx.runtime.swing.config.ConfigUIHelper

public class ConfigUIHelper
extends Object

A helper to build a config ui.

contains all states as method to build model, then ui and finally display it.

Since:

2.5.11

Author:

tchemit

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log
protected ConfigUIModel	model internal model after builder flush
protected ConfigUIModelBuilder	modelBuilder internal model builder
protected ConfigUI	ui

Constructor Summary

Constructors

Constructor and Description
ConfigUIHelper(org.nuiton.util.config.ApplicationConfig config)
ConfigUIHelper(org.nuiton.util.config.ApplicationConfig config, File configFile)
ConfigUIHelper(com.google.common.base.Supplier<org.nuiton.util.config.ApplicationConfig> config)
ConfigUIHelper(com.google.common.base.Supplier<org.nuiton.util.config.ApplicationConfig> config, File configFile)

Method Summary

Methods

Modifier and Type	Method and Description
ConfigUIModelBuilder	addCategory(String categoryName, String categoryLabel)
ConfigUIModelBuilder	addCategory(String categoryName, String categoryLabel, String categoryCallback)
ConfigUIModelBuilder	addOption(org.nuiton.util.config.ConfigOptionDef def)
ConfigUIModelBuilder	addOption(org.nuiton.util.config.ConfigOptionDef def, String propertyName)
ConfigUI	buildUI(JAXXContext parentContext, String defaultCategory) Construire l'ui de configuration (sous forme de panel)
void	displayUI(Frame parentUI, boolean undecorated)
ConfigUIModel	getModel()
ConfigUIModelBuilder	registerCallBack(String name, String description, Icon icon, Runnable action)
ConfigUIModelBuilder	setCategory(CategoryModel categoryModel)
ConfigUIModelBuilder	setCloseAction(Runnable runnable)
ConfigUIModelBuilder	setFinalizer(CallBackFinalizer finalizer)
ConfigUIModelBuilder	setModel(ConfigUIModel model)
ConfigUIModelBuilder	setOption(OptionModel optionModel)
ConfigUIModelBuilder	setOptionCallBack(String name)
ConfigUIModelBuilder	setOptionEditor(TableCellEditor editor)
ConfigUIModelBuilder	setOptionPropertyName(String propertyName)
ConfigUIModelBuilder	setOptionRenderer(TableCellRenderer renderer)

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.commons.logging.Log log

modelBuilder

protected final ConfigUIModelBuilder modelBuilder

internal model builder

model

protected ConfigUIModel model

internal model after builder flush

ui

protected ConfigUI ui

Constructor Detail

ConfigUIHelper

public ConfigUIHelper(com.google.common.base.Supplier<org.nuiton.util.config.ApplicationConfig> config)

ConfigUIHelper

public ConfigUIHelper(com.google.common.base.Supplier<org.nuiton.util.config.ApplicationConfig> config,
              File configFile)

ConfigUIHelper

public ConfigUIHelper(org.nuiton.util.config.ApplicationConfig config,
              File configFile)

ConfigUIHelper

public ConfigUIHelper(org.nuiton.util.config.ApplicationConfig config)

Method Detail

getModel

public ConfigUIModel getModel()

addCategory

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

Throws:

IllegalStateException

NullPointerException

addCategory

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

Throws:

IllegalStateException

NullPointerException

addOption

public ConfigUIModelBuilder addOption(org.nuiton.util.config.ConfigOptionDef def)
                               throws IllegalStateException,
                                      NullPointerException

Throws:

IllegalStateException

NullPointerException

addOption

public ConfigUIModelBuilder addOption(org.nuiton.util.config.ConfigOptionDef def,
                             String propertyName)
                               throws IllegalStateException,
                                      NullPointerException

Throws:

IllegalStateException

NullPointerException

setOptionPropertyName

public ConfigUIModelBuilder setOptionPropertyName(String propertyName)
                                           throws IllegalStateException,
                                                  NullPointerException

Throws:

IllegalStateException

NullPointerException

setOptionEditor

public ConfigUIModelBuilder setOptionEditor(TableCellEditor editor)
                                     throws IllegalStateException,
                                            NullPointerException

Throws:

IllegalStateException

NullPointerException

setOptionRenderer

public ConfigUIModelBuilder setOptionRenderer(TableCellRenderer renderer)
                                       throws IllegalStateException,
                                              NullPointerException

Throws:

IllegalStateException

NullPointerException

registerCallBack

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

setOptionCallBack

public ConfigUIModelBuilder setOptionCallBack(String name)

setModel

public ConfigUIModelBuilder setModel(ConfigUIModel model)
                              throws IllegalStateException

Throws:

IllegalStateException

setCategory

public ConfigUIModelBuilder setCategory(CategoryModel categoryModel)
                                 throws IllegalStateException

Throws:

IllegalStateException

setOption

public ConfigUIModelBuilder setOption(OptionModel optionModel)
                               throws IllegalStateException

Throws:

IllegalStateException

setFinalizer

public ConfigUIModelBuilder setFinalizer(CallBackFinalizer finalizer)

setCloseAction

public ConfigUIModelBuilder setCloseAction(Runnable runnable)

buildUI

public ConfigUI buildUI(JAXXContext parentContext,
               String defaultCategory)

Construire l'ui de configuration (sous forme de panel)

Parameters:

parentContext - le context applicatif

defaultCategory - la categorie a selectionner

Returns:

l'ui instanciate

displayUI

public void displayUI(Frame parentUI,
             boolean undecorated)