Package com.intellij.ui

Class SimpleColoredComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.intellij.ui.SimpleColoredComponent

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

AbstractTextFeedback, ColoredListCellRenderer, ColoredTreeCellRenderer, FQNameCellRenderer, NavBarItem, SimpleColoredRenderer

public class SimpleColoredComponent
extends javax.swing.JComponent
implements javax.accessibility.Accessible

This is high performance Swing component which represents an icon with a colored text. The text consists of fragments. Each text fragment has its own color (foreground) and font style.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SimpleColoredComponent.AccessibleSimpleColoredComponent
static class	SimpleColoredComponent.BrowserLauncherTag
static interface	SimpleColoredComponent.ColoredIterator

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

Modifier and Type	Field and Description
static int	FRAGMENT_ICON
protected int	myIconTextGap Gap between icon and text.

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 and Description
SimpleColoredComponent()

Method Summary

Modifier and Type	Method and Description
SimpleColoredComponent	append(java.lang.String fragment)
void	append(java.lang.String fragment, SimpleTextAttributes attributes) Appends string fragments to existing ones.
void	append(java.lang.String fragment, SimpleTextAttributes attributes, boolean isMainText) Appends string fragments to existing ones.
void	append(java.lang.String fragment, SimpleTextAttributes attributes, int padding, int align) Appends text fragment and sets it's end offset and alignment.
void	append(java.lang.String fragment, SimpleTextAttributes attributes, java.lang.Object tag)
void	appendTextPadding(int padding)
void	appendTextPadding(int padding, int align)
protected void	applyAdditionalHints(java.awt.Graphics2D g)
void	change(java.lang.Runnable runnable, boolean autoInvalidate)
void	clear() Clear all special attributes of SimpleColoredComponent.
java.awt.Dimension	computePreferredSize(boolean mainTextOnly)
protected void	doPaint(java.awt.Graphics2D g)
protected void	doPaintFragmentBackground(java.awt.Graphics2D g, int index, java.awt.Color bgColor, int x, int y, int width, int height)
protected void	doPaintIcon(java.awt.Graphics2D g, javax.swing.Icon icon, int offset)
protected int	doPaintText(java.awt.Graphics2D g, int textStart, boolean focusAroundIcon)
int	findFragmentAt(int x) Returns the index of text fragment at the specified X offset.
protected javax.swing.JLabel	formatToLabel(javax.swing.JLabel label)
javax.accessibility.AccessibleContext	getAccessibleContext()
protected java.awt.Color	getActiveTextColor(java.awt.Color attributesColor)
int	getBaseline(int width, int height)
java.lang.CharSequence	getCharSequence(boolean mainOnly)
java.lang.Object	getFragmentTag(int index)
java.lang.Object	getFragmentTagAt(int x)
javax.swing.Icon	getIcon()
int	getIconTextGap()
java.awt.Insets	getIpad()
protected int	getMinHeight()
java.awt.Dimension	getMinimumSize()
javax.swing.border.Border	getMyBorder()
java.awt.Dimension	getPreferredSize()
static int	getTextBaseLine(java.awt.FontMetrics metrics, int height)
boolean	isIconOnTheRight()
boolean	isIconOpaque()
boolean	isTransparentIconBackground()
SimpleColoredComponent.ColoredIterator	iterator()
SimpleColoredComponent.ColoredIterator	iterator(int fromIndex)
protected void	paintBackground(java.awt.Graphics2D g, int x, int width, int height)
protected void	paintComponent(java.awt.Graphics g)
protected void	paintIcon(java.awt.Graphics g, javax.swing.Icon icon, int offset)
protected void	setBorderInsets(java.awt.Insets insets)
protected void	setFocusBorderAroundIcon(boolean focusBorderAroundIcon) Sets whether focus border extends to icon or not.
void	setIcon(javax.swing.Icon icon) Sets a new component icon
void	setIconOnTheRight(boolean iconOnTheRight)
void	setIconOpaque(boolean iconOpaque)
void	setIconTextGap(int iconTextGap) Sets a new gap between icon and text
void	setIpad(java.awt.Insets ipad) Sets specified internal paddings
void	setMyBorder(javax.swing.border.Border border)
protected void	setPaintFocusBorder(boolean paintFocusBorder) Sets whether focus border is painted or not
void	setTextAlign(int align)
void	setTransparentIconBackground(boolean transparentIconBackground)
protected boolean	shouldDrawBackground()
protected boolean	shouldDrawDimmed()
protected boolean	shouldDrawMacShadow() Deprecated. and won't be used anymore
java.lang.String	toString()
void	updateUI()

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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

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, 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, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

FRAGMENT_ICON

public static final int FRAGMENT_ICON

See Also:

Constant Field Values

myIconTextGap

protected int myIconTextGap

Gap between icon and text. It is used only if icon is defined.

Constructor Detail

SimpleColoredComponent

public SimpleColoredComponent()

Method Detail

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.JComponent

iterator

public SimpleColoredComponent.ColoredIterator iterator()

iterator

public SimpleColoredComponent.ColoredIterator iterator(int fromIndex)

isIconOnTheRight

public boolean isIconOnTheRight()

setIconOnTheRight

public void setIconOnTheRight(boolean iconOnTheRight)

append

public final SimpleColoredComponent append(java.lang.String fragment)

append

public final void append(java.lang.String fragment,
                         SimpleTextAttributes attributes)

Appends string fragments to existing ones. Appended string will have specified attributes.

Parameters:

fragment - text fragment

