Package ch.tocco.nice2.netui.impl.actions

Class ActionGroupModelImpl

java.lang.Object

ch.tocco.nice2.netui.impl.actions.ActionModelImpl

ch.tocco.nice2.netui.impl.actions.ActionGroupModelImpl

All Implemented Interfaces:

ActionGroupModel, ActionModel, Serializable, Iterable<ActionModel>

public class ActionGroupModelImpl
extends ActionModelImpl
implements ActionGroupModel

An action group model specifies all properties for an action group.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface ch.tocco.nice2.netui.api.actions.ActionGroupModel

NO_DEFAULT_ACTION, UNSPECIFIED_DEFAULT_ACTION

Constructor Summary

Constructors

Constructor	Description
ActionGroupModelImpl(ActionGroupModelImpl g)
ActionGroupModelImpl(String id, String name, @Nullable ActionModel... actions)
ActionGroupModelImpl(String id, String name, @Nullable Collection<ActionModel> actions)

Method Summary

Modifier and Type	Method	Description
List<ActionModel>	actionList()	Returns the child actions of this group as an unmodifiable list.
void	addAction(ActionModel action)	Adds the specified action unmodified to this action array.
List<ActionModel>	collectActionModels()
ActionGroupModelImpl	deepCopy()	Creates a deep copy of this group.
boolean	equals(Object o)
ActionModel	findActionModel(String propertyName, String propertyValue)
Iterable<ActionModel>	findActionModels(String propertyName, String propertyValue)
ActionModel	findById(String actionId)	Finds an Action within the action tree of this group using the specified action-id.
void	findDefaultAction()	If this group has no default action set, it finds the first enabled action in this group and sets it as the default action.
ActionModel[]	getActions()
int	getDefaultAction()
int	hashCode()
boolean	isEmpty()	Returns whether this group has any actions.
boolean	isGroup()
boolean	isMutualExclusive()
ActionModelIterator	iterator()	Iterator for looping through all child actions in preorder.
void	mergeGroup(ActionGroupModel group)	Merges the actions from the specified group into this group.
void	preserveOrder(boolean overwrite)	Adds position objects to the child actions that reflect their current order.
boolean	removeAction(ActionModel action)	Removes the specified action from this group.
void	removeActions(Predicate<ActionModel> predicate)	Removes all actions which match the given predicate.
void	removeEmptyGroups()	Recursively removes all empty action groups from this group.
void	removeEntry(int index)	Removes the action at the specified index.
void	replaceAction(ActionModel modelToReplace, ActionModel newActionModel)
protected void	setActions(@Nullable Collection<ActionModel> actions)
void	setDefaultAction(int defaultAction)
void	setMutualExclusive(boolean mutualExclusive)
void	sort()	Recursively sorts this groups children with respect to its ActionModel.getPosition() property.
String	toString()

Methods inherited from class ch.tocco.nice2.netui.impl.actions.ActionModelImpl

getIcon, getId, getName, getPosition, getProperties, getProperty, getRelativePosition, getRelativePositionProperty, getShortDescription, isEnabled, isToggle, setEnabled, setIcon, setName, setPosition, setProperties, setProperty, setRelativePosition, setShortDescription, setToggle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.tocco.nice2.netui.api.actions.ActionModel

getIcon, getId, getName, getPosition, getProperty, getRelativePosition, getRelativePositionProperty, getShortDescription, isEnabled, isToggle, setEnabled, setIcon, setName, setPosition, setProperty, setRelativePosition, setShortDescription, setToggle

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ActionGroupModelImpl

public ActionGroupModelImpl(String id,
 String name,
 @Nullable
 @Nullable ActionModel... actions)

ActionGroupModelImpl

public ActionGroupModelImpl(String id,
 String name,
 @Nullable
 @Nullable Collection<ActionModel> actions)

ActionGroupModelImpl

public ActionGroupModelImpl(ActionGroupModelImpl g)

Method Details

getDefaultAction

public int getDefaultAction()

Specified by:

getDefaultAction in interface ActionGroupModel

setDefaultAction

public void setDefaultAction(int defaultAction)

Specified by:

setDefaultAction in interface ActionGroupModel

isMutualExclusive

public boolean isMutualExclusive()

Specified by:

isMutualExclusive in interface ActionGroupModel

setMutualExclusive

public void setMutualExclusive(boolean mutualExclusive)

Specified by:

setMutualExclusive in interface ActionGroupModel

isGroup

public boolean isGroup()

Overrides:

isGroup in class ActionModelImpl

findById

