KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > views > framelist > IFrameSource


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ui.views.framelist;
12
13 /**
14  * A frame source is the source of frames which appear in a frame list.
15  * The frame list asks for the current frame whenever it switches
16  * to another frame, so that the context can be restored when the
17  * frame becomes current again.
18  *
19  * @see FrameList
20  */
21 public interface IFrameSource {
22
23     /**
24      * Frame constant indicating the current frame.
25      */
26     public static final int CURRENT_FRAME = 0x0001;
27
28     /**
29      * Frame constant indicating the frame for the selection.
30      */
31     public static final int SELECTION_FRAME = 0x0002;
32
33     /**
34      * Frame constant indicating the parent frame.
35      */
36     public static final int PARENT_FRAME = 0x0003;
37
38     /**
39      * Flag constant indicating that the full context should be captured.
40      */
41     public static final int FULL_CONTEXT = 0x0001;
42
43     /**
44      * Returns a new frame describing the state of the source.
45      * If the <code>FULL_CONTEXT</code> flag is specified, then the full
46      * context of the source should be captured by the frame.
47      * Otherwise, only the visible aspects of the frame, such as the name and tool tip text,
48      * will be used.
49      *
50      * @param whichFrame one of the frame constants defined in this interface
51      * @param flags a bit-wise OR of the flag constants defined in this interface
52      * @return a new frame describing the current state of the source
53      */
54     public Frame getFrame(int whichFrame, int flags);
55 }
56
Popular Tags