@UnstableApi
class Cue.Builder


A builder for Cue objects.

Summary

Public constructors

Public functions

Cue!

Build the cue.

Cue.Builder!

Sets windowColorSet to false.

Boolean

Returns true if the fill color of the window is set.

Cue.Builder!

Sets the position of the cue box within the viewport in the direction orthogonal to the writing direction.

Cue.Builder!

Sets the multi-row alignment of the cue.

Cue.Builder!

Sets the shear angle for this Cue.

Cue.Builder!

Sets the default text size and type for this cue's text.

Public constructors

Builder

Builder()

Public functions

build

fun build(): Cue!

Build the cue.

clearWindowColor

@CanIgnoreReturnValue
fun clearWindowColor(): Cue.Builder!

Sets windowColorSet to false.

isWindowColorSet

fun isWindowColorSet(): Boolean

Returns true if the fill color of the window is set.

See also
windowColorSet

setLine

@CanIgnoreReturnValue
fun setLine(line: Float, @Cue.LineType lineType: Int): Cue.Builder!

Sets the position of the cue box within the viewport in the direction orthogonal to the writing direction.

See also
line
lineType

setMultiRowAlignment

@CanIgnoreReturnValue
fun setMultiRowAlignment(multiRowAlignment: Layout.Alignment?): Cue.Builder!

Sets the multi-row alignment of the cue.

Passing null means the alignment is undefined.

setShearDegrees

@CanIgnoreReturnValue
fun setShearDegrees(shearDegrees: Float): Cue.Builder!

Sets the shear angle for this Cue.

setTextSize

@CanIgnoreReturnValue
fun setTextSize(textSize: Float, @Cue.TextSizeType textSizeType: Int): Cue.Builder!

Sets the default text size and type for this cue's text.

Public properties

bitmap

var bitmapBitmap?

bitmapHeight

var bitmapHeightFloat

line

val lineFloat

lineAnchor

@Cue.AnchorType
var lineAnchorInt

lineType

@Cue.LineType
val lineTypeInt

position

var positionFloat

positionAnchor

@Cue.AnchorType
var positionAnchorInt

size

var sizeFloat

text

var textCharSequence?

textAlignment

var textAlignmentLayout.Alignment?

textSize

val textSizeFloat

textSizeType

@Cue.TextSizeType
val textSizeTypeInt

verticalType

@Cue.VerticalType
var verticalTypeInt

windowColor

var windowColor: @ColorInt Int