ilog.views.appframe.settings

Interface IlvMutableSettingsModel

All Superinterfaces:

IlvSettingsModel

public interface IlvMutableSettingsModel
extends IlvSettingsModel

Defines the requirements for a settings model that can change by adding or removing objects or by changing the attribute values of an element.

Method Summary

Modifier and Type	Method and Description
void	addSettingsElement(Object parent, Object object, int index) Adds the specified object to the model.
void	commit() Commits the current edited data contained by this model into their original source.
Object	createSettingsElement(String typeName) Creates a new object of the model with the specified type name.
boolean	removeSettingsElement(Object parent, Object object) Removes the specified settings element from the settings.
void	setAttributeValue(Object object, String attributeName, Object value) Sets an attribute value to the specified element.

Methods inherited from interface ilog.views.appframe.settings.IlvSettingsModel

getAttributes, getAttributeValue, getChildren, getParent, getType

Method Detail

setAttributeValue

void setAttributeValue(Object object,
                       String attributeName,
                       Object value)

Sets an attribute value to the specified element.

Parameters:

object - The object to change a value of.

attributeName - The name of the attribute to change.

value - The new value of the attribute.

addSettingsElement

void addSettingsElement(Object parent,
                        Object object,
                        int index)

Adds the specified object to the model.

Parameters:

parent - The object of this model that will be parent of the specified object. If null, the element is added as a root of the model.

object - The object to add.

index - The index at which the specified object must be inserted in the parent's child array. If index equals to -1, the object must be added at the last position.

See Also:

removeSettingsElement(java.lang.Object, java.lang.Object)

removeSettingsElement

boolean removeSettingsElement(Object parent,
                              Object object)

Removes the specified settings element from the settings.

Parameters:

parent - The parent element that owns the element to remove. If null, the object to remove was previously added as a root object of the model.

object - The object to remove from the model.

Returns:

true if the specified object could be removed; false otherwise.

See Also:

addSettingsElement(java.lang.Object, java.lang.Object, int)

createSettingsElement

Object createSettingsElement(String typeName)

Creates a new object of the model with the specified type name.

Parameters:

typeName - The name of the type of the object of the model to instantiate.

Returns:

The new created object of the model.

commit

void commit()

Commits the current edited data contained by this model into their original source.