Package org.eclipse.help.webapp
Class AbstractFrame
- java.lang.Object
-
- org.eclipse.help.webapp.AbstractFrame
-
- All Implemented Interfaces:
Comparable<AbstractFrame>
public abstract class AbstractFrame extends Object implements Comparable<AbstractFrame>
A view which contributes a frame to the help webapp- Since:
- 3.5
-
-
Field Summary
Fields Modifier and Type Field 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 Toolbarstatic int
HELP_TOOLBAR
-
Constructor Summary
Constructors Constructor Description AbstractFrame()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
compareTo(AbstractFrame o)
String
getFrameAttributes()
allows the attributes of this frame other than name and src to be specifiedabstract int
getLocation()
Function which defines the frame locationabstract String
getName()
String
getSize()
abstract String
getURL()
boolean
isVisible()
-
-
-
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
-
-
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 String getName()
- Returns:
- a non translated name which is the name of this frame
-
getURL
public abstract String getURL()
- Returns:
- a URL path, relative to /help which is the location of the jsp files in the advanced presentation
-
getSize
public 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 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 interfaceComparable<AbstractFrame>
- Since:
- 3.7
-
-