Class cApiClickableAction

cApiClickableAction is a subclass of cApiAction. It provides an image for visual representation. Inherited classes should call the "setNamedAction" operation in their constructors; on-the-fly-implementations should call it directly after creating an object instance.

cGenericDb

cItemBaseAbstract

Item

cApiAction

cApiClickableAction

Direct known subclasses

cApiClickableQuestionAction

Package: Core\GUI
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Unknown
Located at classes/widgets/class.widgets.actionbutton.php

Methods summary
`public`	# `__construct( )` Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `cApiAction::__construct()`
`public`	# `setIcon( string $icon )` Sets the action icon for this action. Sets the action icon for this action. Parameters `$icon` `string` icon Path to the icon. Relative to the backend, if not passed as absolute path.
`public cHTMLImage`	# `getIcon( )` Returns `cHTMLImage`
`public`	# `setNamedAction( string $actionName )` Sets this class to use a specific action, example "con_makestart". Sets this class to use a specific action, example "con_makestart". Parameters `$actionName` `string` actionName Name of the action to use. This action must exist in the actions table before using it, otherwise, this method will fail.
`public`	# `setDisabled( )`
`public`	# `setEnabled( )`
`protected`	# `_onDisable( )`
`protected`	# `_onEnable( )`
`public`	# `changeArea( mixed $sArea )` Change linked area Change linked area
`public`	# `wantParameter( string $parameter )` Parameters `$parameter` `string` $parameter
`public`	# `setHelpText( string $helptext )` sets the help text for this action. sets the help text for this action. Parameters `$helptext` `string` helptext The helptext to apply
`public`	# `getHelpText( )`
`public`	# `setParameter( string $name, string $value )` Parameters `$name` `string` $name `$value` `string` $value
`public boolean`	# `process( mixed $parameters )` Parameters `$parameters` `mixed` $parameters Returns `boolean`
`public string`	# `render( )` Returns `string`
`public string`	# `renderText( )` Returns `string`

Methods inherited from Item
`_inFilter(), _loadByWhereClause(), _onLoad(), _outFilter(), _setMetaObject(), deleteProperty(), deletePropertyById(), get(), getField(), getMetaObject(), getProperty(), isLoaded(), loadBy(), loadByMany(), loadByPrimaryKey(), loadByRecordSet(), set(), setField(), setFilters(), setProperty(), store(), toArray(), toObject()`

Methods inherited from cItemBaseAbstract
`_getPropertiesCollectionInstance(), _getSecondDBInstance(), escape()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants summary
`string`	`QUESTIONACTION_PROMPT`	`'prompt'`	#
`string`	`QUESTIONACTION_YESNO`	`'yesno'`	#

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties summary
`private mixed`	`$_helpText`	# Help text Help text
`protected mixed`	`$_link`	# cHTMLLink for rendering the icon cHTMLLink for rendering the icon
`private mixed`	`$_img`	# cHTMLImage for rendering the icon cHTMLImage for rendering the icon

Properties inherited from cApiAction
`$_objectInvalid`

Properties inherited from Item
`$_arrInFilters, $_arrOutFilters, $_lastSQL, $_metaObject, $modifiedValues, $oldPrimaryKey, $values`

Properties inherited from cItemBaseAbstract
`$_className, $_oCache, $_settings, $db, $lasterror, $primaryKey, $properties, $secondDb, $table, $virgin`

Packages

Classes

Class cApiClickableAction

Direct known subclasses

Throws

Overrides

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Returns