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.views.framelist;
11:
12: /**
13: * A frame source is the source of frames which appear in a frame list.
14: * The frame list asks for the current frame whenever it switches
15: * to another frame, so that the context can be restored when the
16: * frame becomes current again.
17: *
18: * @see FrameList
19: */
20: public interface IFrameSource {
21:
22: /**
23: * Frame constant indicating the current frame.
24: */
25: public static final int CURRENT_FRAME = 0x0001;
26:
27: /**
28: * Frame constant indicating the frame for the selection.
29: */
30: public static final int SELECTION_FRAME = 0x0002;
31:
32: /**
33: * Frame constant indicating the parent frame.
34: */
35: public static final int PARENT_FRAME = 0x0003;
36:
37: /**
38: * Flag constant indicating that the full context should be captured.
39: */
40: public static final int FULL_CONTEXT = 0x0001;
41:
42: /**
43: * Returns a new frame describing the state of the source.
44: * If the <code>FULL_CONTEXT</code> flag is specified, then the full
45: * context of the source should be captured by the frame.
46: * Otherwise, only the visible aspects of the frame, such as the name and tool tip text,
47: * will be used.
48: *
49: * @param whichFrame one of the frame constants defined in this interface
50: * @param flags a bit-wise OR of the flag constants defined in this interface
51: * @return a new frame describing the current state of the source
52: */
53: public Frame getFrame(int whichFrame, int flags);
54: }
|