/*
* org.openmicroscopy.shoola.agents.metadata.browser.TreeBrowserSet
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2008 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.agents.metadata.browser;
//Java imports
import javax.swing.Icon;
//Third-party libraries
//Application-internal dependencies
/**
*
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Donald MacDonald
* <a href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
* @version 3.0
* <small>
* (<b>Internal version:</b> $Revision: $Date: $)
* </small>
* @since OME3.0
*/
public class TreeBrowserSet
extends TreeBrowserDisplay
{
/** Flag to indicate if the children were loaded for that node. */
private Boolean childrenLoaded;
/**
* Implemented as specified by superclass.
* @see TreeBrowserDisplay#doAccept(TreeBrowserVisitor)
*/
protected void doAccept(TreeBrowserVisitor visitor)
{
visitor.visit(this);
}
/**
* Creates a new container node.
*
* @param hierarchyObject The original object in the image hierarchy which
* is visualized by this node. It has to be an image
* object in this case. Never pass <code>null</code>.
*/
public TreeBrowserSet(Object hierarchyObject)
{
super(hierarchyObject);
}
/**
* Creates a new container node.
*
* @param hierarchyObject The original object in the image hierarchy which
* is visualized by this node. It has to be an
* image object in this case.
* Never pass <code>null</code>.
* @param defaultIcon The default icon associated to this node.
* @param menuNode Pass <code>true</code> to indicate that the node
* is a menu node, <code>false</code> otherwise.
*/
public TreeBrowserSet(Object hierarchyObject, Icon defaultIcon, boolean
menuNode)
{
super(hierarchyObject, defaultIcon, menuNode);
}
/**
* Tells if the children of this node have been loaded.
* The node may not contain children but the children were requested.
* Note that this method will return <code>false</code> if the value of the
* {@link #childrenLoaded} is <code>null</code>.
* @see TreeBrowserDisplay#isChildrenLoaded()
*/
public boolean isChildrenLoaded()
{
if (childrenLoaded == null) return false;
return childrenLoaded.booleanValue();
}
/**
* Indicates if the children were requested for this node.
* @see TreeBrowserDisplay#setChildrenLoaded(Boolean)
*/
public void setChildrenLoaded(Boolean childrenLoaded)
{
this.childrenLoaded = childrenLoaded;
}
}