attributes - text attributes

append

public final void append(java.lang.String fragment,
                         SimpleTextAttributes attributes,
                         int padding,
                         int align)

Appends text fragment and sets it's end offset and alignment. See SimpleColoredComponent#appendTextPadding for details

Parameters:

fragment - text fragment

attributes - text attributes

padding - end offset of the text

align - alignment between current offset and padding

append

public void append(java.lang.String fragment,
                   SimpleTextAttributes attributes,
                   boolean isMainText)

Appends string fragments to existing ones. Appended string will have specified attributes.

Parameters:

fragment - text fragment

attributes - text attributes

isMainText - main text of not

append

public void append(java.lang.String fragment,
                   SimpleTextAttributes attributes,
                   java.lang.Object tag)

appendTextPadding

public void appendTextPadding(int padding)

appendTextPadding

public void appendTextPadding(int padding,
                              int align)

Parameters:

padding - end offset that will be set after drawing current text fragment

align - alignment of the current text fragment, if it is SwingConstants.RIGHT or SwingConstants.TRAILING then the text fragment will be aligned to the right at the padding, otherwise it will be aligned to the left

setTextAlign

public void setTextAlign(int align)

clear

public void clear()

Clear all special attributes of SimpleColoredComponent. They are icon, text fragments and their attributes, "paint focus border".

getIcon

public final javax.swing.Icon getIcon()

Returns:

component's icon. This method returns null if there is no icon.

setIcon

public final void setIcon(javax.swing.Icon icon)

Sets a new component icon

Parameters:

icon - icon

getIpad

public java.awt.Insets getIpad()

Returns:

"leave" (internal) internal paddings of the component

setIpad

public void setIpad(java.awt.Insets ipad)

Sets specified internal paddings

Parameters:

ipad - insets

getIconTextGap

public int getIconTextGap()

Returns:

gap between icon and text

setIconTextGap

public void setIconTextGap(int iconTextGap)

Sets a new gap between icon and text

Parameters:

iconTextGap - the gap between text and icon

Throws:

java.lang.IllegalArgumentException - if the iconTextGap has a negative value

getMyBorder

public javax.swing.border.Border getMyBorder()

setMyBorder

public void setMyBorder(javax.swing.border.Border border)

setPaintFocusBorder

protected final void setPaintFocusBorder(boolean paintFocusBorder)

Sets whether focus border is painted or not

Parameters:

paintFocusBorder - true or false

setFocusBorderAroundIcon

protected final void setFocusBorderAroundIcon(boolean focusBorderAroundIcon)

Sets whether focus border extends to icon or not. If so then component also extends the selection.

Parameters:

focusBorderAroundIcon - true or false

isIconOpaque

public boolean isIconOpaque()

setIconOpaque

public void setIconOpaque(boolean iconOpaque)

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

getFragmentTag

public java.lang.Object getFragmentTag(int index)

computePreferredSize

public final java.awt.Dimension computePreferredSize(boolean mainTextOnly)

getMinHeight

protected int getMinHeight()

findFragmentAt

public int findFragmentAt(int x)

Returns the index of text fragment at the specified X offset.

Parameters:

x - the offset

Returns:

the index of the fragment, FRAGMENT_ICON if the icon is at the offset, or -1 if nothing is there.

getFragmentTagAt

public java.lang.Object getFragmentTagAt(int x)

formatToLabel

protected javax.swing.JLabel formatToLabel(javax.swing.JLabel label)

paintComponent

protected void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

doPaint

protected void doPaint(java.awt.Graphics2D g)

paintBackground

protected void paintBackground(java.awt.Graphics2D g,
                               int x,
                               int width,
                               int height)

doPaintIcon

protected void doPaintIcon(java.awt.Graphics2D g,
                           javax.swing.Icon icon,
                           int offset)

doPaintText

protected int doPaintText(java.awt.Graphics2D g,
                          int textStart,
                          boolean focusAroundIcon)

getActiveTextColor

protected java.awt.Color getActiveTextColor(java.awt.Color attributesColor)

doPaintFragmentBackground

protected void doPaintFragmentBackground(java.awt.Graphics2D g,
                                         int index,
                                         java.awt.Color bgColor,
                                         int x,
                                         int y,
                                         int width,
                                         int height)

shouldDrawMacShadow

@Deprecated
protected boolean shouldDrawMacShadow()

Deprecated. and won't be used anymore

shouldDrawDimmed

protected boolean shouldDrawDimmed()

shouldDrawBackground

protected boolean shouldDrawBackground()

paintIcon

protected void paintIcon(java.awt.Graphics g,
                         javax.swing.Icon icon,
                         int offset)

applyAdditionalHints

protected void applyAdditionalHints(java.awt.Graphics2D g)

getBaseline

public int getBaseline(int width,
                       int height)

Overrides:

getBaseline in class javax.swing.JComponent

isTransparentIconBackground

public boolean isTransparentIconBackground()

setTransparentIconBackground

public void setTransparentIconBackground(boolean transparentIconBackground)

getTextBaseLine

public static int getTextBaseLine(java.awt.FontMetrics metrics,
                                  int height)

setBorderInsets

protected void setBorderInsets(java.awt.Insets insets)

getCharSequence

public java.lang.CharSequence getCharSequence(boolean mainOnly)

toString

public java.lang.String toString()

Overrides:

toString in class java.awt.Component

change

public void change(java.lang.Runnable runnable,
                   boolean autoInvalidate)

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Overrides:

getAccessibleContext in class java.awt.Component