Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.3.0)

E17493-04


oracle.javatools.editor
Class FileOverviewMargin

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by oracle.javatools.editor.FileOverviewMargin

All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, EditorPlugin

public class FileOverviewMargin
extends javax.swing.JComponent
implements EditorPlugin
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
static int PRIORITY_HIGH
           
static int PRIORITY_LOW
           
static int PRIORITY_MEDIUM
           

 

Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
FileOverviewMargin()
           

 

Method Summary
 void addMark(java.lang.String category, int line, FileOverviewMark mark)
           
 void clearAnalysis()
           
 void clearMarks(java.lang.String category)
           
 javax.swing.JToolTip createToolTip()
           
 void deinstall(BasicEditorPane editor)
          Called when the plugin is being removed from the BasicEditorPane (for example when the editor is closed.) This is used to notify plugins that they should unregister any listeners that were attached.
protected  void drawBox(java.awt.Graphics g, java.awt.Rectangle rect, java.awt.Color color)
           
protected  int getBottomOffset()
           
static FileOverviewMargin getFileOverviewMargin(BasicEditorPane editor)
           
static java.lang.Object getMarkColor(java.lang.String category)
           
 java.awt.Dimension getMaximumSize()
           
 java.awt.Dimension getMinimumSize()
           
 java.awt.Dimension getPreferredSize()
           
 java.lang.String getToolTipText()
           
 java.lang.String getToolTipText(java.awt.event.MouseEvent event)
           
protected  int getTopOffset()
           
 void install(BasicEditorPane basicEditorPane)
          Called when this plugin is being installed into the BasicEditorPane.
 boolean isFocusTraversable()
          Deprecated.  
 int markToLine(java.lang.String category, FileOverviewMark mark)
           
protected  void navigate(int line, FileOverviewMark mark)
           
protected  void paintComponent(java.awt.Graphics g)
           
 void propertyChange(java.beans.PropertyChangeEvent evt)
           
 void removeMark(java.lang.String category, int line, FileOverviewMark mark)
           
static void removeMarkColor(java.lang.String category)
           
static void setMarkColor(java.lang.String category, java.awt.Color color)
           
static void setMarkColor(java.lang.String category, HighlightStyle highlightStyle)
           
static void setMarkColor(java.lang.String category, int priority, java.awt.Color color)
           
static void setMarkColor(java.lang.String category, int priority, HighlightStyle highlightStyle)
           
 void startAnalysis(java.lang.Object id, java.lang.String tooltip)
           
 void stopAnalysis(java.lang.Object id)
           

 

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, transferFocusBackward, 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

PRIORITY_LOW

public static final int PRIORITY_LOW
See Also:
Constant Field Values

PRIORITY_MEDIUM

public static final int PRIORITY_MEDIUM
See Also:
Constant Field Values

PRIORITY_HIGH

public static final int PRIORITY_HIGH
See Also:
Constant Field Values

Constructor Detail

FileOverviewMargin

public FileOverviewMargin()

Method Detail

setMarkColor

public static void setMarkColor(java.lang.String category,
                                java.awt.Color color)

setMarkColor

public static void setMarkColor(java.lang.String category,
                                HighlightStyle highlightStyle)

setMarkColor

public static void setMarkColor(java.lang.String category,
                                int priority,
                                java.awt.Color color)

setMarkColor

public static void setMarkColor(java.lang.String category,
                                int priority,
                                HighlightStyle highlightStyle)

getMarkColor

public static java.lang.Object getMarkColor(java.lang.String category)

removeMarkColor

public static void removeMarkColor(java.lang.String category)

getFileOverviewMargin

public static FileOverviewMargin getFileOverviewMargin(BasicEditorPane editor)

navigate

protected void navigate(int line,
                        FileOverviewMark mark)

clearAnalysis

public void clearAnalysis()

startAnalysis

public void startAnalysis(java.lang.Object id,
                          java.lang.String tooltip)

stopAnalysis

public void stopAnalysis(java.lang.Object id)

clearMarks

public final void clearMarks(java.lang.String category)

addMark

public final void addMark(java.lang.String category,
                          int line,
                          FileOverviewMark mark)

markToLine

public final int markToLine(java.lang.String category,
                            FileOverviewMark mark)

removeMark

public final void removeMark(java.lang.String category,
                             int line,
                             FileOverviewMark mark)

getTopOffset

protected int getTopOffset()

getBottomOffset

protected int getBottomOffset()

createToolTip

public final javax.swing.JToolTip createToolTip()
Overrides:
createToolTip in class javax.swing.JComponent

getPreferredSize

public final java.awt.Dimension getPreferredSize()
Overrides:
getPreferredSize in class javax.swing.JComponent

getMinimumSize

public final java.awt.Dimension getMinimumSize()
Overrides:
getMinimumSize in class javax.swing.JComponent

getMaximumSize

public final java.awt.Dimension getMaximumSize()
Overrides:
getMaximumSize in class javax.swing.JComponent

isFocusTraversable

public final boolean isFocusTraversable()
Deprecated. 
Overrides:
isFocusTraversable in class java.awt.Component

paintComponent

protected void paintComponent(java.awt.Graphics g)
Overrides:
paintComponent in class javax.swing.JComponent

drawBox

protected void drawBox(java.awt.Graphics g,
                       java.awt.Rectangle rect,
                       java.awt.Color color)

getToolTipText

public final java.lang.String getToolTipText()
Overrides:
getToolTipText in class javax.swing.JComponent

getToolTipText

public final java.lang.String getToolTipText(java.awt.event.MouseEvent event)
Overrides:
getToolTipText in class javax.swing.JComponent

install

public final void install(BasicEditorPane basicEditorPane)
Called when this plugin is being installed into the BasicEditorPane.
Specified by:
install in interface EditorPlugin
Parameters:
editor - the editor pane

deinstall

public final void deinstall(BasicEditorPane editor)
Called when the plugin is being removed from the BasicEditorPane (for example when the editor is closed.) This is used to notify plugins that they should unregister any listeners that were attached.
Specified by:
deinstall in interface EditorPlugin
Parameters:
editor - the editor pane

propertyChange

public final void propertyChange(java.beans.PropertyChangeEvent evt)
Specified by:
propertyChange in interface java.beans.PropertyChangeListener

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.3.0)

E17493-04


Copyright © 1997, 2012, Oracle. All rights reserved.