public class JHSecondaryViewer extends javax.swing.JButton implements java.awt.event.ActionListener, ViewAwareComponent
To use this class within HTML content use the <object> tag. Below is an example usage:
<object CLASSID="java:com.sun.java.help.impl.JHSecondaryViewer"> <param name="content" value="secondary_contents.html"> <param name="viewerActivator" value="javax.help.LinkLabel"> <param name="viewerStyle" value="javax.help.Popup"> <param name="viewerSize" value="300,400"> <param name="text" value="Click here"> <param name="textFontFamily" value="SansSerif"> <param name="textFontSize" value="x-large"> <param name="textFontWeight" value="plain"> <param name="textFontStyle" value="italic"> <param name="textColor" value="red"> </object>
Valid parameters are:
- id - a valid id from the current HelpSet
,
- viewerName - the name of the SecondaryWindow to display the content in
,
- viewerActivator - the activator type for the viewer.
Either "javax.help.LinkButton" or "javax.help.LinkLabel"
,
- viewerStyle - the style of the viewer. Either "SecondaryWindow" or "Popup"
,
- viewerLocation - the x,y coordinates applied to a secondary window.
,
- viewerSize - the width, height applied to a viewer.
,
- 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
,
- text - the text of the activator
,
- textFontFamily - the font family of the activator text
,
- textFontSize - the size of the activator text font. Size is specified
in a css termonolgy. See the setTextFontSize for acceptable syntax
,
- textFontWeight - the activator text font weight
,
- textFontStyle - the activator text font style
,
- textColor - the activator text color
,
,
JHSecondaryWindowBeanInfo
,
Serialized Formjavax.swing.JButton.AccessibleJButton
javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
LINK_BUTTON |
static java.lang.String |
LINK_LABEL |
static java.lang.String |
POPUP |
static java.lang.String |
SECONDARY_WINDOW |
actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor and Description |
---|
JHSecondaryViewer()
Create a secondaryviewer.
|
Modifier and Type | Method and Description |
---|---|
void |
actionPerformed(java.awt.event.ActionEvent e)
Displays the viewer according to the viewerType
|
java.lang.String |
getContent()
Returns the content of the secondary viewer
|
java.lang.String |
getId()
Returns the ID of the secondary viewer
|
java.lang.String |
getTextColor()
Returns the text Color of the activator text
|
java.lang.String |
getTextFontFamily()
Returns the text Font family name of the activator text
|
java.lang.String |
getTextFontSize()
Returns the text Font family name of the activator text
|
java.lang.String |
getTextFontStyle()
Returns the text Font style of the activator text
|
java.lang.String |
getTextFontWeight()
Returns the text Font weight of the activator text
|
java.lang.String |
getViewerActivator()
Returns the viewer activator
|
java.lang.String |
getViewerLocation()
Returns the viewer Location.
|
java.lang.String |
getViewerName()
Returns the viewer name
|
java.lang.String |
getViewerSize()
Returns the viewer's Size.
|
java.lang.String |
getViewerStyle()
Returns the current ViewerStyle
|
void |
setContent(java.lang.String content)
Set the content for the secondary viewer
|
void |
setIconByID(java.lang.String name)
Sets the icon in the activator by id.
|
void |
setIconByName(java.lang.String name)
Sets the icon in the activator by url or id.
|
void |
setId(java.lang.String id)
Set the ID for content in the secondary viewer
|
void |
setTextColor(java.lang.String name)
Sets the text Color for the activator text.
|
void |
setTextFontFamily(java.lang.String family)
Sets the text Font family for the activator text.
|
void |
setTextFontSize(java.lang.String size)
Sets the text size for the activator text.
|
void |
setTextFontStyle(java.lang.String style)
Sets the text Font Style for the activator text.
|
void |
setTextFontWeight(java.lang.String weight)
Sets the text Font Weigth for the activator text.
|
void |
setViewData(javax.swing.text.View v)
Sets data optained from the View
|
void |
setViewerActivator(java.lang.String activator)
Sets the viewer activator.
|
void |
setViewerLocation(java.lang.String location)
Sets the viewer's location to display the content in.
|
void |
setViewerName(java.lang.String name)
Sets the viewer name to display the content in.
|
void |
setViewerSize(java.lang.String size)
Sets the viewer's size to display the content in.
|
void |
setViewerStyle(java.lang.String style)
Sets the viewer style.
|
getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI
actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public static java.lang.String POPUP
public static java.lang.String SECONDARY_WINDOW
public static java.lang.String LINK_BUTTON
public static java.lang.String LINK_LABEL
public JHSecondaryViewer()
public void setViewData(javax.swing.text.View v)
setViewData
in interface ViewAwareComponent
public void setContent(java.lang.String content)
content
- a valid URLpublic java.lang.String getContent()
public void setId(java.lang.String id)
content
- a valid URLpublic java.lang.String getId()
public void setViewerName(java.lang.String name)
public java.lang.String getViewerName()
public void setViewerActivator(java.lang.String activator)
public java.lang.String getViewerActivator()
public void setViewerStyle(java.lang.String style)
Viewer style is updated the next time the viewer is made visible
style
- a valid ViewerStylepublic java.lang.String getViewerStyle()
public void setViewerLocation(java.lang.String location)
getViewerLocation
public java.lang.String getViewerLocation()
setViewerLocation
public void setViewerSize(java.lang.String size)
getViewerSize
public java.lang.String getViewerSize()
setViewerSize
public void setIconByName(java.lang.String name)
getIcon
public void setIconByID(java.lang.String name)
getIcon
public void setTextFontFamily(java.lang.String family)
public java.lang.String getTextFontFamily()
public void setTextFontSize(java.lang.String size)
public java.lang.String getTextFontSize()
public void setTextFontWeight(java.lang.String weight)
public java.lang.String getTextFontWeight()
public void setTextFontStyle(java.lang.String style)
public java.lang.String getTextFontStyle()
public void setTextColor(java.lang.String name)
public java.lang.String getTextColor()
public void actionPerformed(java.awt.event.ActionEvent e)
actionPerformed
in interface java.awt.event.ActionListener