com.quinsoft.zeidon.SelectSet Maven / Gradle / Ivy
/**
This file is part of the Zeidon Java Object Engine (Zeidon JOE).
Zeidon JOE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Zeidon JOE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Zeidon JOE. If not, see .
Copyright 2009-2015 QuinSoft
*/
package com.quinsoft.zeidon;
import java.util.Set;
/**
* An interface for keeping track of selected entities. This is largely just
* a Java Set. The main difference is that when an EI is
* added to the set with select(...) there is an option to also add all of
* its children.
*/
public interface SelectSet extends Set
{
/**
* Returns the View associated with this SelectSet
*
* @return view for the SelectSet
*/
View getView();
/**
* Returns true if the entity is selected in this set.
*
* @param ei
* @return
*/
boolean isSelected( EntityInstance ei );
/**
* Adds the entity to the select set.
*
* @param ei
*/
void select( EntityInstance ei );
/**
* Adds the entity to the select set and potentially all its children.
*
* @param ei
* @param selectChildren if true then also select the children.
*/
void select( EntityInstance ei, boolean selectChildren );
/**
* Removes the entity from the select set.
*
* @param ei
*/
void deselect( EntityInstance ei );
/**
* Removes the entity from the select set.
*
* @param ei
* @param removeChildren if true then remove all of the children of ei.
*/
void deselect( EntityInstance ei, boolean removeChildren );
/**
* Iterates over each of the entities in the set in hierarchical order.
*
* Note that for large OIs this may be slow because this will loop through
* all the entities looking for ones that are in the set. To loop through
* just the entities (without changing the underlying View) then use
* the standard Set iterator; however this is not guaranteed to loop in
* hierarchical order.
*/
EntityIterator extends EntityInstance> eachEntity();
/**
* If this SelectSet is named then this removes the name from the view's
* list. If it is not named then this does nothing.
*/
void drop();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy