/*
 * Copyright (c) 2006,2007 Declarative Engineering LLC.
 * All rights reserved.  This program and the accompanying materials
 * are made available under the terms of the Declarative Engineering LLC
 * verson 1 which accompanies this distribution, and is available at
 * http://declarativeengineering.com/legal/DE_Developer_License_v1.txt
 */
package com.foundation.tcv.swt.client;

import org.eclipse.swt.widgets.Composite;

import com.common.util.IIterator;
import com.foundation.tcv.swt.client.cell.CellComponent;
import com.foundation.view.resource.AbstractResourceService;

public interface ICellContainer {
/**
 * Gets the row object metadata for the given object identifier.
 * @param objectId The identifying number for the desired collection item's metadata.
 * @return The row object for the given identifer.
 */
public RowObject getRowObject(int objectId);
/**
 * Gets an iterator over all row objects.
 * @return The iterator containing all the row objects.
 */
public IIterator getRowObjects();
/**
 * Gets the container that defines the space occupied by the cells.
 * @return The container for the cells.
 */
public Container getContainer();
/**
 * Gets the composite that the cell should use as the parent SWT component.
 * @param rowObject The row object whose composite is required.  The composite may be the container for the cells, or a sub-container within the cell.
 * @return The SWT composite that contains all children.
 */
public Composite getSwtComposite(RowObject rowObject);
/**
 * Gets the composites that the cells use as the parent SWT component.
 * @return The iterator over all active SWT composites that contain all children.
 */
public IIterator getSwtComposites();
/**
 * Adds the cell component to the container.
 * @param component The component to be added.
 */
public void addCellComponent(CellComponent component);
/**
 * Gets the resource service.
 * @return The component's resource service.
 */
public AbstractResourceService getResourceService();
/**
 * Sets the layout for this container.
 * @param layout The container's layout.
 */
public void setLayout(Layout layout);
}//ICellContainer//