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 job


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


    • access = public
    • returntype = any
    		 true false
    array options


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


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


    • access = public
    • returntype = any
    • inject = printBuffer
    		 true false
    string question


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


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


    • access = public
    • returntype = any
    • inject = shell
    		 true false
    Constructor Summary
    init()
    Method Summary
    any ask()
         Call this method after all options and settings have been placed.
    any checkRequired()
    any doSelect([any optionNum])
    private any draw()
    private any generateRows()
    string getJob()
    string getMultiple()
    string getOptions()
    string getPrint()
    string getPrintBuffer()
    string getQuestion()
    string getRequired()
    string getShell()
    private any isDown([any key])
    private any isSelect([any key])
    private any isUp([any key])
    any onDIComplete()
    any setJob(any job)
    any setMultiple(boolean multiple)
    any setOptions([any options])
    any setPrint(any print)
    any setPrintBuffer(any printBuffer)
    any setQuestion(string question)
    any setRequired(boolean required)
    any setShell(any shell)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Property Detail

    job

    property any job

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

    multiple

    property boolean multiple

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

    options

    property array options

    Attributes:
    access - public
    required - false
    returntype - any
    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

    question

    property string question

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

    required

    property boolean required

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

    shell

    property any shell

    Attributes:
    access - public
    required - false
    returntype - any
    inject - shell
    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()

    generateRows

    private any generateRows()

    getJob

    public string getJob()

    getMultiple

    public string getMultiple()

    getOptions

    public string getOptions()

    getPrint

    public string getPrint()

    getPrintBuffer

    public string getPrintBuffer()

    getQuestion

    public string getQuestion()

    getRequired

    public string getRequired()

    getShell

    public string getShell()

    isDown

    private any isDown([any key])

    Parameters:
    key

    isSelect

    private any isSelect([any key])

    Parameters:
    key

    isUp

    private any isUp([any key])

    Parameters:
    key

    onDIComplete

    public any onDIComplete()

    setJob

    public any setJob(any job)

    Parameters:
    job

    setMultiple

    public any setMultiple(boolean multiple)

    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)

    Parameters:
    required

    setShell

    public any setShell(any shell)

    Parameters:
    shell