Package com.intellij.ui

Class EditorTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.intellij.ui.components.panels.Wrapper

com.intellij.ui.components.panels.NonOpaquePanel

com.intellij.ui.EditorTextField

All Implemented Interfaces:

DataProvider, DocumentListener, NullableComponent, EditorTextComponent, java.awt.event.FocusListener, java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

ComboboxEditorTextField, LanguageTextField, MethodSignatureComponent, TextViewer

public class EditorTextField
extends NonOpaquePanel
implements EditorTextComponent, DocumentListener, DataProvider, java.awt.event.FocusListener, java.awt.event.MouseListener

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.ui.components.panels.Wrapper

Wrapper.North

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

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

Nested classes/interfaces inherited from interface com.intellij.openapi.ui.NullableComponent

NullableComponent.Check

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	SUPPLEMENTARY_KEY

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 com.intellij.openapi.editor.event.DocumentListener

ARRAY_FACTORY, EMPTY_ARRAY

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
EditorTextField()
EditorTextField(Document document, Project project, FileType fileType)
EditorTextField(Document document, Project project, FileType fileType, boolean isViewer)
EditorTextField(Document document, Project project, FileType fileType, boolean isViewer, boolean oneLineMode)
EditorTextField(Project project, FileType fileType)
EditorTextField(java.lang.String text)
EditorTextField(java.lang.String text, Project project, FileType fileType)

Method Summary

Modifier and Type	Method and Description
void	addDocumentListener(DocumentListener listener)
void	addFocusListener(java.awt.event.FocusListener l)
protected void	addImpl(java.awt.Component comp, java.lang.Object constraints, int index)
void	addMouseListener(java.awt.event.MouseListener l)
void	addNotify()
void	addSettingsProvider(EditorSettingsProvider provider)
void	beforeDocumentChange(DocumentEvent event) Called before the text of the document is changed.
protected Document	createDocument()
protected EditorEx	createEditor()
void	documentChanged(DocumentEvent event) Called after the text of the document has been changed.
void	ensureWillComputePreferredSize()
void	focusGained(java.awt.event.FocusEvent e)
void	focusLost(java.awt.event.FocusEvent e)
java.awt.Color	getBackground()
CaretModel	getCaretModel()
javax.swing.JComponent	getComponent()
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
Document	getDocument()
Editor	getEditor()
FileType	getFileType()
javax.swing.JComponent	getFocusTarget()
java.awt.Dimension	getMinimumSize()
java.awt.Component	getNextFocusableComponent()
java.awt.Dimension	getPreferredSize()
Project	getProject()
java.lang.String	getText()
boolean	isFocusOwner()
protected boolean	isOneLineMode() This option will be used for embedded editor creation.
boolean	isViewer()
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
protected boolean	processKeyBinding(javax.swing.KeyStroke ks, java.awt.event.KeyEvent e, int condition, boolean pressed)
void	removeDocumentListener(DocumentListener listener)
void	removeFocusListener(java.awt.event.FocusListener l)
void	removeMouseListener(java.awt.event.MouseListener l)
void	removeNotify()
void	removeSelection()
boolean	removeSettingsProvider(EditorSettingsProvider provider)
void	requestFocus()
boolean	requestFocusInWindow()
void	selectAll()
void	setAsRendererWithSelection(java.awt.Color backgroundColor, java.awt.Color foregroundColor)
void	setBackground(java.awt.Color bg)
void	setCaretPosition(int position)
void	setDocument(Document document)
void	setEnabled(boolean enabled)
void	setFileType(FileType fileType)
void	setFont(java.awt.Font font)
void	setFontInheritedFromLAF(boolean b)
void	setNewDocumentAndFileType(FileType fileType, Document document)
void	setNextFocusableComponent(java.awt.Component aComponent)
void	setOneLineMode(boolean oneLineMode)
void	setPlaceholder(java.lang.CharSequence text) Allows to define editor's placeholder.
void	setPreferredWidth(int preferredWidth)
void	setSupplementary(boolean supplementary)
void	setText(java.lang.String text)
protected void	setupBorder(EditorEx editor)
static void	setupTextFieldEditor(EditorEx editor)
protected void	setViewerEnabled(boolean enabled)
protected boolean	shouldHaveBorder()
protected void	updateBorder(EditorEx editor)

Methods inherited from class com.intellij.ui.components.panels.NonOpaquePanel

setOpaque, setTransparent

Methods inherited from class com.intellij.ui.components.panels.Wrapper

getTargetComponent, isNull, requestFocus, requestFocusInternal, setContent, setHorizontalSizeReferent, setVerticalSizeReferent

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, 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, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.editor.event.DocumentListener

bulkUpdateFinished, bulkUpdateStarting

Field Detail

SUPPLEMENTARY_KEY

public static final Key<java.lang.Boolean> SUPPLEMENTARY_KEY

Constructor Detail

EditorTextField

public EditorTextField()

EditorTextField

public EditorTextField(java.lang.String text)

EditorTextField

public EditorTextField(java.lang.String text,
                       Project project,
                       FileType fileType)

EditorTextField

public EditorTextField(Document document,
                       Project project,
                       FileType fileType)

EditorTextField

public EditorTextField(Project project,
                       FileType fileType)

EditorTextField

public EditorTextField(Document document,
                       Project project,
                       FileType fileType,
                       boolean isViewer)

EditorTextField

public EditorTextField(Document document,
                       Project project,
                       FileType fileType,
                       boolean isViewer,
                       boolean oneLineMode)

Method Detail

setSupplementary

public void setSupplementary(boolean supplementary)

setFontInheritedFromLAF

public void setFontInheritedFromLAF(boolean b)

getText

public java.lang.String getText()

Specified by:

getText in interface EditorTextComponent

