Package com.acrolinx.sidebar.swing
Class AcrolinxSidebarSwing
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javafx.embed.swing.JFXPanel
com.acrolinx.sidebar.swing.AcrolinxSidebarSwing
- All Implemented Interfaces:
AcrolinxSidebar,ImageObserver,MenuContainer,Serializable
- Direct Known Subclasses:
AcrolinxMultiViewSidebarSwing
Swing implementation of Acrolinx Sidebar.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final AcrolinxIntegrationprotected final AcrolinxStorageprotected static final org.slf4j.Loggerprotected AcrolinxSidebarJFXFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionAcrolinxSidebarSwing(AcrolinxIntegration acrolinxIntegration) AcrolinxSidebarSwing(AcrolinxIntegration acrolinxIntegration, AcrolinxStorage acrolinxStorage) -
Method Summary
Modifier and TypeMethodDescriptionvoidcheckDocumentInBatch(String documentIdentifier, String documentContent, CheckOptions checkOptions) voidTriggers a check action in the Acrolinx Sidebar, same as pushing the checkButton.voidconfigure(SidebarConfiguration sidebarConfiguration) Pushed the configuration to the Acrolinx Sidebar.protected voidGets the content of the lasted successfully checked document.Gets the document reference of the lasted successfully checked document.voidinitBatchCheck(List<BatchCheckRequestOptions> batchCheckRequestOptions) voidinvalidateRanges(List<CheckedDocumentPart> invalidCheckedDocumentRanges) Notifies the sidebar about invalid ranges of the current document.voidinvalidateRangesForMatches(List<? extends AbstractMatch> abstractMatches) Notifies the sidebar about invalid ranges of the current document.voidloadSidebarFromServerLocation(String serverAddress) Load the sidebar from a different server address.voidNotifies the sidebar that the check was canceled.protected voidprocessKeyEvent(KeyEvent keyEvent) voidreload()Reload the current sidebar.voidshowMessage(SidebarMessage sidebarMessage) Shows a message in the sidebar.Methods inherited from class javafx.embed.swing.JFXPanel
addNotify, getInputMethodRequests, getPreferredSize, getScene, isOpaque, paintComponent, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeNotify, setOpaque, setSceneMethods 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, updateUIMethods 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, validateTreeMethods 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
-
Field Details
-
logger
protected static final org.slf4j.Logger logger -
sidebarJFX
-
acrolinxStorage
-
acrolinxIntegration
-
-
Constructor Details
-
AcrolinxSidebarSwing
-
AcrolinxSidebarSwing
public AcrolinxSidebarSwing(AcrolinxIntegration acrolinxIntegration, AcrolinxStorage acrolinxStorage)
-
-
Method Details
-
processKeyEvent
- Overrides:
processKeyEventin classJFXPanel
-
createScene
protected void createScene() -
configure
Description copied from interface:AcrolinxSidebarPushed the configuration to the Acrolinx Sidebar.- Specified by:
configurein interfaceAcrolinxSidebar- See Also:
-
checkGlobal
public void checkGlobal()Description copied from interface:AcrolinxSidebarTriggers a check action in the Acrolinx Sidebar, same as pushing the checkButton.- Specified by:
checkGlobalin interfaceAcrolinxSidebar
-
onGlobalCheckRejected
public void onGlobalCheckRejected()Description copied from interface:AcrolinxSidebarNotifies the sidebar that the check was canceled.- Specified by:
onGlobalCheckRejectedin interfaceAcrolinxSidebar
-
invalidateRanges
Description copied from interface:AcrolinxSidebarNotifies the sidebar about invalid ranges of the current document. The sidebar will then invalidate all cards containing issues within this text range.- Specified by:
invalidateRangesin interfaceAcrolinxSidebar
-
invalidateRangesForMatches
Description copied from interface:AcrolinxSidebarNotifies the sidebar about invalid ranges of the current document. The sidebar will then invalidate all cards containing issues within this text range for the current check.- Specified by:
invalidateRangesForMatchesin interfaceAcrolinxSidebar
-
loadSidebarFromServerLocation
Description copied from interface:AcrolinxSidebarLoad the sidebar from a different server address.- Specified by:
loadSidebarFromServerLocationin interfaceAcrolinxSidebar
-
reload
public void reload()Description copied from interface:AcrolinxSidebarReload the current sidebar.- Specified by:
reloadin interfaceAcrolinxSidebar
-
getLastCheckedDocumentReference
Description copied from interface:AcrolinxSidebarGets the document reference of the lasted successfully checked document.- Specified by:
getLastCheckedDocumentReferencein interfaceAcrolinxSidebar- Returns:
- documentReference
-
getLastCheckedDocument
Description copied from interface:AcrolinxSidebarGets the content of the lasted successfully checked document.- Specified by:
getLastCheckedDocumentin interfaceAcrolinxSidebar- Returns:
- documentContent
-
getLastCheckedExternalContent
-
showMessage
Description copied from interface:AcrolinxSidebarShows a message in the sidebar.- Specified by:
showMessagein interfaceAcrolinxSidebar
-
initBatchCheck
- Specified by:
initBatchCheckin interfaceAcrolinxSidebar
-
checkDocumentInBatch
public void checkDocumentInBatch(String documentIdentifier, String documentContent, CheckOptions checkOptions) - Specified by:
checkDocumentInBatchin interfaceAcrolinxSidebar
-
getSidebarJFX
-