ilSubmitButton Class Reference

Inheritance diagram for ilSubmitButton:

Collaboration diagram for ilSubmitButton:

Public Member Functions
	setCommand ($a_value)
	Set submit command.
	getCommand ()
	Get submit command.
	render ()
	Render HTML.
Public Member Functions inherited from ilButton
	__clone ()
	Clone instance.
	getType ()
	Get button type.
	setId ($a_value)
	Set id.
	getId ()
	Get id.
	setCaption ($a_value, $a_is_lng_id=true)
	Set caption.
	getCaption ($a_translate=true)
	Get caption.
	setPrimary ($a_value)
	Toggle primary status.
	isPrimary ()
	Get primary status.
	setOmitPreventDoubleSubmission ($a_value)
	Toggle double submission prevention status.
	getOmitPreventDoubleSubmission ()
	Get double submission prevention status.
	setOnClick ($a_value)
	Set onclick.
	getOnClick ()
	Get onclick.
	setAccessKey ($a_value)
	Set access key.
	getAccessKey ()
	Get access key.
	setDisabled ($a_value)
	Toggle disabled status.
	isDisabled ()
	Get disabled status.
	addCSSClass ($a_value)
	Add CSS class.
	getCSSClasses ()
	Get CSS class(es)

Static Public Member Functions
static	getInstance ()
	Factory.

Protected Attributes
	$cmd
Protected Attributes inherited from ilButton
	$type
	$id
	$caption
	$caption_is_lng_id
	$primary
	$omit_prevent_double_submission
	$onclick
	$acc_key
	$disabled
	$css = array()

Additional Inherited Members
Data Fields inherited from ilButton
const	TYPE_SUBMIT = 1
const	TYPE_LINK = 2
Protected Member Functions inherited from ilButton
	__construct ($a_type)
	Constructor.
	setType ($a_value)
	Set button type.
	gatherCssClasses ()
	Gather all active CSS classes.
	renderAttributesHelper (array $a_attr)
	Render HTML node attributes.
	renderAttributes (array $a_additional_attr=null)
	Render current HTML attributes.
	prepareRender ()
	Prepare render.

Detailed Description

Definition at line 13 of file class.ilSubmitButton.php.

Member Function Documentation

ilSubmitButton::getCommand

(

)

Get submit command.

Parameters

string

$a_value

Definition at line 42 of file class.ilSubmitButton.php.

References $cmd.

        {
                return $this->cmd;
        }

static ilSubmitButton::getInstance ( )

static

Factory.

Returns

self

Reimplemented from ilButton.

Definition at line 17 of file class.ilSubmitButton.php.

References ilButton\TYPE_SUBMIT.

Referenced by ilAccountCodesTableGUI\__construct(), ilWikiExportOrderTableGUI\__construct(), ilSurveyCodesTableGUI\__construct(), ilSurveyEvaluationGUI\addApprSelectionToToolbar(), ilSurveyParticipantsGUI\codesObject(), ilAdvancedMDSettingsGUI\editFields(), ilSurveyEvaluationGUI\evaluation(), ilSurveyEvaluationGUI\evaluationuser(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), ilConfirmationGUI\getHTML(), ilObjSurveyGUI\infoScreen(), ilListOfQuestionsTableGUI\init(), ilExportGUI\listExportFiles(), ilTestPlayerAbstractGUI\populateLowerNextButtonBlockLeadingToEndOfTest(), ilTestPlayerAbstractGUI\populateLowerNextButtonBlockLeadingToQuestion(), ilTestPlayerAbstractGUI\populateLowerNextButtonBlockLeadingToSummary(), ilTestPlayerAbstractGUI\populateUpperNextButtonBlockLeadingToEndOfTest(), ilTestPlayerAbstractGUI\populateUpperNextButtonBlockLeadingToQuestion(), ilTestPlayerAbstractGUI\populateUpperNextButtonBlockLeadingToSummary(), ilSurveyEditorGUI\questionsObject(), ilObjSurveyQuestionPoolGUI\questionsObject(), ilObjBlogGUI\render(), ilSurveyExecutionGUI\runShowFinishedPage(), ilWorkspaceAccessGUI\share(), ilMarkSchemaGUI\showMarkSchema(), ilSearchGUI\showSearch(), ilLuceneUserSearchGUI\showSearchForm(), and ilLuceneSearchGUI\showSearchForm().

        {
                return new self(self::TYPE_SUBMIT);
        }

Here is the caller graph for this function:

ilSubmitButton::render

(

)

Render HTML.

Returns

string

Reimplemented from ilButton.

Definition at line 52 of file class.ilSubmitButton.php.

References ilButton\getCaption(), and ilButton\prepareRender().

        {
                $this->prepareRender();
                
                $attr = array();
                $attr["type"] = "submit";
                $attr["name"] = "cmd[".$this->getCommand()."]";
                $attr["value"] = $this->getCaption();
                
                return '<input'.$this->renderAttributes($attr).' />';
        }       

Here is the call graph for this function:

ilSubmitButton::setCommand

(

$a_value

)

Set submit command.

Parameters

string

$a_value

Definition at line 32 of file class.ilSubmitButton.php.

        {
                $this->cmd = trim($a_value);
        }

Field Documentation

ilSubmitButton::$cmd

protected

Definition at line 15 of file class.ilSubmitButton.php.

Referenced by getCommand().

---

The documentation for this class was generated from the following file:

• Services/UIComponent/Button/classes/class.ilSubmitButton.php