Merge pull request #498 from silverstripe-droptables/minor-right-title-comment

MINOR: add comments to FormField's RightTitle
This commit is contained in:
Sean Harvey 2012-05-31 20:09:15 -07:00
commit c037ee8cbd

View File

@ -40,7 +40,8 @@ class FormField extends RequestHandler {
public $dontEscape; public $dontEscape;
/** /**
* @var $rightTitle string Used in SmallFieldHolder() to force a right-aligned label. * @var $rightTitle string Used in SmallFieldHolder to force a right-aligned label, or in FieldHolder
* to create contextual label.
*/ */
protected $rightTitle; protected $rightTitle;
@ -224,10 +225,21 @@ class FormField extends RequestHandler {
return $this; return $this;
} }
/**
* Gets the contextual label than can be used for additional field description.
* Can be shown to the right or under the field in question.
*
* @return string Contextual label text.
*/
function RightTitle() { function RightTitle() {
return $this->rightTitle; return $this->rightTitle;
} }
/**
* Sets the contextual label.
*
* @param $val string Text to set on the label.
*/
function setRightTitle($val) { function setRightTitle($val) {
$this->rightTitle = $val; $this->rightTitle = $val;
return $this; return $this;