public ActionModel findById(String actionId)

Finds an Action within the action tree of this group using the specified action-id.

Specified by:

findById in interface ActionGroupModel

getActions

public ActionModel[] getActions()

setActions

protected void setActions(@Nullable
 @Nullable Collection<ActionModel> actions)

iterator

public ActionModelIterator iterator()

Iterator for looping through all child actions in preorder.

Note that this action group is not visited, only its children.

Specified by:

iterator in interface Iterable<ActionModel>

removeEntry

public void removeEntry(int index)

Removes the action at the specified index.

If you are iterating through an action group, please consider the remove() method if the iterator!

removeAction

public boolean removeAction(ActionModel action)

Description copied from interface: ActionGroupModel

Removes the specified action from this group.

Only remove from root action array. This method does not iterate recursively through all actions.

Specified by:

removeAction in interface ActionGroupModel

Parameters:

action - action in this action array to remove

removeActions

public void removeActions(Predicate<ActionModel> predicate)

Description copied from interface: ActionGroupModel

Removes all actions which match the given predicate. Not only root actions are removed; this method iterates recursively through all actions.

Specified by:

removeActions in interface ActionGroupModel

Parameters:

predicate - the predicate to apply.

replaceAction

public void replaceAction(ActionModel modelToReplace,
 ActionModel newActionModel)

Specified by:

replaceAction in interface ActionGroupModel

addAction

public void addAction(ActionModel action)

Description copied from interface: ActionGroupModel

Adds the specified action unmodified to this action array.

Specified by:

addAction in interface ActionGroupModel

actionList

public List<ActionModel> actionList()

Returns the child actions of this group as an unmodifiable list.

Specified by:

actionList in interface ActionGroupModel

Returns:

child actions of this group

findDefaultAction

public void findDefaultAction()

Description copied from interface: ActionGroupModel

If this group has no default action set, it finds the first enabled action in this group and sets it as the default action. Does this recursively for any other action group encountered.

Specified by:

findDefaultAction in interface ActionGroupModel

deepCopy

public ActionGroupModelImpl deepCopy()

Description copied from interface: ActionGroupModel

Creates a deep copy of this group.

Specified by:

deepCopy in interface ActionGroupModel

Specified by:

deepCopy in interface ActionModel

Overrides:

deepCopy in class ActionModelImpl

Returns:

a new this

isEmpty

public boolean isEmpty()

Description copied from interface: ActionGroupModel

Returns whether this group has any actions.

Specified by:

isEmpty in interface ActionGroupModel

Returns:

true if there is at least one action in this group, false if there are none

mergeGroup

public void mergeGroup(ActionGroupModel group)
                throws IllegalStateException

Description copied from interface: ActionGroupModel

Merges the actions from the specified group into this group.

The properties of the given group itself are discarded. Only their containing actions are added to the actions of this group. If the given action contains a group that is already defined in here, their actions will be added to the existing group, such that no doublet groups arise.

Specified by:

mergeGroup in interface ActionGroupModel

Throws:

IllegalStateException

sort

public void sort()

Description copied from interface: ActionGroupModel

Recursively sorts this groups children with respect to its ActionModel.getPosition() property.

Specified by:

sort in interface ActionGroupModel

findActionModel

public ActionModel findActionModel(String propertyName,
 String propertyValue)

Specified by:

findActionModel in interface ActionGroupModel

findActionModels

public Iterable<ActionModel> findActionModels(String propertyName,
 String propertyValue)

Specified by:

findActionModels in interface ActionGroupModel

Parameters:

propertyName - name of a property

propertyValue - value for property

Returns:

all action models contained in this model with the specified property

collectActionModels

public List<ActionModel> collectActionModels()

Specified by:

collectActionModels in interface ActionGroupModel

Returns:

all action models contained in this model

removeEmptyGroups

public void removeEmptyGroups()

Description copied from interface: ActionGroupModel

Recursively removes all empty action groups from this group.

Specified by:

removeEmptyGroups in interface ActionGroupModel

preserveOrder

public void preserveOrder(boolean overwrite)

Description copied from interface: ActionGroupModel

Adds position objects to the child actions that reflect their current order. This method does not step into any child group.

Specified by:

preserveOrder in interface ActionGroupModel

Parameters:

overwrite - if true overwrite existing position entries

equals

public boolean equals(Object o)

Overrides:

equals in class ActionModelImpl

hashCode

public int hashCode()

Overrides:

hashCode in class ActionModelImpl

toString

public String toString()

Overrides:

toString in class ActionModelImpl