Class RenderEditable | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class RenderEditable

    Inheritance
    System.Object
    Diagnosticable
    DiagnosticableTree
    AbstractNodeMixinDiagnosticableTree
    RenderObject
    RenderBox
    RenderEditable
    Inherited Members
    RenderBox.setupParentData(RenderObject)
    RenderBox.getMinIntrinsicWidth(Single)
    RenderBox.getMaxIntrinsicWidth(Single)
    RenderBox.getMinIntrinsicHeight(Single)
    RenderBox.getMaxIntrinsicHeight(Single)
    RenderBox.hasSize
    RenderBox.size
    RenderBox.debugAdoptSize(Size)
    RenderBox.semanticBounds
    RenderBox.debugResetSize()
    RenderBox.getDistanceToBaseline(TextBaseline, Boolean)
    RenderBox.getDistanceToActualBaseline(TextBaseline)
    RenderBox.constraints
    RenderBox.debugAssertDoesMeetConstraints()
    RenderBox.markNeedsLayout()
    RenderBox.performResize()
    RenderBox.hitTest(HitTestResult, Offset)
    RenderBox.hitTestChildren(HitTestResult, Offset)
    RenderBox.applyPaintTransform(RenderObject, Matrix3)
    RenderBox.globalToLocal(Offset, RenderObject)
    RenderBox.localToGlobal(Offset, RenderObject)
    RenderBox.paintBounds
    RenderBox.debugHandleEvent(PointerEvent, HitTestEntry)
    RenderBox.debugPaint(PaintingContext, Offset)
    RenderBox.debugPaintSize(PaintingContext, Offset)
    RenderBox.debugPaintBaselines(PaintingContext, Offset)
    RenderBox.debugPaintPointers(PaintingContext, Offset)
    RenderObject.parentData
    RenderObject.adoptChild(AbstractNodeMixinDiagnosticableTree)
    RenderObject.dropChild(AbstractNodeMixinDiagnosticableTree)
    RenderObject.visitChildren(RenderObjectVisitor)
    RenderObject.debugCreator
    RenderObject.debugDoingThisResize
    RenderObject.debugDoingThisLayout
    RenderObject.debugActiveLayout
    RenderObject.debugCanParentUseSize
    RenderObject.owner
    RenderObject.debugNeedsLayout
    RenderObject._relayoutBoundary
    RenderObject.markParentNeedsLayout()
    RenderObject.markNeedsLayoutForSizedByParentChange()
    RenderObject.scheduleInitialLayout()
    RenderObject.layout(Constraints, Boolean)
    RenderObject.sizedByParent
    RenderObject.invokeLayoutCallback<T>(LayoutCallback<T>)
    RenderObject.debugDoingThisPaint
    RenderObject.debugActivePaint
    RenderObject.isRepaintBoundary
    RenderObject.debugRegisterRepaintBoundaryPaint(Boolean, Boolean)
    RenderObject.alwaysNeedsCompositing
    RenderObject.layer
    RenderObject.debugLayer
    RenderObject.markNeedsCompositingBitsUpdate()
    RenderObject.needsCompositing
    RenderObject._updateCompositingBits()
    RenderObject.markNeedsPaint()
    RenderObject.scheduleInitialPaint(ContainerLayer)
    RenderObject.replaceRootLayer(OffsetLayer)
    RenderObject.getTransformTo(RenderObject)
    RenderObject.toStringShort()
    RenderObject.toString(DiagnosticLevel)
    RenderObject.toStringDeep(String, String, DiagnosticLevel)
    RenderObject.toStringShallow(String, DiagnosticLevel)
    RenderObject.showOnScreen(RenderObject, Rect, Nullable<TimeSpan>, Curve)
    AbstractNodeMixinDiagnosticableTree.depth
    AbstractNodeMixinDiagnosticableTree.redepthChild(AbstractNodeMixinDiagnosticableTree)
    AbstractNodeMixinDiagnosticableTree.redepthChildren()
    AbstractNodeMixinDiagnosticableTree.attached
    AbstractNodeMixinDiagnosticableTree.parent
    DiagnosticableTree.toDiagnosticsNode(String, DiagnosticsTreeStyle)
    Diagnosticable.ToString()
    Namespace: Unity.UIWidgets.rendering
    Syntax
    public class RenderEditable : RenderBox, HitTestTarget

    Constructors

    RenderEditable(TextSpan, TextDirection, ViewportOffset, ValueNotifier<Boolean>, TextAlign, Single, Color, Color, Nullable<Boolean>, Nullable<Int32>, Color, TextSelection, Boolean, SelectionChangedHandler, CaretChangedHandler, Boolean, Single, Radius, Nullable<Boolean>, Boolean, Offset, Single, EdgeInsets, TextSelectionDelegate)

    Declaration
    public RenderEditable(TextSpan text, TextDirection textDirection, ViewportOffset offset, ValueNotifier<bool> showCursor, TextAlign textAlign = TextAlign.left, float textScaleFactor = 1F, Color cursorColor = null, Color backgroundCursorColor = null, bool? hasFocus = default(bool? ), int? maxLines, Color selectionColor = null, TextSelection selection = null, bool obscureText = false, SelectionChangedHandler onSelectionChanged = null, CaretChangedHandler onCaretChanged = null, bool ignorePointer = false, float cursorWidth = 1F, Radius cursorRadius = null, bool? enableInteractiveSelection = default(bool? ), bool paintCursorAboveText = false, Offset cursorOffset = null, float devicePixelRatio = 1F, EdgeInsets floatingCursorAddedMargin = null, TextSelectionDelegate textSelectionDelegate = null)
    Parameters
    Type Name Description
    TextSpan text
    TextDirection textDirection
    ViewportOffset offset
    ValueNotifier<System.Boolean> showCursor
    TextAlign textAlign
    System.Single textScaleFactor
    Color cursorColor
    Color backgroundCursorColor
    System.Nullable<System.Boolean> hasFocus
    System.Nullable<System.Int32> maxLines
    Color selectionColor
    TextSelection selection
    System.Boolean obscureText
    SelectionChangedHandler onSelectionChanged
    CaretChangedHandler onCaretChanged
    System.Boolean ignorePointer
    System.Single cursorWidth
    Radius cursorRadius
    System.Nullable<System.Boolean> enableInteractiveSelection
    System.Boolean paintCursorAboveText
    Offset cursorOffset
    System.Single devicePixelRatio
    EdgeInsets floatingCursorAddedMargin
    TextSelectionDelegate textSelectionDelegate

    Fields

    ignorePointer

    Declaration
    public bool ignorePointer
    Field Value
    Type Description
    System.Boolean

    obscuringCharacter

    Declaration
    public static readonly char obscuringCharacter
    Field Value
    Type Description
    System.Char

    onCaretChanged

    Declaration
    public CaretChangedHandler onCaretChanged
    Field Value
    Type Description
    CaretChangedHandler

    onSelectionChanged

    Declaration
    public SelectionChangedHandler onSelectionChanged
    Field Value
    Type Description
    SelectionChangedHandler

    textSelectionDelegate

    Declaration
    public TextSelectionDelegate textSelectionDelegate
    Field Value
    Type Description
    TextSelectionDelegate

    Properties

    backgroundCursorColor

    Declaration
    public Color backgroundCursorColor { get; set; }
    Property Value
    Type Description
    Color

    cursorColor

    Declaration
    public Color cursorColor { get; set; }
    Property Value
    Type Description
    Color

    cursorOffset

    Declaration
    public Offset cursorOffset { get; set; }
    Property Value
    Type Description
    Offset

    cursorRadius

    Declaration
    public Radius cursorRadius { get; set; }
    Property Value
    Type Description
    Radius

    cursorWidth

    Declaration
    public float cursorWidth { get; set; }
    Property Value
    Type Description
    System.Single

    devicePixelRatio

    Declaration
    public float devicePixelRatio { get; set; }
    Property Value
    Type Description
    System.Single

    enableInteractiveSelection

    Declaration
    public bool? enableInteractiveSelection { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Boolean>

    floatingCursorAddedMargin

    Declaration
    public EdgeInsets floatingCursorAddedMargin { get; set; }
    Property Value
    Type Description
    EdgeInsets

    hasFocus

    Declaration
    public bool hasFocus { get; set; }
    Property Value
    Type Description
    System.Boolean

    maxLines

    Declaration
    public int? maxLines { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int32>

    obscureText

    Declaration
    public bool obscureText { get; set; }
    Property Value
    Type Description
    System.Boolean

    offset

    Declaration
    public ViewportOffset offset { get; set; }
    Property Value
    Type Description
    ViewportOffset

    paintCursorAboveText

    Declaration
    public bool paintCursorAboveText { get; set; }
    Property Value
    Type Description
    System.Boolean

    preferredLineHeight

    Declaration
    public float preferredLineHeight { get; }
    Property Value
    Type Description
    System.Single

    selection

    Declaration
    public TextSelection selection { get; set; }
    Property Value
    Type Description
    TextSelection

    selectionColor

    Declaration
    public Color selectionColor { get; set; }
    Property Value
    Type Description
    Color

    selectionEnabled

    Declaration
    public bool selectionEnabled { get; }
    Property Value
    Type Description
    System.Boolean

    showCursor

    Declaration
    public ValueNotifier<bool> showCursor { get; set; }
    Property Value
    Type Description
    ValueNotifier<System.Boolean>

    text

    Declaration
    public TextSpan text { get; set; }
    Property Value
    Type Description
    TextSpan

    textAlign

    Declaration
    public TextAlign textAlign { get; set; }
    Property Value
    Type Description
    TextAlign

    textDirection

    Declaration
    public TextDirection? textDirection { get; set; }
    Property Value
    Type Description
    System.Nullable<TextDirection>

    textScaleFactor

    Declaration
    public float textScaleFactor { get; set; }
    Property Value
    Type Description
    System.Single

    Methods

    attach(Object)

    Declaration
    public override void attach(object ownerObject)
    Parameters
    Type Name Description
    System.Object ownerObject
    Overrides
    RenderObject.attach(Object)

    calculateBoundedFloatingCursorOffset(Offset)

    Declaration
    public Offset calculateBoundedFloatingCursorOffset(Offset rawCursorOffset)
    Parameters
    Type Name Description
    Offset rawCursorOffset
    Returns
    Type Description
    Offset

    computeDistanceToActualBaseline(TextBaseline)

    Declaration
    protected override float? computeDistanceToActualBaseline(TextBaseline baseline)
    Parameters
    Type Name Description
    TextBaseline baseline
    Returns
    Type Description
    System.Nullable<System.Single>
    Overrides
    RenderBox.computeDistanceToActualBaseline(TextBaseline)

    computeMaxIntrinsicHeight(Single)

    Declaration
    protected override float computeMaxIntrinsicHeight(float width)
    Parameters
    Type Name Description
    System.Single width
    Returns
    Type Description
    System.Single
    Overrides
    RenderBox.computeMaxIntrinsicHeight(Single)

    computeMaxIntrinsicWidth(Single)

    Declaration
    protected override float computeMaxIntrinsicWidth(float height)
    Parameters
    Type Name Description
    System.Single height
    Returns
    Type Description
    System.Single
    Overrides
    RenderBox.computeMaxIntrinsicWidth(Single)

    computeMinIntrinsicHeight(Single)

    Declaration
    protected override float computeMinIntrinsicHeight(float width)
    Parameters
    Type Name Description
    System.Single width
    Returns
    Type Description
    System.Single
    Overrides
    RenderBox.computeMinIntrinsicHeight(Single)

    computeMinIntrinsicWidth(Single)

    Declaration
    protected override float computeMinIntrinsicWidth(float height)
    Parameters
    Type Name Description
    System.Single height
    Returns
    Type Description
    System.Single
    Overrides
    RenderBox.computeMinIntrinsicWidth(Single)

    debugDescribeChildren()

    Declaration
    public override List<DiagnosticsNode> debugDescribeChildren()
    Returns
    Type Description
    System.Collections.Generic.List<DiagnosticsNode>
    Overrides
    DiagnosticableTree.debugDescribeChildren()

    debugFillProperties(DiagnosticPropertiesBuilder)

    Declaration
    public override void debugFillProperties(DiagnosticPropertiesBuilder properties)
    Parameters
    Type Name Description
    DiagnosticPropertiesBuilder properties
    Overrides
    RenderBox.debugFillProperties(DiagnosticPropertiesBuilder)

    describeApproximatePaintClip(RenderObject)

    Declaration
    public override Rect describeApproximatePaintClip(RenderObject child)
    Parameters
    Type Name Description
    RenderObject child
    Returns
    Type Description
    Rect
    Overrides
    RenderObject.describeApproximatePaintClip(RenderObject)

    detach()

    Declaration
    public override void detach()
    Overrides
    AbstractNodeMixinDiagnosticableTree.detach()

    getEndpointsForSelection(TextSelection)

    Declaration
    public List<TextSelectionPoint> getEndpointsForSelection(TextSelection selection)
    Parameters
    Type Name Description
    TextSelection selection
    Returns
    Type Description
    System.Collections.Generic.List<TextSelectionPoint>

    getLineEndPosition(TextPosition, Nullable<TextAffinity>)

    Declaration
    public TextPosition getLineEndPosition(TextPosition position, TextAffinity? affinity = default(TextAffinity? ))
    Parameters
    Type Name Description
    TextPosition position
    System.Nullable<TextAffinity> affinity
    Returns
    Type Description
    TextPosition

    getLineStartPosition(TextPosition, Nullable<TextAffinity>)

    Declaration
    public TextPosition getLineStartPosition(TextPosition position, TextAffinity? affinity = default(TextAffinity? ))
    Parameters
    Type Name Description
    TextPosition position
    System.Nullable<TextAffinity> affinity
    Returns
    Type Description
    TextPosition

    getLocalRectForCaret(TextPosition)

    Declaration
    public Rect getLocalRectForCaret(TextPosition caretPosition)
    Parameters
    Type Name Description
    TextPosition caretPosition
    Returns
    Type Description
    Rect

    getParagraphBackward(TextPosition, Nullable<TextAffinity>)

    Declaration
    public TextPosition getParagraphBackward(TextPosition position, TextAffinity? affinity = default(TextAffinity? ))
    Parameters
    Type Name Description
    TextPosition position
    System.Nullable<TextAffinity> affinity
    Returns
    Type Description
    TextPosition

    getParagraphEnd(TextPosition, Nullable<TextAffinity>)

    Declaration
    public TextPosition getParagraphEnd(TextPosition position, TextAffinity? affinity = default(TextAffinity? ))
    Parameters
    Type Name Description
    TextPosition position
    System.Nullable<TextAffinity> affinity
    Returns
    Type Description
    TextPosition

    getParagraphForward(TextPosition, Nullable<TextAffinity>)

    Declaration
    public TextPosition getParagraphForward(TextPosition position, TextAffinity? affinity = default(TextAffinity? ))
    Parameters
    Type Name Description
    TextPosition position
    System.Nullable<TextAffinity> affinity
    Returns
    Type Description
    TextPosition

    getParagraphStart(TextPosition, Nullable<TextAffinity>)

    Declaration
    public TextPosition getParagraphStart(TextPosition position, TextAffinity? affinity = default(TextAffinity? ))
    Parameters
    Type Name Description
    TextPosition position
    System.Nullable<TextAffinity> affinity
    Returns
    Type Description
    TextPosition

    getPositionDown(TextPosition)

    Declaration
    public TextPosition getPositionDown(TextPosition position)
    Parameters
    Type Name Description
    TextPosition position
    Returns
    Type Description
    TextPosition

    getPositionForPoint(Offset)

    Declaration
    public TextPosition getPositionForPoint(Offset globalPosition)
    Parameters
    Type Name Description
    Offset globalPosition
    Returns
    Type Description
    TextPosition

    getPositionUp(TextPosition)

    Declaration
    public TextPosition getPositionUp(TextPosition position)
    Parameters
    Type Name Description
    TextPosition position
    Returns
    Type Description
    TextPosition

    getWordLeft(TextPosition)

    Declaration
    public TextPosition getWordLeft(TextPosition position)
    Parameters
    Type Name Description
    TextPosition position
    Returns
    Type Description
    TextPosition

    getWordRight(TextPosition)

    Declaration
    public TextPosition getWordRight(TextPosition position)
    Parameters
    Type Name Description
    TextPosition position
    Returns
    Type Description
    TextPosition

    handleDoubleTap(DoubleTapDetails)

    Declaration
    public void handleDoubleTap(DoubleTapDetails details)
    Parameters
    Type Name Description
    DoubleTapDetails details

    handleEvent(PointerEvent, HitTestEntry)

    Declaration
    public override void handleEvent(PointerEvent evt, HitTestEntry entry)
    Parameters
    Type Name Description
    PointerEvent evt
    HitTestEntry entry
    Overrides
    RenderObject.handleEvent(PointerEvent, HitTestEntry)

    handleLongPress()

    Declaration
    public void handleLongPress()

    handleTap()

    Declaration
    public void handleTap()

    handleTapDown(TapDownDetails)

    Declaration
    public void handleTapDown(TapDownDetails details)
    Parameters
    Type Name Description
    TapDownDetails details

    hitTestSelf(Offset)

    Declaration
    protected override bool hitTestSelf(Offset position)
    Parameters
    Type Name Description
    Offset position
    Returns
    Type Description
    System.Boolean
    Overrides
    RenderBox.hitTestSelf(Offset)

    isLineEndOrStart(Int32)

    Declaration
    public bool isLineEndOrStart(int offset)
    Parameters
    Type Name Description
    System.Int32 offset
    Returns
    Type Description
    System.Boolean

    markNeedsTextLayout()

    Declaration
    protected void markNeedsTextLayout()

    paint(PaintingContext, Offset)

    Declaration
    public override void paint(PaintingContext context, Offset offset)
    Parameters
    Type Name Description
    PaintingContext context
    Offset offset
    Overrides
    RenderObject.paint(PaintingContext, Offset)

    performLayout()

    Declaration
    protected override void performLayout()
    Overrides
    RenderBox.performLayout()

    selectPositionAt(Offset, Offset, Nullable<SelectionChangedCause>)

    Declaration
    public void selectPositionAt(Offset from = null, Offset to = null, SelectionChangedCause? cause = default(SelectionChangedCause? ))
    Parameters
    Type Name Description
    Offset from
    Offset to
    System.Nullable<SelectionChangedCause> cause

    setFloatingCursor(Nullable<FloatingCursorDragState>, Offset, TextPosition, Nullable<Single>)

    Declaration
    public void setFloatingCursor(FloatingCursorDragState? state, Offset boundedOffset, TextPosition lastTextPosition, float? resetLerpValue = default(float? ))
    Parameters
    Type Name Description
    System.Nullable<FloatingCursorDragState> state
    Offset boundedOffset
    TextPosition lastTextPosition
    System.Nullable<System.Single> resetLerpValue
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023