Класс CodeArea
java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
jfx.incubator.scene.control.richtext.RichTextArea
jfx.incubator.scene.control.richtext.CodeArea
- Все реализованные интерфейсы:
-
Styleable,EventTarget,Skinnable
public class CodeArea extends RichTextArea
CodeArea — это редактируемый текстовый компонент, который поддерживает форматирование (например, подсветку синтаксиса) простого текста.
В отличие от своего базового класса RichTextArea, для использования CodeArea требуется особый тип модели, CodeTextModel.
Создание CodeArea
Следующий пример создаёт редактируемый компонент с дефолтнойCodeArea: CodeArea codeArea = new CodeArea();
codeArea.setWrapText(true);
codeArea.setLineNumbersEnabled(true);
codeArea.setText("Lorem\nIpsum");
Рекомендации по использованию
CodeArea расширяет класс RichTextArea, что означает, что большая часть функциональности работает так же, как и в базовом классе. Есть некоторые отличия, которые следует упомянуть: - Поведение модели: любые прямые изменения в форматировании, такие как
applyStyle(), будут проигнорированы - Номера строк:
CodeAreaустанавливаетRichTextArea.leftDecoratorProperty()для поддержки номеров строк, поэтому приложения не должны устанавливать или привязывать эту собственность.
- С:
- 24
Краткое описание вложенных классов
Вложенные классы/интерфейсы, объявленные в классе jfx.incubator.scene.control.richtext.RichTextArea
RichTextArea.Tag
Краткое описание свойств
| Тип | Свойство | Описание |
|---|---|---|
final ObjectProperty |
font |
Шрифт, используемый для текста в CodeArea. |
final BooleanProperty |
lineNumbersEnabled |
Определяет, отображать ли номера строк. |
final DoubleProperty |
lineSpacing |
Определяет вертикальное расстояние в пикселях между строками. |
final IntegerProperty |
tabSize |
Размер отступа табуляции в пробелах. |
Свойства, объявленные в классе jfx.incubator.scene.control.richtext.RichTextArea
anchorPosition, caretBlinkPeriod, caretPosition, contentPadding, displayCaret, editable, highlightCurrentParagraph, leftDecorator, model, redoable, rightDecorator, selection, undoable, useContentHeight, useContentWidth, wrapText
Свойства, объявленные в классе javafx.scene.control.Control
contextMenu, skin, tooltip
Свойства, объявленные в классе javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
Свойства, объявленные в классе javafx.scene.Parent
needsLayout
Свойства, объявленные в классе javafx.scene.Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible
Краткое описание полей
Поля, объявленные в классе jfx.incubator.scene.control.richtext.RichTextArea
styleHandlerRegistry
Поля, объявленные в классе javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE
Поля, объявленные в классе javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
CodeArea() |
Этот конструктор создает CodeArea с по умолчанию CodeTextModel. |
CodeArea |
Этот конструктор создает CodeArea со специфицированным CodeTextModel. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
final ObjectProperty |
fontProperty() |
Шрифт, используемый для текста в CodeArea. |
static List |
getClassCssMetaData() |
Получает CssMetaData, связанное с этим классом, который может включать CssMetaData своих суперклассов. |
final Font |
getFont() |
Получает значение свойства font. |
final double |
getLineSpacing() |
Получает значение свойства lineSpacing. |
final SyntaxDecorator |
getSyntaxDecorator() |
Этот вспомогательный метод возвращает значение декоратора синтаксиса в CodeTextModel, или null, если модель равна null. |
final int |
getTabSize() |
Получает значение свойства tabSize. |
final String |
getText() |
Возвращает обычный текст. |
final boolean |
isLineNumbersEnabled() |
Получает значение свойства lineNumbersEnabled. |
final BooleanProperty |
lineNumbersEnabledProperty() |
Определяет, отображать ли номера строк. |
final DoubleProperty |
lineSpacingProperty() |
Определяет вертикальное расстояние в пикселях между строками. |
final void |
setFont |
Устанавливает значение свойства font. |
final void |
setLineNumbersEnabled |
Устанавливает значение свойства lineNumbersEnabled. |
final void |
setLineSpacing |
Устанавливает значение свойства lineSpacing. |
final void |
setSyntaxDecorator |
Этот вспомогательный метод устанавливает свойство декоратора в CodeTextModel. |
final void |
setTabSize |
Устанавливает значение свойства tabSize. |
final void |
setText |
Заменяет текст в этом CodeArea. |
final IntegerProperty |
tabSizeProperty() |
Размер отступа табуляции в пробелах. |
Методы, объявленные в классе jfx.incubator.scene.control.richtext.RichTextArea
anchorPositionProperty, appendText, appendText, appendText, applyStyle, backspace, caretBlinkPeriodProperty, caretPositionProperty, clear, clearSelection, clearUndoRedo, contentPaddingProperty, copy, copy, createDefaultSkin, cut, delete, deleteParagraph, deleteParagraphStart, deleteWordNextEnd, deleteWordNextStart, deleteWordPrevious, deselect, displayCaretProperty, editableProperty, errorFeedback, execute, executeDefault, extendSelection, getActiveStyleAttributeMap, getAnchorPosition, getCaretBlinkPeriod, getCaretPosition, getContentPadding, getControlCssMetaData, getDocumentEnd, getInputMap, getLeftDecorator, getModel, getParagraphCount, getParagraphEnd, getPlainText, getRightDecorator, getSelection, getStyleHandlerRegistry, getTextPosition, hasNonEmptySelection, highlightCurrentParagraphProperty, insertLineBreak, insertTab, insertText, insertText, isDisplayCaret, isEditable, isHighlightCurrentParagraph, isRedoable, isUndoable, isUseContentHeight, isUseContentWidth, isWrapText, leftDecoratorProperty, modelProperty, moveDocumentEnd, moveDocumentStart, moveDown, moveLeft, moveLineEnd, moveLineStart, moveParagraphDown, moveParagraphEnd, moveParagraphStart, moveParagraphUp, moveRight, moveUp, moveWordLeft, moveWordNextEnd, moveWordNextStart, moveWordPrevious, moveWordRight, pageDown, pageUp, paste, paste, pastePlainText, read, read, redo, redoableProperty, replaceText, replaceText, rightDecoratorProperty, select, select, selectAll, selectDown, selectionProperty, selectLeft, selectPageDown, selectPageUp, selectParagraph, selectParagraphDown, selectParagraphEnd, selectParagraphStart, selectParagraphUp, selectRight, selectToDocumentEnd, selectToDocumentStart, selectToLineEnd, selectToLineStart, selectUp, selectWord, selectWordLeft, selectWordNextEnd, selectWordNextStart, selectWordPrevious, selectWordRight, setCaretBlinkPeriod, setContentPadding, setDisplayCaret, setEditable, setHighlightCurrentParagraph, setLeftDecorator, setModel, setRightDecorator, setStyle, setUseContentHeight, setUseContentWidth, setWrapText, undo, undoableProperty, useContentHeightProperty, useContentWidthProperty, validateModel, wrapTextProperty, write, write
Методы, объявленные в классе javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, contextMenuProperty, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
Методы, объявленные в классе javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computePrefHeight, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
Методы, объявленные в классе javafx.scene.Parent
getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
Методы, объявленные в классе javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, requestFocusTraversal, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
Методы, объявленные в классе java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Методы, объявленные в интерфейсе javafx.css.Styleable
getStyleableNode
Подробное описание свойств
lineNumbersEnabled
public final BooleanProperty lineNumbersEnabledProperty
Определяет, следует ли отображать номера строк. Переключение этого свойства приводит к изменениям в свойстве
leftDecorator, поэтому код приложения не должен привязываться к этому свойству или его изменять.- Значение по умолчанию:
- false
- См. также:
tabSize
public final IntegerProperty tabSizeProperty
Размер отступа табуляции в пробелах. Значения меньше 1 обрабатываются как 1.
- Значение по умолчанию:
- 8
- См. также:
font
public final ObjectProperty<Font> fontProperty
Шрифт, используемый для текста в
CodeArea.- Значение по умолчанию:
- шрифт Monospaced с размером по умолчанию
- См. также:
lineSpacing
public final DoubleProperty lineSpacingProperty
Определяет вертикальное расстояние в пикселях между строками.
- Значение по умолчанию:
- 0
- См. также:
Подробное описание конструкторов
CodeArea
public CodeArea(CodeTextModel model)
Этот конструктор создает CodeArea с указанной моделью
CodeTextModel.- Параметры:
-
model- экземплярCodeTextModelдля использования
CodeArea
public CodeArea()
Этот конструктор создает CodeArea с моделью по умолчанию
CodeTextModel.Подробное описание методов
setSyntaxDecorator
public final void setSyntaxDecorator(SyntaxDecorator d)
Этот вспомогательный метод устанавливает свойство декоратора в
CodeTextModel. Ничего не делается, если модель равна null.- Параметры:
-
d- декоратор синтаксиса - См. также:
getSyntaxDecorator
public final SyntaxDecorator getSyntaxDecorator()
Этот вспомогательный метод возвращает значение декоратора синтаксиса в
CodeTextModel или null, если модель равна null.- Возвращает:
- значение декоратора синтаксиса или null
lineNumbersEnabledProperty
public final BooleanProperty lineNumbersEnabledProperty()
Определяет, следует ли отображать номера строк. Переключение этого свойства приводит к изменениям в свойстве
leftDecorator, поэтому код приложения не должен привязываться к этому свойству или его изменять.- Значение по умолчанию:
- false
- Возвращает:
- свойство, определяющее, включены ли номера строк
- См. также:
isLineNumbersEnabled
public final boolean isLineNumbersEnabled()
Получает значение свойства
lineNumbersEnabled.- Описание свойства:
- Определяет, следует ли отображать номера строк. Переключение этого свойства приводит к изменениям в свойстве
leftDecorator, поэтому код приложения не должен привязываться к этому свойству или его изменять. - Значение по умолчанию:
- false
- Возвращает:
- значение свойства
lineNumbersEnabled - См. также:
setLineNumbersEnabled
public final void setLineNumbersEnabled(boolean on)
Устанавливает значение свойства
lineNumbersEnabled.- Описание свойства:
- Определяет, следует ли отображать номера строк. Переключение этого свойства приводит к изменениям в свойстве
leftDecorator, поэтому код приложения не должен привязываться к этому свойству или его изменять. - Значение по умолчанию:
- false
- Параметры:
-
on- значение для свойстваlineNumbersEnabled - См. также:
tabSizeProperty
public final IntegerProperty tabSizeProperty()
Размер отступа табуляции в пробелах. Значения меньше 1 обрабатываются как 1.
- Значение по умолчанию:
- 8
- Возвращает:
- свойство размера табуляции
- См. также:
getTabSize
public final int getTabSize()
Получает значение свойства
tabSize.- Описание свойства:
- Размер отступа табуляции в пробелах. Значения меньше 1 обрабатываются как 1.
- Значение по умолчанию:
- 8
- Возвращает:
- значение свойства
tabSize - См. также:
setTabSize
public final void setTabSize(int spaces)
Устанавливает значение свойства
tabSize.- Описание свойства:
- Размер отступа табуляции в пробелах. Значения меньше 1 обрабатываются как 1.
- Значение по умолчанию:
- 8
- Параметры:
-
spaces- значение для свойстваtabSize - См. также:
fontProperty
public final ObjectProperty<Font> fontProperty()
Шрифт, используемый для текста в
CodeArea.- Значение по умолчанию:
- шрифт Monospaced с размером по умолчанию
- Возвращает:
- свойство шрифта
- См. также:
setFont
public final void setFont(Font value)
Устанавливает значение свойства
font.- Описание свойства:
- Шрифт, используемый для текста в
CodeArea. - Значение по умолчанию:
- шрифт Monospaced с размером по умолчанию
- Параметры:
-
value- значение для свойстваfont - См. также:
getFont
public final Font getFont()
Получает значение свойства
font.- Описание свойства:
- Шрифт, используемый для текста в
CodeArea. - Значение по умолчанию:
- шрифт Monospaced с размером по умолчанию
- Возвращает:
- значение свойства
font - См. также:
lineSpacingProperty
public final DoubleProperty lineSpacingProperty()
Определяет вертикальное расстояние в пикселях между строками.
- Значение по умолчанию:
- 0
- Возвращает:
- экземпляр свойства
- См. также:
setLineSpacing
public final void setLineSpacing(double spacing)
Устанавливает значение свойства
lineSpacing.- Описание свойства:
- Определяет вертикальное расстояние в пикселях между строками.
- Значение по умолчанию:
- 0
- Параметры:
-
spacing- значение для свойстваlineSpacing - См. также:
getLineSpacing
public final double getLineSpacing()
Получает значение свойства
lineSpacing.- Описание свойства:
- Определяет вертикальное расстояние в пикселях между строками.
- Значение по умолчанию:
- 0
- Возвращает:
- значение свойства
lineSpacing - См. также:
getClassCssMetaData
public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
Получает метаданные CSS, связанные с этим классом, которые могут включать метаданные CSS его суперклассов.
- Возвращает:
- метаданные CSS
getText
public final String getText()
Возвращает обычный текст. Этот метод возвращает пустую строку, когда модель
null.- Возвращает:
- обычный текст
setText
public final void setText(String text)
Заменяет текст в этом CodeArea.
Курсор сбрасывается в начало документа, выделение очищается, и создается событие отмены.
- Параметры:
-
text- строка текста
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
