Class cHTMLInputSelectElement

Select box with additional functions for category and article selection

cHTML

cHTMLInputSelectElement

Package: Core\Util
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Bjoern Behrens
Located at classes/class.input.helper.php

Methods summary
`public`	# `__construct( string $sName, integer $iWidth = '', string $sID = '', string $bDisabled = false, integer $iTabIndex = NULL, string $sAccessKey = '' )` Constructor to create an instance of this class. Constructor to create an instance of this class. Creates an HTML select field (aka 'DropDown'). Parameters `$sName` `string` $sName Name of the element `$iWidth` `integer` $iWidth [optional] Width of the select element `$sID` `string` $sID [optional] ID of the element `$bDisabled` `string` $bDisabled [optional] Item disabled flag (non-empty to set disabled) `$iTabIndex` `integer` $iTabIndex [optional] Tab index for form elements `$sAccessKey` `string` $sAccessKey [optional] Key to access the field Overrides `cHTMLSelectElement::__construct()`
`public integer`	# `addArticles( integer $iIDCat, boolean $bColored = false, boolean $bArtOnline = true, string $sSpaces = '' )` Function addArticles. Adds articles to select box values. Function addArticles. Adds articles to select box values. Parameters `$iIDCat` `integer` $iIDCat idcat of the category to be listed `$bColored` `boolean` $bColored Add color information to option elements `$bArtOnline` `boolean` $bArtOnline If true, only online articles will be added `$sSpaces` `string` $sSpaces Just some ' ' to show data hierarchically (used in conjunction with addCategories) Returns `integer` Number of items added
`public integer`	# `addCategories( integer $iMaxLevel = 0, boolean $bColored = false, boolean $bCatVisible = true, boolean $bCatPublic = true, boolean $bWithArt = false, boolean $bArtOnline = true )` Function addCategories. Adds category elements (optionally including articles) to select box values. Note: Using 'with articles' adds the articles also - but the categories will get a negative value! There is no way to distinguish between a category id and an article id... Function addCategories. Adds category elements (optionally including articles) to select box values. Note: Using 'with articles' adds the articles also - but the categories will get a negative value! There is no way to distinguish between a category id and an article id... Parameters `$iMaxLevel` `integer` $iMaxLevel Max. level shown (to be exact: except this level) `$bColored` `boolean` $bColored Add color information to option elements `$bCatVisible` `boolean` $bCatVisible If true, only add idcat as value, if cat is visible `$bCatPublic` `boolean` $bCatPublic If true, only add idcat as value, if cat is public `$bWithArt` `boolean` $bWithArt Add also articles per category `$bArtOnline` `boolean` $bArtOnline If true, show only online articles Returns `integer` Number of items added
`public integer`	# `addTypesFromArt( integer $iIDCatArt, string $sTypeRange = '' )` Function addTypesFromArt. Adds types and type ids which are available for the specified article Function addTypesFromArt. Adds types and type ids which are available for the specified article Parameters `$iIDCatArt` `integer` $iIDCatArt Article id `$sTypeRange` `string` $sTypeRange Comma separated list of CONTENIDO type ids which may be in the resulting list (e.g. '1', '17', '28') Returns `integer` Number of items added
`public cHTMLSelectElement`	# `setSelected( array $aElements )` Selects specified elements as selected Selects specified elements as selected Parameters `$aElements` `array` $aElements Array with "values" of the cHTMLOptionElement to set Returns `cHTMLSelectElement` $this for chaining Overrides `cHTMLSelectElement::setSelected()`

Methods inherited from cHTMLSelectElement
`addOptionElement(), appendOptionElement(), autoFill(), getDefault(), setDefault(), setMultiselect(), setSize(), toHtml()`

Methods inherited from cHTMLFormElement
`setAccessKey(), setDisabled(), setTabindex()`

Methods inherited from cHTML
`__toString(), _appendContent(), _getAttrString(), _parseAttributes(), _setContent(), addRequiredScript(), advanceID(), appendStyleDefinition(), appendStyleDefinitions(), attachEventDefinition(), display(), fillCloseSkeleton(), fillSkeleton(), getAttribute(), getAttributes(), getID(), removeAttribute(), render(), setAlt(), setAttribute(), setAttributes(), setClass(), setEvent(), setGenerateXHTML(), setID(), setStyle(), setTag(), unsetEvent(), updateAttribute(), updateAttributes()`

Properties inherited from cHTMLSelectElement
`$_options`

Properties inherited from cHTML
`$_attributes, $_content, $_contentlessTag, $_eventDefinitions, $_generateXHTML, $_idCounter, $_requiredScripts, $_skeletonClose, $_skeletonOpen, $_skeletonSingle, $_styleDefinitions, $_styleDefs, $_tag`

Packages

Classes

Class cHTMLInputSelectElement

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides