001: /*******************************************************************************
002: * Copyright (c) 2000, 2006 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.ui.views.framelist;
011:
012: /**
013: * Generic frame, which captures the state for one frame in the frame list.
014: * Clients may subclass this frame to add their own state.
015: */
016: public class Frame {
017:
018: private int index = -1;
019:
020: private FrameList parent;
021:
022: private String name = ""; //$NON-NLS-1$
023:
024: private String toolTipText;
025:
026: /**
027: * Constructs a new frame. <p>
028: *
029: * This implementation does nothing.
030: */
031: public Frame() {
032: }
033:
034: /**
035: * Returns the index of the frame in the frame list.
036: * Only valid once the frame has been added to the frame list.
037: *
038: * @return the index of the frame in the frame list.
039: */
040: public int getIndex() {
041: return index;
042: }
043:
044: /**
045: * Returns the displayable name for the frame.
046: *
047: * @return the displayable name for the frame.
048: */
049: public String getName() {
050: return name;
051: }
052:
053: /**
054: * Returns the frame list.
055: *
056: * @return the frame list
057: */
058: public FrameList getParent() {
059: return parent;
060: }
061:
062: /**
063: * Returns the tool tip text to show for the frame.
064: * This can form part of the tool tip for actions like the back and forward
065: * actions.
066: *
067: * @return the tool tip text to show for the frame
068: */
069: public String getToolTipText() {
070: return toolTipText;
071: }
072:
073: /**
074: * Sets the index of the frame in the frame list.
075: * Should only be called by the frame list.
076: *
077: * @param index the index of the frame in the frame list
078: */
079: public void setIndex(int index) {
080: this .index = index;
081: }
082:
083: /**
084: * Sets the displayable name for the frame.
085: *
086: * @param name the displayable name
087: */
088: public void setName(String name) {
089: this .name = name;
090: }
091:
092: /**
093: * Sets the frame list.
094: *
095: * @param parent the frame list
096: */
097: public void setParent(FrameList parent) {
098: this .parent = parent;
099: }
100:
101: /**
102: * Sets the tool tip text to show for the frame.
103: * This can form part of the tool tip for actions like the back and forward
104: * actions.
105: *
106: * @param toolTipText the tool tip text to show for the frame.
107: */
108: public void setToolTipText(String toolTipText) {
109: this.toolTipText = toolTipText;
110: }
111: }
|