01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui;
11:
12: /**
13: * This adapter interface provides a way to test element containment
14: * in a model-independent way.
15: * The workbench uses this interface in certain views
16: * to test if a given resource is part of a working set.
17: *
18: * @since 2.1
19: */
20: public interface IContainmentAdapter {
21: /**
22: * Checks whether the given element corresponds to the containment context.
23: */
24: public static final int CHECK_CONTEXT = 1;
25:
26: /**
27: * Checks whether the given element corresponds to a direct child of the
28: * containment context. Does not include the containment context itself.
29: */
30: public static final int CHECK_IF_CHILD = 2;
31:
32: /**
33: * Checks whether the given element corresponds to an ancestor of the
34: * containment context. Does not include the containment context itself.
35: */
36: public static final int CHECK_IF_ANCESTOR = 4;
37:
38: /**
39: * Checks whether the given element corresponds to a descendant of the
40: * containment context. Does not include the containment context itself.
41: */
42: public static final int CHECK_IF_DESCENDANT = 8;
43:
44: /**
45: * Returns whether the given element is considered contained
46: * in the specified containment context or if it is the context
47: * itself.
48: *
49: * @param containmentContext object that provides containment
50: * context for the element. This is typically a container object
51: * (e.g., IFolder) and may be the element object itself.
52: * @param element object that should be tested for containment
53: * @param flags one or more of <code>CHECK_CONTEXT</code>,
54: * <code>CHECK_IF_CHILD</code>, <code>CHECK_IF_ANCESTOR</code>,
55: * <code>CHECK_IF_DESCENDENT</code> logically ORed together.
56: */
57: public boolean contains(Object containmentContext, Object element,
58: int flags);
59: }
|