glok-core/uk.co.nickthecoder.glok.control/Ruler

Ruler

class Ruler(side: Side = Side.TOP) : Region

A horizontal or vertical ruler, often used at the top and left of a drawing (in a BorderPane).

Theme DSL

"ruler" {

    font( value : Font )
    font( size : Int, style : FontStyle, family : String... )
    font( size : Int, family : String... )

    format( value : Format ) // Converts numbers to Strings. See java.text.Format

    textColor( value : Color )
    textColor( value : String )

    ":top" { padding( ... ) }
    ":bottom" { padding( ... ) }
    ":left" { padding( ... ) }
    ":right" { padding( ... ) }
}

The padding determines the size of the markings along the ruler.

Ruler inherits all the features of Region.

Constructors

Ruler

constructor(side: Side = Side.TOP)

Types

Companion

object Companion

Properties

font

var font: Font

fontProperty

val fontProperty: StylableFontProperty

format

var format: FixedFormat

formatProperty

val formatProperty: FixedFormatProperty

lowerBound

var lowerBound: Float

lowerBoundProperty

val lowerBoundProperty: FloatProperty

reversed

var reversed: Boolean

reversedProperty

val reversedProperty: BooleanProperty

If set to true, then the lower bound is at the bottom, and the upper bound at the top. i.e. when your Y axis points upwards.

side

var side: Side

sideProperty

val sideProperty: SideProperty

step

var step: Float

stepProperty

val stepProperty: FloatProperty

subdivisions

var subdivisions: Int

subdivisionsProperty

val subdivisionsProperty: IntProperty

textColor

var textColor: Color

textColorProperty

val textColorProperty: StylableColorProperty

upperBound

var upperBound: Float

upperBoundProperty

val upperBoundProperty: FloatProperty

Functions

isHorizontal

fun isHorizontal(): Boolean

isVertical

fun isVertical(): Boolean

nodePrefHeight

open override fun nodePrefHeight(): Float

Each subclass of node can determine its preferred height. As most nodes are composed of smaller nodes, this is typically calculated using evalPrefWidth of the child nodes, with extra added for spacing, padding and borders.

nodePrefWidth

open override fun nodePrefWidth(): Float

Each subclass of node can determine its preferred width. As most nodes are composed of smaller nodes, this is typically calculated using evalPrefWidth of the child nodes, with extra added for spacing, padding and borders.