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
,java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
- Direct Known Subclasses:
AcrolinxMultiViewSidebarSwing
public class AcrolinxSidebarSwing extends javafx.embed.swing.JFXPanel implements AcrolinxSidebar
Swing implementation of Acrolinx Sidebar.- See Also:
AcrolinxSidebar
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected AcrolinxIntegration
acrolinxIntegration
protected AcrolinxStorage
acrolinxStorage
protected static org.slf4j.Logger
logger
protected AcrolinxSidebarJFX
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
-
-
Constructor Summary
Constructors Constructor Description AcrolinxSidebarSwing(AcrolinxIntegration acrolinxIntegration)
AcrolinxSidebarSwing(AcrolinxIntegration acrolinxIntegration, AcrolinxStorage acrolinxStorage)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkDocumentInBatch(java.lang.String documentIdentifier, java.lang.String documentContent, CheckOptions checkOptions)
void
checkGlobal()
Triggers a check action in the Acrolinx Sidebar, same as pushing the checkButton.void
configure(SidebarConfiguration sidebarConfiguration)
Pushed the configuration to the Acrolinx Sidebar.protected void
createScene()
java.lang.String
getLastCheckedDocument()
Gets the content of the lasted successfully checked document.java.lang.String
getLastCheckedDocumentReference()
Gets the document reference of the lasted successfully checked document.ExternalContent
getLastCheckedExternalContent()
AcrolinxSidebarJFX
getSidebarJFX()
void
initBatchCheck(java.util.List<BatchCheckRequestOptions> batchCheckRequestOptions)
void
invalidateRanges(java.util.List<CheckedDocumentPart> invalidCheckedDocumentRanges)
Notifies the sidebar about invalid ranges of the current document.void
invalidateRangesForMatches(java.util.List<? extends AbstractMatch> abstractMatches)
Notifies the sidebar about invalid ranges of the current document.void
loadSidebarFromServerLocation(java.lang.String serverAddress)
Load the sidebar from a different server address.void
onGlobalCheckRejected()
Notifies the sidebar that the check was canceled.protected void
processKeyEvent(java.awt.event.KeyEvent keyEvent)
void
reload()
Reload the current sidebar.void
showMessage(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, 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
-
-
-
-
Field Detail
-
logger
protected static final org.slf4j.Logger logger
-
sidebarJFX
protected transient AcrolinxSidebarJFX sidebarJFX
-
acrolinxStorage
protected final transient AcrolinxStorage acrolinxStorage
-
acrolinxIntegration
protected final transient AcrolinxIntegration acrolinxIntegration
-
-
Constructor Detail
-
AcrolinxSidebarSwing
public AcrolinxSidebarSwing(AcrolinxIntegration acrolinxIntegration)
-
AcrolinxSidebarSwing
public AcrolinxSidebarSwing(AcrolinxIntegration acrolinxIntegration, AcrolinxStorage acrolinxStorage)
-
-
Method Detail
-
processKeyEvent
protected void processKeyEvent(java.awt.event.KeyEvent keyEvent)
- Overrides:
processKeyEvent
in classjavafx.embed.swing.JFXPanel
-
createScene
protected void createScene()
-
configure
public void configure(SidebarConfiguration sidebarConfiguration)
Description copied from interface:AcrolinxSidebar
Pushed the configuration to the Acrolinx Sidebar.- Specified by:
configure
in interfaceAcrolinxSidebar
- See Also:
SidebarConfiguration
-
checkGlobal
public void checkGlobal()
Description copied from interface:AcrolinxSidebar
Triggers a check action in the Acrolinx Sidebar, same as pushing the checkButton.- Specified by:
checkGlobal
in interfaceAcrolinxSidebar
-
onGlobalCheckRejected
public void onGlobalCheckRejected()
Description copied from interface:AcrolinxSidebar
Notifies the sidebar that the check was canceled.- Specified by:
onGlobalCheckRejected
in interfaceAcrolinxSidebar
-
invalidateRanges
public void invalidateRanges(java.util.List<CheckedDocumentPart> invalidCheckedDocumentRanges)
Description copied from interface:AcrolinxSidebar
Notifies the sidebar about invalid ranges of the current document. The sidebar will then invalidate all cards containing issues within this text range.- Specified by:
invalidateRanges
in interfaceAcrolinxSidebar
-
invalidateRangesForMatches
public void invalidateRangesForMatches(java.util.List<? extends AbstractMatch> abstractMatches)
Description copied from interface:AcrolinxSidebar
Notifies 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:
invalidateRangesForMatches
in interfaceAcrolinxSidebar
-
loadSidebarFromServerLocation
public void loadSidebarFromServerLocation(java.lang.String serverAddress)
Description copied from interface:AcrolinxSidebar
Load the sidebar from a different server address.- Specified by:
loadSidebarFromServerLocation
in interfaceAcrolinxSidebar
-
reload
public void reload()
Description copied from interface:AcrolinxSidebar
Reload the current sidebar.- Specified by:
reload
in interfaceAcrolinxSidebar
-
getLastCheckedDocumentReference
public java.lang.String getLastCheckedDocumentReference()
Description copied from interface:AcrolinxSidebar
Gets the document reference of the lasted successfully checked document.- Specified by:
getLastCheckedDocumentReference
in interfaceAcrolinxSidebar
- Returns:
- documentReference
-
getLastCheckedDocument
public java.lang.String getLastCheckedDocument()
Description copied from interface:AcrolinxSidebar
Gets the content of the lasted successfully checked document.- Specified by:
getLastCheckedDocument
in interfaceAcrolinxSidebar
- Returns:
- documentContent
-
getLastCheckedExternalContent
public ExternalContent getLastCheckedExternalContent()
-
showMessage
public void showMessage(SidebarMessage sidebarMessage)
Description copied from interface:AcrolinxSidebar
Shows a message in the sidebar.- Specified by:
showMessage
in interfaceAcrolinxSidebar
-
initBatchCheck
public void initBatchCheck(java.util.List<BatchCheckRequestOptions> batchCheckRequestOptions)
- Specified by:
initBatchCheck
in interfaceAcrolinxSidebar
-
checkDocumentInBatch
public void checkDocumentInBatch(java.lang.String documentIdentifier, java.lang.String documentContent, CheckOptions checkOptions)
- Specified by:
checkDocumentInBatch
in interfaceAcrolinxSidebar
-
getSidebarJFX
public AcrolinxSidebarJFX getSidebarJFX()
-
-