ConsolePainter

commandbox.system.util

Class ConsolePainter

lucee.Component
    commandbox.system.util.ConsolePainter

Copyright Since 2014 CommandBox by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com Handles timed redraws of the console for downloadable progress bars, generic progress bars, and interactive jobs

Class Attributes:

singleton

synchronized : false

accessors : true

persistent : false

author : Brad Wood, Luis Majano, Denny Valliant

Property Summary
type	property	default	serializable	required
`boolean`	active access = public returntype = any	`false`	`true`	`false`
`any`	future access = public returntype = any		`true`	`false`
`any`	job access = public returntype = any inject = InteractiveJob		`true`	`false`
`any`	multiSelect access = public returntype = any		`true`	`false`
`any`	progressBar access = public returntype = any inject = progressBar		`true`	`false`
`any`	progressBarGeneric access = public returntype = any inject = progressBarGeneric		`true`	`false`
`any`	shell access = public returntype = any inject = shell		`true`	`false`
`any`	taskScheduler access = public returntype = any		`true`	`false`
`any`	wirebox access = public returntype = any inject = wirebox		`true`	`false`

Method Summary
`any`	clear() Clear the console.
`any`	forceStop([string message='']) Stops up the scheduled painting thread and forces any active jobs to error and any active progress bars to clear.
`string`	getActive()
`string`	getFuture()
`string`	getJob()
`string`	getMultiSelect()
`string`	getProgressBar()
`string`	getProgressBarGeneric()
`string`	getShell()
`string`	getTaskScheduler()
`string`	getWirebox()
`any`	onDIComplete()
`any`	paint() Draw the lines to the console.
`any`	setActive(boolean active)
`any`	setFuture(any future)
`any`	setJob(any job)
`any`	setMultiSelect(any multiSelect)
`any`	setProgressBar(any progressBar)
`any`	setProgressBarGeneric(any progressBarGeneric)
`any`	setShell(any shell)
`any`	setTaskScheduler(any taskScheduler)
`any`	setWirebox(any wirebox)
`any`	start() Starts up the scheduled painting thread if not already started.
`any`	stop() Stops the scheduled painting thread if no jobs or progress bars are active and it's not already stopped.

Methods inherited from class `lucee.Component`
None

Property Detail

active

property boolean active = [false]

Attributes:: access - public; required - false; returntype - any; serializable - true

future

property any future

Attributes:: access - public; required - false; returntype - any; serializable - true

job

property any job

Attributes:: access - public; required - false; returntype - any; inject - InteractiveJob; serializable - true

multiSelect

property any multiSelect

Attributes:: access - public; required - false; returntype - any; serializable - true

progressBar

property any progressBar

Attributes:: access - public; required - false; returntype - any; inject - progressBar; serializable - true

progressBarGeneric

property any progressBarGeneric

Attributes:: access - public; required - false; returntype - any; inject - progressBarGeneric; serializable - true

shell

property any shell

Attributes:: access - public; required - false; returntype - any; inject - shell; serializable - true

taskScheduler

property any taskScheduler

Attributes:: access - public; required - false; returntype - any; serializable - true

wirebox

property any wirebox

Attributes:: access - public; required - false; returntype - any; inject - wirebox; serializable - true

Method Detail

clear

public any clear()

Clear the console

forceStop

public any forceStop([string message=''])

Stops up the scheduled painting thread and forces any active jobs to error and any active progress bars to clear

Parameters:: message

getActive

public string getActive()

getFuture

public string getFuture()

getJob

public string getJob()

getMultiSelect

public string getMultiSelect()

getProgressBar

public string getProgressBar()

getProgressBarGeneric

public string getProgressBarGeneric()

getShell

public string getShell()

getTaskScheduler

public string getTaskScheduler()

getWirebox

public string getWirebox()

onDIComplete

public any onDIComplete()

paint

public any paint()

Draw the lines to the console

setActive

public any setActive(boolean active)

Parameters:: active

setFuture

public any setFuture(any future)

Parameters:: future

setJob

public any setJob(any job)

Parameters:: job

setMultiSelect

public any setMultiSelect(any multiSelect)

Parameters:: multiSelect

setProgressBar

public any setProgressBar(any progressBar)

Parameters:: progressBar

setProgressBarGeneric

public any setProgressBarGeneric(any progressBarGeneric)

Parameters:: progressBarGeneric

setShell

public any setShell(any shell)

Parameters:: shell

setTaskScheduler

public any setTaskScheduler(any taskScheduler)

Parameters:: taskScheduler

setWirebox

public any setWirebox(any wirebox)

Parameters:: wirebox

start

public any start()

Starts up the scheduled painting thread if not already started

stop

public any stop()

Stops the scheduled painting thread if no jobs or progress bars are active and it's not already stopped