f46e3bf2455c8eda8d31d1ef953bcabb4835bd44
[timetracker.git] / WEB-INF / lib / form / FormElement.class.php
1 <?php
2 // +----------------------------------------------------------------------+
3 // | Anuko Time Tracker
4 // +----------------------------------------------------------------------+
5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
6 // +----------------------------------------------------------------------+
7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
8 // | by anyone for any purpose, and freely redistributed alone or in
9 // | combination with other software, provided that the license is obeyed.
10 // |
11 // | There are only two ways to violate the license:
12 // |
13 // | 1. To redistribute this code in source form, with the copyright
14 // |    notice or license removed or altered. (Distributing in compiled
15 // |    forms without embedded copyright notices is permitted).
16 // |
17 // | 2. To redistribute modified versions of this code in *any* form
18 // |    that bears insufficient indications that the modifications are
19 // |    not the work of the original author(s).
20 // |
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
23 // |
24 // +----------------------------------------------------------------------+
25 // | Contributors:
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
28
29 // FromElement is the base class for controls on forms.
30 class FormElement {
31   var $id = "";
32   var $name;
33   var $form_name = "";
34         var $mValue                     = "";
35         var $mSize                      = "";
36         var $mMaxLength         = "";
37         var $mTabindex          = "";
38         var $mAccesskey     = "";
39         var $mOnSelect          = "";
40         var $mOnChange          = "";
41         var $mOnClick           = "";
42         var $mOnKeyPress        = "";
43         var $mOnFocus           = "";
44         var $mLabel         = "";
45         var $mStyle         = "";
46         var $mRenderable    = true;
47         var $mEnabled           = true;
48         var $cClassName         = "FormElement";
49         var $mI18n                      = null;
50
51         function __construct() {
52         }
53
54         function getClass()     { return $this->cClassName; }
55         
56         function setName($name) { $this->name = $name;  }
57         function getName()      { return $this->name; }
58         
59         function setFormName($name) { $this->form_name = $name; }
60         function getFormName()  { return $this->form_name; }
61         
62         function setValue($value)       { $this->mValue = $value;}
63         function getValue() { return $this->mValue; }
64         
65         function setValueSafe($value)   { $this->mValue = $value;}
66         function getValueSafe() { return $this->mValue; }
67
68         function setId($id)     { $this->id = $id;      }
69         function getId() { return $this->id; }
70         
71         function setSize($value)        { $this->mSize = $value; }
72         function getSize() { return $this->mSize; }
73
74         function setLabel($label)       { $this->mLabel = $label; }
75         function getLabel() { return $this->mLabel; }
76         
77         function setMaxLength($value)   { $this->mMaxLength = $value; }
78         function getMaxLength() { return $this->mMaxLength; }
79         
80         function setTabindex($value)    { $this->mTabindex = $value; }
81         function getTabindex() { return $this->mTabindex; }
82         
83         function setAccesskey($value)   { $this->mAccesskey = $value; }
84         function getAccesskey() { return $this->mAccesskey; }
85
86         function setStyle($value)       { $this->mStyle = $value; }
87         function getStyle() { return $this->mStyle; }
88         
89         function setRenderable($flag)   { $this->mRenderable = $flag;   }
90         function isRenderable() { return $this->mRenderable; }
91         
92         function setEnable($flag)       { $this->mEnabled = $flag;      }
93         function isEnable()     { return $this->mEnabled; }
94         
95         function setOnChange($str)      { $this->mOnChange = $str; }
96         function setOnClick($str)       { $this->mOnClick = $str; }
97         function setOnSelect($str)      { $this->mOnSelect = $str; }
98
99         function setLocalization($i18n) {
100                 $this->mI18n = $i18n;
101         }
102         
103         function toStringControl()      {
104                 return "";
105         }
106         
107         function toStringLabel() {
108             return "<label for=\"" . $this->id . "\">" . $this->mLabel . "</label>";
109         }
110         
111         function toArray() {
112             return array(
113                      "label"=>$this->toStringLabel(),
114                      "control"=>$this->toStringControl()
115                    );
116         }
117
118 }