commandbox.system.util

Class MultiSelect

lucee.Component
    extended by commandbox.system.util.MultiSelect

Copyright Since 2014 CommandBox by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com Sweet ASCII input control

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • author : Brad Wood, Luis Majano
    •  
    Property Summary
    type property default serializable required
    any ConsolePainter


    • access = public
    • returntype = any
    • inject = provider:ConsolePainter
    		 true false
    boolean active


    • access = public
    • returntype = any
    		 true false
    boolean isMultiple


    • access = public
    • returntype = any
    		 true false
    boolean isRequired


    • access = public
    • returntype = any
    		 true false
    any job


    • access = public
    • returntype = any
    • inject = provider:InteractiveJob
    		 true false
    any print


    • access = public
    • returntype = any
    • inject = print
    		 true false
    any printBuffer


    • access = public
    • returntype = any
    • inject = printBuffer
    		 true false
    any shell


    • access = public
    • returntype = any
    • inject = shell
    		 true false
    array theOptions


    • access = public
    • returntype = any
    		 true false
    string thisQuestion


    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init([string question=''])
    Method Summary
    any ask()
         Call this method after all options and settings have been placed.
    any checkRequired()
    any doSelect([any optionNum])
    private any draw()
    string getActive()
    string getConsolePainter()
    any getCursorPosition()
    string getIsMultiple()
    string getIsRequired()
    string getJob()
    any getLines()
    any getMultiple()
    any getOptions()
    string getPrint()
    string getPrintBuffer()
    any getQuestion()
    any getRequired()
    string getShell()
    string getTheOptions()
    string getThisQuestion()
    private any isDown([any key])
    any isOversize()
    private any isPageDown([any key])
    private any isPageUp([any key])
    private any isSelect([any key])
    private any isUp([any key])
    any multiple([boolean multiple='true'])
    any onDIComplete()
    any options(any options)
    any question(string question)
    any required([boolean required='true'])
    any setActive(boolean active)
    any setConsolePainter(any ConsolePainter)
    any setIsMultiple(boolean isMultiple)
    any setIsRequired(boolean isRequired)
    any setJob(any job)
    any setMultiple([boolean multiple='true'])
    any setOptions([any options])
    any setPrint(any print)
    any setPrintBuffer(any printBuffer)
    any setQuestion(string question)
    any setRequired([boolean required='true'])
    any setShell(any shell)
    any setTheOptions(array theOptions)
    any setThisQuestion(string thisQuestion)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init([string question=''])

    Parameters:
    question
    Property Detail

    ConsolePainter

    property any ConsolePainter

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:ConsolePainter
    serializable - true

    active

    property boolean active

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

    isMultiple

    property boolean isMultiple

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

    isRequired

    property boolean isRequired

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

    job

    property any job

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

    print

    property any print

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

    printBuffer

    property any printBuffer

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

    shell

    property any shell

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

    theOptions

    property array theOptions

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

    thisQuestion

    property string thisQuestion

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    ask

    public any ask()

    Call this method after all options and settings have been placed. This method will block while the user interacts with the input control and will return a string containing the value of the selected option. If "multiple" is enabled, this method will return an array of selected values.

    checkRequired

    public any checkRequired()

    doSelect

    public any doSelect([any optionNum])

    Parameters:
    optionNum

    draw

    private any draw()

    getActive

    public string getActive()

    getConsolePainter

    public string getConsolePainter()

    getCursorPosition

    public any getCursorPosition()

    getIsMultiple

    public string getIsMultiple()

    getIsRequired

    public string getIsRequired()

    getJob

    public string getJob()

    getLines

    public any getLines()

    getMultiple

    public any getMultiple()

    getOptions

    public any getOptions()

    getPrint

    public string getPrint()

    getPrintBuffer

    public string getPrintBuffer()

    getQuestion

    public any getQuestion()

    getRequired

    public any getRequired()

    getShell

    public string getShell()

    getTheOptions

    public string getTheOptions()

    getThisQuestion

    public string getThisQuestion()

    isDown

    private any isDown([any key])

    Parameters:
    key

    isOversize

    public any isOversize()

    isPageDown

    private any isPageDown([any key])

    Parameters:
    key

    isPageUp

    private any isPageUp([any key])

    Parameters:
    key

    isSelect

    private any isSelect([any key])

    Parameters:
    key

    isUp

    private any isUp([any key])

    Parameters:
    key

    multiple

    public any multiple([boolean multiple='true'])

    Parameters:
    multiple

    onDIComplete

    public any onDIComplete()

    options

    public any options(any options)

    Parameters:
    options

    question

    public any question(string question)

    Parameters:
    question

    required

    public any required([boolean required='true'])

    Parameters:
    required

    setActive

    public any setActive(boolean active)

    Parameters:
    active

    setConsolePainter

    public any setConsolePainter(any ConsolePainter)

    Parameters:
    ConsolePainter

    setIsMultiple

    public any setIsMultiple(boolean isMultiple)

    Parameters:
    isMultiple

    setIsRequired

    public any setIsRequired(boolean isRequired)

    Parameters:
    isRequired

    setJob

    public any setJob(any job)

    Parameters:
    job

    setMultiple

    public any setMultiple([boolean multiple='true'])

    Parameters:
    multiple

    setOptions

    public any setOptions([any options])

    Parameters:
    options

    setPrint

    public any setPrint(any print)

    Parameters:
    print

    setPrintBuffer

    public any setPrintBuffer(any printBuffer)

    Parameters:
    printBuffer

    setQuestion

    public any setQuestion(string question)

    Parameters:
    question

    setRequired

    public any setRequired([boolean required='true'])

    Parameters:
    required

    setShell

    public any setShell(any shell)

    Parameters:
    shell

    setTheOptions

    public any setTheOptions(array theOptions)

    Parameters:
    theOptions

    setThisQuestion

    public any setThisQuestion(string thisQuestion)

    Parameters:
    thisQuestion