imported>Oetterer am 11. Februar 2016 um 21:05 Uhr

2016-02-11T21:05:25Z

Neue Seite

{{documentation subpage}}
{{module rating|protected}}


This is a Class Module. It implements a class in Lua using [[Module:Middleclass]]. This class provides methods for defining and creating Semantic Forms field-tags.

== Usage ==
{{code|lang=lua|code=
local classSFfield = require('Module:SFfield/class')
local field = classSFfield:new('name')
classSFfield:setDefaultSize(80)
field:set('input type', 'tokens')
field:set('list')
field:set('mandatory', true)
field:set('property', 'goes by name')
local output = field:render()
}}

This class provides meththods for creating field tags to use in Semantic Forms. It is fast, easy to use and does some minor plausibility checks:
* it only allows existing attributes to be set
* it only allows existing "input type"s to be set
Concerniny "existing": The module knows all input types from Semantic Forms and Semantic Forms Inputs. All valid entries are defined in [[#Configuration Data|Configuration Data]]

Besides some debugging, the class does not print any error reports or development output. See [[Module:Debug/class]] for more information on how to access debug output.

There is are some static properties to default certain values when not set individually:
* <code>size</code> for "tokens", "combobox", "text", ... fields
* <code>autogrow</code> for "textarea" and "textarea with autocomplete"
* <code>cols</code> for "textarea" and "textarea with autocomplete"
* <code>editor</code> for "textarea" and "textarea with autocomplete"
* <code>rows</code> for "textarea" and "textarea with autocomplete"

They are initialized in the class but can be overwritten by [[#static methods|static methods]].

Besides simple field-tags there is also a method with which you can have your tags enclosed in the typical tr-th-td structure to easily create a form table. You can also add a tooltip. If <code>mandatory</code> was set, it also prints a small asterix next to the label.

{{code|lang=lua|code=
local node = field:createTr('Name', 'This field holds the full name, the person is known for.')
}}

== Constructor ==
=== new(fieldname) ===
Creates a new Object for class Name.
;fieldname
:string, mandatory
:holds the name of the field; in SF-terms: this transforms to the parameter name of the referenced template
;return
:object, of class SFfield

== Methods ==
=== Public methods ===
==== __tostring() ====
Returns a string representation of the field by calling [[#render()|render()]].
{{small|
;return
:string, representation of itself
}}

==== createTr(label, tooltip) ====
Uncloses the rendered field in a tr-th-td structure that can directly be used in an html formtable. When <code>mandatory</code> is set in the field, it adds an asterix after the label. A tooltip can also be provided.
{{small|
;label
:string, mandatory
:what var is for
;tooltip
:string, optional
:explanatory text that helps the user fill this field
;return
:object of class mw.html, one table row (tr) containing an th with the labal (and tooltip) and a tr with the rendered field.
}}

==== get(attribute) ====
Returns the value for the attribute.
{{small|
;attribute
:string, mandatory
:the name of the attribute, you wish to get
;return
:vaiable, the value for the attribute
}}

==== render() ====
Renders the object and creates a semantic forms field already htmlentities-encoded (so it can be used directly in the form)
{{small|
;return
:string, rendered and encoded field-tag
}}

==== set(attribute, value) ====
Sets an attribute for the field. Checks attribute for validity before setting it. In case of attribute <code>input type</code> checks value for validity, too. When setting simple attributes like <code>list</code> or <code>mandatory</code>, omitting value is interpreted as adding the attribute. If you at anytime wish to remove such an attribute, you have to set value to false.
{{small|
;attribute
:string, mandatory
:the name of the attribute, you wish to set
;value
:(string|integer|boolean|table), mandatory
:the value, you wish to set the attribute to.
;return
:boolean, whether setting was successful or not
}}

=== static methods ===
==== SFfield:getShowOnSelectIdPrefix() ====
Returns the static property used as prefix in the html-id attribute that serves as identifier for the <code>show on select</code> mechanism. When using the method [[#createTr(label, tooltip)|createTr]], you probably have no need for this.
{{small|
;return
:string, prefix for the value of the id attribute
}}

==== SFfield:setDefaultSize(val) ====
Sets the default size for text-like fields (tokens, combobox, text, ...). The default only applies, if this attribute is not set individually in a textarea field.
{{small|
;val
:integer, mandatory
:default size in characters for input fields
;return
:boolean, whether setting was successful or not
}}

==== SFfield:setDefaultTextAreaAutogrow(val) ====
Sets the default autogrow-behaviour of textarea-type fields. The default only applies, if this attribute is not set individually in a textarea field.
{{small|
;val
:boolean, mandatory
:disables or enables default value for autogrow in textarea fields.
;return
:boolean, whether setting was successful or not
}}

==== SFfield:setDefaultTextAreaCols(val) ====
Sets the default for number of columns for textarea-type fields. The default only applies, if this attribute is not set individually in a textarea field.
{{small|
;val
:integer, mandatory
:default for number of columns for the textarea fields.
;return
:boolean, whether setting was successful or not
}}

==== SFfield:setDefaultTextAreaEditor(val) ====
Sets the default editor of textarea-type fields. The default only applies, if this attribute is not set individually in a textarea field.
{{small|
;val
:string|boolean, mandatory
:disables or enables default wikieditor for textarea fields (boolean) or set editor to this value (string).
;return
:boolean, whether setting was successful or not
}}

==== SFfield:setDefaultTextAreaRows(val) ====
Sets the default for number of rows for textarea-type fields. The default only applies, if this attribute is not set individually in a textarea field.
{{small|
;val
:integer, mandatory
:default for number of rows for the textarea fields.
;return
:boolean, whether setting was successful or not
}}

==== SFfield:setShowOnSelectIdPrefix(val) ====
Sets the default prefix for the html id-attribute used in the <code>show on select</code> complex.
{{small|
;val
:string, mandatory
:the static property will be set to this value
;return
:boolean, whether setting was successful or not
}}

=== private methods ===
==== _processAttributes(self) ====
Converts the private property attributes (which holds all attributes for this field) from an array {attribute = value, ...} table to a sequence {'attriubte=value', ..} table. Also:
* adds the attribute 'input type' if missing to a default, depending on setting of attribute 'list'
* sets defaults (if applicable) for
** size
** autogrow
** cols
** editor
** rows
* does the 'show on select' table-conversion if necessary
{{small|
;self
:object, me
;var
:type(string|integer|boolean|table), (mandatory|optional)
:what var is for
;return
:table, of attributes as sequence
}}

== Properties ==
=== static ===
;_CFG
:table, holds configuration data found in Module:Name/config
:'''WARNING:''' This is a read only table and besides functions ''pairs()'' and ''ipairs()'' nothing else will work on it, especially not the functions of the table library!
* global, table, global behaviour settings
* validAttributes, table, a sequence of all valid attributes
* validInputTypes, table, a sequence of all valid values for attribute "input type"
;_TT
:table, instance of [[Module:TableTools]]
;_defaultListInputType
:string, default value for attribute "input type" if unset. applies if "list" is set
;_defaultSingleInputType
:string, default value for attribute "input type" if unset. applies if "list" is not set
;_defaultSize
:integer, default size for most input types if not set
;_defaultTextAreaAttributes
:table, holds some default attribte values for textarea fields if unset
;_mandatoryMarker
:string, [[#createTr(label, tooltip)|createTr]] uses this marker to depict mandatory fields
;_showOnSelectIdPrefix
:string, prefix string for html id-attributes for the show on select complex (e.g.: '<tr id="' .. _showOnSelectIdPrefix .. fieldname .. '">")

=== private ===
Note: all private properties are stored in table ''_private[self]''. _private is a static array that is indexed by ''self'', so the table ''_private[self]'' holds all properties for instance ''self''.
;attributes
:table, holds "my" attributes
;dbg
:object, my instance of [[Module:Debug/class]] for debugging purposes
;name
:string, name of this field

== Configuration Data ==
This class holds it control data in [[Module:{{BASEPAGENAME}}/config]].

[[Category:Class engine]]<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

[[Category:Lua metamodules]][[Category:Lua class modules]]
}}</includeonly>

Modul:SFfield/class/doc - Versionsgeschichte

imported>Oetterer am 11. Februar 2016 um 21:05 Uhr