setBackground

public void setBackground(java.awt.Color bg)

Overrides:

setBackground in class javax.swing.JComponent

getComponent

public javax.swing.JComponent getComponent()

Specified by:

getComponent in interface EditorTextComponent

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Specified by:

addDocumentListener in interface EditorTextComponent

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Specified by:

removeDocumentListener in interface EditorTextComponent

beforeDocumentChange

public void beforeDocumentChange(DocumentEvent event)

Description copied from interface: DocumentListener

Called before the text of the document is changed.

Specified by:

beforeDocumentChange in interface DocumentListener

Parameters:

event - the event containing the information about the change.

documentChanged

public void documentChanged(DocumentEvent event)

Description copied from interface: DocumentListener

Called after the text of the document has been changed.

Specified by:

documentChanged in interface DocumentListener

Parameters:

event - the event containing the information about the change.

getProject

public Project getProject()

getDocument

public Document getDocument()

Specified by:

getDocument in interface EditorTextComponent

setDocument

public void setDocument(Document document)

setText

public void setText(java.lang.String text)

setPlaceholder

public void setPlaceholder(java.lang.CharSequence text)

Allows to define editor's placeholder. The trick here is that the editor is instantiated lazily by the editor text field and provided placeholder text is applied to the editor during its actual construction then.

Parameters:

text - editor's placeholder text to use

selectAll

public void selectAll()

removeSelection

public void removeSelection()

setCaretPosition

public void setCaretPosition(int position)

See Also:

JTextComponent.setCaretPosition(int)

getCaretModel

public CaretModel getCaretModel()

isFocusOwner

public boolean isFocusOwner()

Overrides:

isFocusOwner in class java.awt.Component

addNotify

public void addNotify()

Overrides:

addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class javax.swing.JComponent

setFont

public void setFont(java.awt.Font font)

Overrides:

setFont in class javax.swing.JComponent

isOneLineMode

protected boolean isOneLineMode()

This option will be used for embedded editor creation. It's ok to override this method if you don't want to configure it using class constructor

Returns:

is one line mode or not

setOneLineMode

public void setOneLineMode(boolean oneLineMode)

createDocument

protected Document createDocument()

createEditor

protected EditorEx createEditor()

setupTextFieldEditor

public static void setupTextFieldEditor(EditorEx editor)

updateBorder

protected void updateBorder(EditorEx editor)

setupBorder

protected void setupBorder(EditorEx editor)

shouldHaveBorder

protected boolean shouldHaveBorder()

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class javax.swing.JComponent

setViewerEnabled

protected void setViewerEnabled(boolean enabled)

isViewer

public boolean isViewer()

getBackground

public java.awt.Color getBackground()

Overrides:

getBackground in class java.awt.Component

addImpl

protected void addImpl(java.awt.Component comp,
                       java.lang.Object constraints,
                       int index)

Overrides:

addImpl in class java.awt.Container

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class Wrapper

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

setPreferredWidth

public void setPreferredWidth(int preferredWidth)

getNextFocusableComponent

public java.awt.Component getNextFocusableComponent()

Overrides:

getNextFocusableComponent in class javax.swing.JComponent

setNextFocusableComponent

public void setNextFocusableComponent(java.awt.Component aComponent)

Overrides:

setNextFocusableComponent in class javax.swing.JComponent

processKeyBinding

protected boolean processKeyBinding(javax.swing.KeyStroke ks,
                                    java.awt.event.KeyEvent e,
                                    int condition,
                                    boolean pressed)

Overrides:

processKeyBinding in class javax.swing.JComponent

requestFocus

public void requestFocus()

Overrides:

requestFocus in class Wrapper

requestFocusInWindow

public boolean requestFocusInWindow()

Overrides:

requestFocusInWindow in class Wrapper

getEditor

public Editor getEditor()

Returns:

null if the editor is not initialized (e.g. if the field is not added to a container)

See Also:

createEditor(), addNotify()

getFileType

public FileType getFileType()

getFocusTarget

public javax.swing.JComponent getFocusTarget()

addFocusListener

public void addFocusListener(java.awt.event.FocusListener l)

Overrides:

addFocusListener in class java.awt.Component

removeFocusListener

public void removeFocusListener(java.awt.event.FocusListener l)

Overrides:

removeFocusListener in class java.awt.Component

focusGained

public void focusGained(java.awt.event.FocusEvent e)

Specified by:

focusGained in interface java.awt.event.FocusListener

focusLost

public void focusLost(java.awt.event.FocusEvent e)

Specified by:

focusLost in interface java.awt.event.FocusListener

addMouseListener

public void addMouseListener(java.awt.event.MouseListener l)

Overrides:

addMouseListener in class java.awt.Component

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener l)

Overrides:

removeMouseListener in class java.awt.Component

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

getData

public java.lang.Object getData(java.lang.String dataId)

Description copied from interface: DataProvider

Returns the object corresponding to the specified data identifier. Some of the supported data identifiers are defined in the PlatformDataKeys class.

Specified by:

getData in interface DataProvider

Parameters:

dataId - the data identifier for which the value is requested.

Returns:

the value, or null if no value is available in the current context for this identifier.

setFileType

public void setFileType(FileType fileType)

setNewDocumentAndFileType

public void setNewDocumentAndFileType(FileType fileType,
                                      Document document)

ensureWillComputePreferredSize

public void ensureWillComputePreferredSize()

setAsRendererWithSelection

public void setAsRendererWithSelection(java.awt.Color backgroundColor,
                                       java.awt.Color foregroundColor)

addSettingsProvider

public void addSettingsProvider(EditorSettingsProvider provider)

removeSettingsProvider

public boolean removeSettingsProvider(EditorSettingsProvider provider)