content - a valid url, can be relative to the current viewer
- See Also:
- setContent
- id - a valid id from the current HelpSet, setId
- viewerName - the name of the SecondaryWindow to display the content in, setViewerName
- viewerActivator - the activator type for the viewer.
Either "javax.help.LinkButton" or "javax.help.LinkLabel", setViewerActivator
- viewerStyle - the style of the viewer. Either "SecondaryWindow" or "Popup", setViewerStyle
- viewerLocation - the x,y coordinates applied to a secondary window., setViewerLocation
- viewerSize - the width, height applied to a viewer., setViewerSize
- iconByName - the url or id of a icon to be displayed in the activator.
The url is relative to the base address of the document, setIconByName
- text - the text of the activator, setText
- textFontFamily - the font family of the activator text, setTextFontFamily
- textFontSize - the size of the activator text font. Size is specified
in a css termonolgy. See the setTextFontSize for acceptable syntax, setTextFontSize
- textFontWeight - the activator text font weight, setTextFontWeight
- textFontStyle - the activator text font style, setTextFontStyle
- textColor - the activator text color, setTextColor
, JHSecondaryWindowBeanInfo
POPUP
public static java.lang.String POPUP
SECONDARY_WINDOW
public static java.lang.String SECONDARY_WINDOW
LINK_BUTTON
public static java.lang.String LINK_BUTTON
LINK_LABEL
public static java.lang.String LINK_LABEL
JHSecondaryViewer
public JHSecondaryViewer()
- Create a secondaryviewer. By default the viewer creates a button with
the text of ">"
setViewData
public void setViewData(javax.swing.text.View v)
- Sets data optained from the View
- Implements:
- setViewData in interface ViewAwareComponent
setContent
public void setContent(java.lang.String content)
- Set the content for the secondary viewer
- Parameters:
content
- a valid URL
getContent
public java.lang.String getContent()
- Returns the content of the secondary viewer
setId
public void setId(java.lang.String id)
- Set the ID for content in the secondary viewer
- Parameters:
content
- a valid URL
getId
public java.lang.String getId()
- Returns the ID of the secondary viewer
setViewerName
public void setViewerName(java.lang.String name)
- Sets the viewer name to display the content in.
Viewer is only valid for ViewerStyle "SecondaryWindow"
getViewerName
public java.lang.String getViewerName()
- Returns the viewer name
setViewerActivator
public void setViewerActivator(java.lang.String activator)
- Sets the viewer activator.
Valid activators are
- javax.help.LinkButton
- javax.help.LinkLabel
The new activatory type will be used the next time a view is displayed.
getViewerActivator
public java.lang.String getViewerActivator()
- Returns the viewer activator
setViewerStyle
public void setViewerStyle(java.lang.String style)
- Sets the viewer style. There are two valid viewer styles:
- javax.help.SecondaryWindow
- javax.help.Popup
getViewerStyle
public java.lang.String getViewerStyle()
- Returns the current ViewerStyle
setViewerLocation
public void setViewerLocation(java.lang.String location)
- Sets the viewer's location to display the content in.
Location is relative to the screen or a modal dialog box
The String must be in the form of "x,y". If no viewer location
is established the default is 0,0 for secondary windows. Location
is ignored for popups.
- See Also:
- getViewerLocation
getViewerLocation
public java.lang.String getViewerLocation()
- Returns the viewer Location. Location is relative to the screen or
a modal dialog box. The form of the location is "x,y".
The default location is 0,0.
- See Also:
- setViewerLocation
setViewerSize
public void setViewerSize(java.lang.String size)
- Sets the viewer's size to display the content in.
The String must be in the form of "width,heigt".
If no size is set the default is 200,200.
- See Also:
- getViewerSize
getViewerSize
public java.lang.String getViewerSize()
- Returns the viewer's Size.
The form of the size is "width,height".
- See Also:
- setViewerSize
setIconByName
public void setIconByName(java.lang.String name)
- Sets the icon in the activator by url or id. The url is relative to the
base address of the document.
- See Also:
- getIcon
setIconByID
public void setIconByID(java.lang.String name)
- Sets the icon in the activator by id.
- See Also:
- getIcon
setTextFontFamily
public void setTextFontFamily(java.lang.String family)
- Sets the text Font family for the activator text.
For JDK 1.1 this must a family name of Dialog, DialogInput, Monospaced,
Serif, SansSerif, or Symbol.
getTextFontFamily
public java.lang.String getTextFontFamily()
- Returns the text Font family name of the activator text
setTextFontSize
public void setTextFontSize(java.lang.String size)
- Sets the text size for the activator text.
The String size is a valid Cascading Style Sheet value for
text size. Acceptable values are as follows:
- xx-small
- x-small
- small
- medium
- large
- x-large
- xx-large
- bigger - increase the current base font size by 1
- smaller - decrease the current base font size by 1
- xxpt - set the font size to a specific pt value of "xx"
- +x - increase the current base font size by a value of "x"
- -x - decrease the current base font size by a value of "x"
- x - set the font size to the point size associated with
the index "x"
getTextFontSize
public java.lang.String getTextFontSize()
- Returns the text Font family name of the activator text
setTextFontWeight
public void setTextFontWeight(java.lang.String weight)
- Sets the text Font Weigth for the activator text.
Valid weights are
getTextFontWeight
public java.lang.String getTextFontWeight()
- Returns the text Font weight of the activator text
setTextFontStyle
public void setTextFontStyle(java.lang.String style)
- Sets the text Font Style for the activator text.
Valid font styles are
getTextFontStyle
public java.lang.String getTextFontStyle()
- Returns the text Font style of the activator text
setTextColor
public void setTextColor(java.lang.String name)
- Sets the text Color for the activator text.
The following is a list of supported Color names
- black
- blue
- cyan
- darkGray
- gray
- green
- lightGray
- magenta
- orange
- pink
- red
- white
- yellow
getTextColor
public java.lang.String getTextColor()
- Returns the text Color of the activator text
actionPerformed
public void actionPerformed(java.awt.event.ActionEvent e)
- Displays the viewer according to the viewerType
- Implements:
- actionPerformed in interface java.awt.event.ActionListener