ContentBox Core API 1.6.0

contentbox.plugins
Class BootstrapFileUpload

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by contentbox.plugins.BootstrapFileUpload

public class BootstrapFileUpload
extends coldbox.system.Plugin
Property Summary
Type Property & Description Default Serializable Required
 any html


Attributes:
  • inject = coldbox:plugin:HTMLHelper
true false
 
Constructor Summary
init(any controller)
          Constructor
 
Method Summary
 string renderIt(string name, [boolean required='true'], [string id=''], [string label], [numeric columnWidth='3'], [any useRemoveButton='true'], [any selectButtonText='Select file'], [any changeButtonText='Change'], [any removeButtonText='Remove'])
          Main method for rendering bootstrap-themed file upload field
 
Methods inherited from class coldbox.system.Plugin
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
 
Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any controller)
Constructor

Parameters:
controller
Property Detail

html

any html

Attributes:
inject - coldbox:plugin:HTMLHelper
required - false
serializable - true
default -

Method Detail

renderIt

public string renderIt(string name, [boolean required='true'], [string id=''], [string label], [numeric columnWidth='3'], [any useRemoveButton='true'], [any selectButtonText='Select file'], [any changeButtonText='Change'], [any removeButtonText='Remove'])
Main method for rendering bootstrap-themed file upload field

Parameters:
name - The name of the file field to create
required - Whether or not the field is required (validation)
id - The id to apply to the file field
label - If specified, will create a label element with the specified text for the file field
columnWidth - The number of columns that the field should occupy (bootstrap grid system)
useRemoveButton - Whether a "remove" button should be created
selectButtonText - The text to use for the "select" button
changeButtonText - The text to use for the "change" button
removeButtonText - The text to use for the "remove" button

ContentBox Core API 1.6.0