Package com.acrolinx.sidebar.swing

Class AcrolinxMultiViewSidebarSwing

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javafx.embed.swing.JFXPanel

com.acrolinx.sidebar.swing.AcrolinxSidebarSwing

com.acrolinx.sidebar.swing.AcrolinxMultiViewSidebarSwing

All Implemented Interfaces:

AcrolinxMultiViewSidebarInterface, AcrolinxSidebar, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class AcrolinxMultiViewSidebarSwing
extends AcrolinxSidebarSwing
implements AcrolinxMultiViewSidebarInterface

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class com.acrolinx.sidebar.swing.AcrolinxSidebarSwing

acrolinxIntegration, acrolinxStorage, logger, sidebarJFX

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
AcrolinxMultiViewSidebarSwing(AcrolinxIntegration acrolinxIntegration)
AcrolinxMultiViewSidebarSwing(AcrolinxIntegration acrolinxIntegration, AcrolinxStorage acrolinxStorage)

Method Summary

Modifier and Type	Method	Description
void	addSidebar(AcrolinxIntegration acrolinxIntegration, java.lang.String documentId)	Launches a new sidebar for the opened document with id documentId.
protected void	createScene()
void	removeSidebar(java.lang.String documentId)	Removes the sidebar for the document with id documentId.
void	showEmptyMessage()
void	switchSidebar(java.lang.String documentId)	Switches the active sidebar to the one corresponding to the document with id documentId.

Methods inherited from class com.acrolinx.sidebar.swing.AcrolinxSidebarSwing

checkDocumentInBatch, checkGlobal, configure, getLastCheckedDocument, getLastCheckedDocumentReference, getLastCheckedExternalContent, getSidebarJFX, initBatchCheck, invalidateRanges, invalidateRangesForMatches, loadSidebarFromServerLocation, onGlobalCheckRejected, processKeyEvent, reload, showMessage

Methods inherited from class javafx.embed.swing.JFXPanel

addNotify, getInputMethodRequests, getPreferredSize, getScene, isOpaque, paintComponent, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeNotify, setOpaque, setScene

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

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

Methods inherited from class java.awt.Component

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, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, 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, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AcrolinxMultiViewSidebarSwing

public AcrolinxMultiViewSidebarSwing(AcrolinxIntegration acrolinxIntegration)

AcrolinxMultiViewSidebarSwing

public AcrolinxMultiViewSidebarSwing(AcrolinxIntegration acrolinxIntegration,
                                     AcrolinxStorage acrolinxStorage)

Parameters:

acrolinxIntegration - Acrolinx Integration with Acrolinx storage as external synchronous local storage

Method Detail

createScene

protected void createScene()

Overrides:

createScene in class AcrolinxSidebarSwing

addSidebar

public void addSidebar(AcrolinxIntegration acrolinxIntegration,
                       java.lang.String documentId)
                throws AcrolinxException

Description copied from interface: AcrolinxMultiViewSidebarInterface

Launches a new sidebar for the opened document with id documentId.

Specified by:

addSidebar in interface AcrolinxMultiViewSidebarInterface

Parameters:

acrolinxIntegration - New integration dedicated per sidebar instance

documentId - Unique document Id for the sidebar instance eg: file path

Throws:

AcrolinxException - Throws exception is sidebar already exists for the document

switchSidebar

public void switchSidebar(java.lang.String documentId)
                   throws AcrolinxException

Description copied from interface: AcrolinxMultiViewSidebarInterface

Switches the active sidebar to the one corresponding to the document with id documentId.

Specified by:

switchSidebar in interface AcrolinxMultiViewSidebarInterface

Parameters:

documentId - Document Id of the sidebar instance to switch active sidebar to.

Throws:

AcrolinxException - Throws if sidebar not found for provided document id.

removeSidebar

public void removeSidebar(java.lang.String documentId)
                   throws AcrolinxException

Description copied from interface: AcrolinxMultiViewSidebarInterface

Removes the sidebar for the document with id documentId.

Specified by:

removeSidebar in interface AcrolinxMultiViewSidebarInterface

Parameters:

documentId - Document Id for the sidebar instance to be removed

Throws:

AcrolinxException - Throws if sidebar not found for the provided document id.

showEmptyMessage

public void showEmptyMessage()