public class

BorderStylePreset

extends Object
java.lang.Object
   ↳ com.pspdfkit.ui.inspector.views.BorderStylePreset

Class Overview

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

Summary

Fields
public static final BorderStylePreset CLOUDY Cloudy line border.
public static final BorderStylePreset NONE No border.
public static final BorderStylePreset SOLID Solid line border.
Public Constructors
BorderStylePreset(BorderStyle style)
Creates preset with border style style and null dash array.
BorderStylePreset(BorderStyle style, List<Integer> dashArray)
Creates preset with border style style and dash array dashArray.
BorderStylePreset(BorderStyle borderStyle, BorderEffect borderEffect, List<Integer> dashArray)
Creates preset with border style borderStyle, border effect borderEffect and dash array dashArray.
BorderStylePreset(BorderStyle borderStyle, BorderEffect borderEffect, float borderEffectIntensity, List<Integer> dashArray)
Creates preset with border style borderStyle, border effect borderEffect and dash array dashArray.
Public Methods
boolean equals(Object o)
BorderEffect getBorderEffect()
Border effect specified by this preset.
float getBorderEffectIntensity()
Intensity of the border effect.
BorderStyle getBorderStyle()
Border style specified in this preset.
List<Integer> getDashArray()
Returns dash array specified in this preset.
int hashCode()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final BorderStylePreset CLOUDY

Cloudy line border.

public static final BorderStylePreset NONE

No border.

public static final BorderStylePreset SOLID

Solid line border.

Public Constructors

public BorderStylePreset (BorderStyle style)

Creates preset with border style style and null dash array.

Parameters
style Border style to use.

public BorderStylePreset (BorderStyle style, List<Integer> dashArray)

Creates preset with border style style and dash array dashArray.

Parameters
style Border style to use.
dashArray Dash array to use. Valid only when style is set to DASHED.

public BorderStylePreset (BorderStyle borderStyle, BorderEffect borderEffect, List<Integer> dashArray)

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

Parameters
borderStyle Border style to use.
borderEffect Border effect to use.
dashArray Dash array to use. Valid only when style is set to DASHED.

public BorderStylePreset (BorderStyle borderStyle, BorderEffect borderEffect, float borderEffectIntensity, List<Integer> dashArray)

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

Parameters
borderStyle Border style to use.
borderEffect Border effect to use.
borderEffectIntensity Intensity of the border effect. See setBorderEffectIntensity(float) for more details.
dashArray Dash array to use. Valid only when style is set to DASHED.

Public Methods

public boolean equals (Object o)

public BorderEffect getBorderEffect ()

Border effect specified by this preset.

Returns
  • Border effect, or NO_EFFECT if no effect should be used.

public float getBorderEffectIntensity ()

Intensity of the border effect. Valid only if the border effect is CLOUDY.

Returns
  • Border effect intensity.

public BorderStyle getBorderStyle ()

Border style specified in this preset.

Returns
  • Border style, or NONE if no border should be used.

public List<Integer> getDashArray ()

Returns dash array specified in this preset.

Returns
  • Dash array or null if none is specified (for example when not using dashed border style).

public int hashCode ()