Package org.eclipse.help.webapp
Class AbstractFrame
java.lang.Object
org.eclipse.help.webapp.AbstractFrame
- All Implemented Interfaces:
Comparable<AbstractFrame>
A view which contributes a frame to the help webapp
- Since:
- 3.5
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Constant returned from getFrameLocation() function to indicate that the frame should be created below the content frame or the Main Help Toolbarstatic final int
-
Constructor Summary
-
Method Summary
-
Field Details
-
BELOW_CONTENT
public static final int BELOW_CONTENTConstant returned from getFrameLocation() function to indicate that the frame should be created below the content frame or the Main Help Toolbar- See Also:
-
HELP_TOOLBAR
public static final int HELP_TOOLBAR- See Also:
-
-
Constructor Details
-
AbstractFrame
public AbstractFrame()
-
-
Method Details
-
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
- Returns:
- a non translated name which is the name of this frame
-
getURL
- Returns:
- a URL path, relative to /help which is the location of the jsp files in the advanced presentation
-
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
allows the attributes of this frame other than name and src to be specified- Returns:
- a list of attributes
-
compareTo
- Specified by:
compareTo
in interfaceComparable<AbstractFrame>
- Since:
- 3.7
-