org.eclipse.gef4.zest.fx.models

Class HidingModel

java.lang.Object

org.eclipse.gef4.zest.fx.models.HidingModel

All Implemented Interfaces:

IPropertyChangeNotifier

public class HidingModel
extends java.lang.Object
implements IPropertyChangeNotifier

The HidingModel manages a Set of currently hidden Nodes. It does also provide a method to retrieve the hidden neighbors of a Node.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HIDDEN_PROPERTY Property name that is used when firing property change notifications when the Set of hidden Nodes changes.

Constructor Summary

Constructors

Constructor and Description
HidingModel()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
java.util.Set<Node>	getHiddenNeighbors(Node node) Returns a Set containing all hidden neighbors of the given Node.
java.util.Set<Node>	getHiddenNodes() Returns a copy of the Set that contains all hidden Nodes.
void	hide(Node node) Adds the given Node to the Set of hidden Nodes.
boolean	isHidden(Node node) Returns true if the given Node is currently contained within the Set of hidden Nodes.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	show(Node node) Remove the given Node from the Set of hidden Node s.

Methods inherited from class java.lang.Object

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

Field Detail

HIDDEN_PROPERTY

public static final java.lang.String HIDDEN_PROPERTY

Property name that is used when firing property change notifications when the Set of hidden Nodes changes.

See Also:

Constant Field Values

Constructor Detail

HidingModel

public HidingModel()

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface IPropertyChangeNotifier

getHiddenNeighbors

public java.util.Set<Node> getHiddenNeighbors(Node node)

Returns a Set containing all hidden neighbors of the given Node.

Parameters:

node - The Node of which the hidden neighbors are returned.

Returns:

A Set containing all hidden neighbors of the given Node.

getHiddenNodes

public java.util.Set<Node> getHiddenNodes()

Returns a copy of the Set that contains all hidden Nodes.

Returns:

A copy of the Set that contains all hidden Nodes.

hide

public void hide(Node node)

Adds the given Node to the Set of hidden Nodes. Notifies all property change listeners about this change.

Parameters:

node - The Node that is added to the Set of hidden Nodes.

isHidden

public boolean isHidden(Node node)

Returns true if the given Node is currently contained within the Set of hidden Nodes. Otherwise, returns false.

Parameters:

node - The Node in question.

Returns:

true if the given Node is currently contained within the Set of hidden Nodes, otherwise false.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface IPropertyChangeNotifier

show

public void show(Node node)

Remove the given Node from the Set of hidden Node s. Notifies all property change listeners about this change.

Parameters:

node - The Node that is removed from the Set of hidden Nodes.