org.eclipse.help.webapp

Class AbstractFrame

java.lang.Object

org.eclipse.help.webapp.AbstractFrame

All Implemented Interfaces:

java.lang.Comparable<AbstractFrame>

public abstract class AbstractFrame
extends java.lang.Object
implements java.lang.Comparable<AbstractFrame>

A view which contributes a frame to the help webapp

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
static int	BELOW_CONTENT Constant returned from getFrameLocation() function to indicate that the frame should be created below the content frame or the Main Help Toolbar
static int	HELP_TOOLBAR

Constructor Summary

Constructors

Constructor and Description
AbstractFrame()

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractFrame o)
java.lang.String	getFrameAttributes() allows the attributes of this frame other than name and src to be specified
abstract int	getLocation() Function which defines the frame location
abstract java.lang.String	getName()
java.lang.String	getSize()
abstract java.lang.String	getURL()
boolean	isVisible()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BELOW_CONTENT

public static final int BELOW_CONTENT

Constant returned from getFrameLocation() function to indicate that the frame should be created below the content frame or the Main Help Toolbar

See Also:

Constant Field Values

HELP_TOOLBAR

public static final int HELP_TOOLBAR

See Also:

Constant Field Values

Constructor Detail

AbstractFrame

public AbstractFrame()

Method Detail

getLocation

public abstract int getLocation()

Function which defines the frame location

Returns:

a constant defined in this class which indicates the location of this frame

getName

public abstract java.lang.String getName()

Returns:

a non translated name which is the name of this frame

getURL

public abstract java.lang.String getURL()

Returns:

a URL path, relative to /help which is the location of the jsp files in the advanced presentation

getSize

public java.lang.String getSize()

Returns:

a string which will be used in the rows or cols attribute of a frameset in the html

isVisible

public boolean isVisible()

Returns:

true if the frame should be shown in the advanced presentation

getFrameAttributes

public java.lang.String getFrameAttributes()

allows the attributes of this frame other than name and src to be specified

Returns:

a list of attributes

compareTo

public final int compareTo(AbstractFrame o)

Specified by:

compareTo in interface java.lang.Comparable<AbstractFrame>

Since:

3.7