javax.accessibility.Accessible
public class JHelpContentViewer
extends javax.swing.JComponent
implements javax.accessibility.Accessible
Modifier and Type | Class | Description |
---|---|---|
protected class |
JHelpContentViewer.AccessibleJHelpContentViewer |
The class used to obtain the accessible role for this object.
|
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
Modifier and Type | Field | Description |
---|---|---|
protected TextHelpModel |
model |
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor | Description |
---|---|
JHelpContentViewer() |
Creates a JHelp with a default TextHelpModel.
|
JHelpContentViewer(HelpSet hs) |
Creates a JHelp with an instance of DefaultHelpModel as its data model.
|
JHelpContentViewer(TextHelpModel model) |
Creates a JHelp with an specific TextHelpModel as its data model.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addHelpModelListener(HelpModelListener l) |
Adds a listener for the HelpModelEvent posted after the model has
changed.
|
void |
addHighlight(int p0,
int p1) |
Hightlights a section of the current document from p0 to p1.
|
void |
addTextHelpModelListener(TextHelpModelListener l) |
Adds a listener for the TExtHelpModelEvent posted after the model has
changed.
|
void |
clear() |
Cleans the content
|
javax.swing.text.EditorKit |
createEditorKitForContentType(java.lang.String type) |
Creates a handler for the given type from the registry of editor kits.
|
javax.accessibility.AccessibleContext |
getAccessibleContext() |
Get the AccessibleContext associated with this JComponent
|
java.net.URL |
getCurrentURL() |
|
java.lang.String |
getDocumentTitle() |
|
TextHelpModel |
getModel() |
|
boolean |
getSynch() |
Returns synchronization mode
|
HelpContentViewerUI |
getUI() |
|
java.lang.String |
getUIClassID() |
|
void |
reload() |
Reloads the content
|
void |
removeAllHighlights() |
Removes any Highlights.
|
void |
removeHelpModelListener(HelpModelListener l) |
Removes a listener previously added with addHelpModelListener
|
void |
removeHelpModelListener(TextHelpModelListener l) |
Removes a listener previously added with addTextHelpModelListener
|
void |
setCurrentID(java.lang.String id) |
Visits a given ID.
|
void |
setCurrentID(Map.ID id) |
Visits a given ID.
|
void |
setCurrentURL(java.net.URL url) |
Visits a given URL.
|
void |
setModel(TextHelpModel newModel) |
Sets the HelpModel that provides the data.
|
void |
setSynch(boolean value) |
Sets synchronization of this JHelpContentViewer with navigators.
|
void |
setUI(HelpContentViewerUI ui) |
Sets the HelpViewerUI that provides the current look and feel.
|
void |
updateUI() |
Replaces the UI with the latest version from the default
UIFactory.
|
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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
add, add, add, add, add, addContainerListener, addImpl, 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, setLayout, transferFocusDownCycle, validate, validateTree
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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
protected TextHelpModel model
public JHelpContentViewer(HelpSet hs)
hs
- The HelpSet that provides context information. A null hs is valid
and creates a TextHelpModel with no HelpSet defined.public JHelpContentViewer()
public JHelpContentViewer(TextHelpModel model)
model
- The TextHelpModel. A null model is valid.public void setModel(TextHelpModel newModel)
newModel
- The new Model to provide events for this viewer.public TextHelpModel getModel()
public void setUI(HelpContentViewerUI ui)
ui
- Provides the ComponentUI object. A null ui is valid.public HelpContentViewerUI getUI()
getUI
in class javax.swing.JComponent
public void updateUI()
updateUI
in class javax.swing.JComponent
public java.lang.String getUIClassID()
getUIClassID
in class javax.swing.JComponent
public void setCurrentID(Map.ID id) throws InvalidHelpSetContextException
id
- The ID to visit.InvalidHelpSetContextException
- if id.hs is not contained in the
HelpSet of the current model.public void setCurrentID(java.lang.String id) throws BadIDException
id
- The String to visit. Relative to the HS of the current model.BadIDException
- The ID is not valid for the HelpSet for the current model.public void setCurrentURL(java.net.URL url)
url
- The URL to visit. Relative to the HS of the current modelpublic java.net.URL getCurrentURL()
public java.lang.String getDocumentTitle()
public void addHighlight(int p0, int p1)
p0
- Starting position.p1
- Ending position.public void removeAllHighlights()
public void setSynch(boolean value)
public boolean getSynch()
public javax.swing.text.EditorKit createEditorKitForContentType(java.lang.String type)
Once a prototype EditorKit instance is successfully located, it is cloned and the clone is returned.
type
- the content typepublic void addTextHelpModelListener(TextHelpModelListener l)
l
- - The listener to add.HelpModel.removeHelpModelListener(javax.help.event.HelpModelListener)
public void removeHelpModelListener(TextHelpModelListener l)
l
- - The listener to remove.TextHelpModel.addTextHelpModelListener(javax.help.event.TextHelpModelListener)
public void addHelpModelListener(HelpModelListener l)
l
- - The listener to add.HelpModel.removeHelpModelListener(javax.help.event.HelpModelListener)
public void removeHelpModelListener(HelpModelListener l)
l
- - The listener to remove.HelpModel.addHelpModelListener(javax.help.event.HelpModelListener)
public void clear()
public void reload()
public javax.accessibility.AccessibleContext getAccessibleContext()
getAccessibleContext
in interface javax.accessibility.Accessible
getAccessibleContext
in class java.awt.Component