nutrient/com.pspdfkit.ui.inspector.views/BorderStylePreset

BorderStylePreset

open class BorderStylePreset

Preset for border styles. Encapsulates both BorderStyle and dash array used for DASHED.

Constructors

BorderStylePreset

constructor(@NonNull style: BorderStyle)

Creates preset with border style style and null dash array.

constructor(@NonNull style: BorderStyle, @Nullable dashArray: List<Integer>)

Creates preset with border style style and dash array dashArray.

constructor(@NonNull borderStyle: BorderStyle, @NonNull borderEffect: BorderEffect, @Nullable dashArray: List<Integer>)

Creates preset with border style borderStyle, border effect borderEffect and dash array dashArray.

constructor(@NonNull borderStyle: BorderStyle, @NonNull borderEffect: BorderEffect, @FloatRange(from = 0.0) borderEffectIntensity: Float, @Nullable dashArray: List<Integer>)

Creates preset with border style borderStyle, border effect borderEffect and dash array dashArray.

Properties

borderEffect

@NonNull

@get:NonNull

val borderEffect: BorderEffect

The border effect (cloudy, no effect) applied to this preset.

borderEffectIntensity

@FloatRange(from = 0.0)

@get:FloatRange(from = 0.0)

val borderEffectIntensity: Float

The intensity of the border effect (used for cloudy borders).

borderStyle

@NonNull

@get:NonNull

val borderStyle: BorderStyle

The border style (solid, dashed, none, etc.) for this preset.

CLOUDY

@NonNull

val CLOUDY: BorderStylePreset

Cloudy line border.

dashArray

@Nullable

@get:Nullable

val dashArray: List<Integer>

The dash array pattern for dashed borders, or null for non-dashed styles.

DASHED_1_1

@NonNull

val DASHED_1_1: BorderStylePreset

Dashed line border with a 1:1 dash-to-gap ratio (fine dashes).

DASHED_1_3

@NonNull

val DASHED_1_3: BorderStylePreset

Dashed line border with a 1:3 dash-to-gap ratio (short dashes with larger gaps).

DASHED_3_3

@NonNull

val DASHED_3_3: BorderStylePreset

Dashed line border with a 3:3 dash-to-gap ratio (medium dashes).

DASHED_6_6

@NonNull

val DASHED_6_6: BorderStylePreset

Dashed line border with a 6:6 dash-to-gap ratio (large dashes).

NONE

@NonNull

val NONE: BorderStylePreset

No border.

SOLID

@NonNull

val SOLID: BorderStylePreset

Solid line border.

Functions

equals

open fun equals(o: Any): Boolean

Compares this border style preset with the specified object for equality.

hasBorder

open fun hasBorder(): Boolean

Returns whether border style preset represents a border.

hashCode

open fun hashCode(): Int

Returns a hash code value for this border style preset.

BorderStylePreset

See also

Constructors

Properties

Functions