Package org.fife.ui.rsyntaxtextarea
Class MatchedBracketPopup
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- java.awt.Window
-
- javax.swing.JWindow
-
- org.fife.ui.rsyntaxtextarea.MatchedBracketPopup
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
,javax.swing.RootPaneContainer
public class MatchedBracketPopup extends javax.swing.JWindow
A tool tip-like popup that shows the line of code containing the bracket matched to that at the caret position, if it is scrolled out of the user's viewport.- Version:
- 1.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private class
MatchedBracketPopup.EscapeAction
Action performed when Escape is pressed in this popup.private class
MatchedBracketPopup.Listener
Listens for events in this popup.-
Nested classes/interfaces inherited from class javax.swing.JWindow
javax.swing.JWindow.AccessibleJWindow
-
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
-
-
Field Summary
Fields Modifier and Type Field Description private static boolean
CONSIDER_TEXTAREA_BG
private static int
LEFT_EMPTY_BORDER
private MatchedBracketPopup.Listener
listener
static java.lang.String
PROPERTY_CONSIDER_TEXTAREA_BACKGROUND
If this system property is defined and set totrue
, matched bracket popups may render with the text area's background color if necessary to facilitate contrast between their text content (typically code) and their backgrounds.private RSyntaxTextArea
textArea
-
Fields inherited from class javax.swing.JWindow
accessibleContext, rootPane, rootPaneCheckingEnabled
-
-
Constructor Summary
Constructors Constructor Description MatchedBracketPopup(java.awt.Window parent, RSyntaxTextArea textArea, int offsToRender)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.awt.Dimension
getPreferredSize()
Overridden to ensure this popup stays in a specific size range.private java.lang.String
getText(int offsToRender)
private void
installKeyBindings()
Adds key bindings to this popup.private void
setLocation()
Positions this popup to be in the top right-hand corner of the parent editor.-
Methods inherited from class javax.swing.JWindow
addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setGlassPane, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update, windowInit
-
Methods inherited from class java.awt.Window
addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBackground, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setOpacity, setShape, setSize, setSize, setType, setVisible, show, toBack, toFront
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
PROPERTY_CONSIDER_TEXTAREA_BACKGROUND
public static final java.lang.String PROPERTY_CONSIDER_TEXTAREA_BACKGROUND
If this system property is defined and set totrue
, matched bracket popups may render with the text area's background color if necessary to facilitate contrast between their text content (typically code) and their backgrounds. This is necessary for good looking popups when a text area's background may be drastically different than the Look and Feel's tool tip color (e.g. dark editor embedded in a "light" themed application, or vice versa). If this is omitted or does NOT evaluate totrue
, matched bracket popups will always render like "native" tool tips according to the current Look and Feel. Users typically don't need to set this totrue
unless their application allows users to select a theme or color scheme forRSyntaxTextArea
instances separately from the Look and Feel. For applications that instead only have one Look and Feel/RSTA theme combo, or allow toggling between fixed light and dark themes, the default offalse
is fine.- See Also:
- Constant Field Values
-
textArea
private RSyntaxTextArea textArea
-
listener
private transient MatchedBracketPopup.Listener listener
-
LEFT_EMPTY_BORDER
private static final int LEFT_EMPTY_BORDER
- See Also:
- Constant Field Values
-
CONSIDER_TEXTAREA_BG
private static final boolean CONSIDER_TEXTAREA_BG
-
-
Constructor Detail
-
MatchedBracketPopup
MatchedBracketPopup(java.awt.Window parent, RSyntaxTextArea textArea, int offsToRender)
-
-
Method Detail
-
getPreferredSize
public java.awt.Dimension getPreferredSize()
Overridden to ensure this popup stays in a specific size range.- Overrides:
getPreferredSize
in classjava.awt.Container
-
getText
private java.lang.String getText(int offsToRender)
-
installKeyBindings
private void installKeyBindings()
Adds key bindings to this popup.
-
setLocation
private void setLocation()
Positions this popup to be in the top right-hand corner of the parent editor.
-
-