1 /* ----------------------------------------------------------------------------------
2 * Hint: This is a derived (generated) file. Changes should be done in the underlying
3 * source files only (*.control, *.js) or they will be lost after the next generation.
4 * ---------------------------------------------------------------------------------- */
5
6 // Provides control sap.apb.TabPage.
7 jQuery.sap.declare("sap.apb.TabPage");
8 jQuery.sap.require("sap.apb.library");
9 jQuery.sap.require("sap.m.Page");
10
11 /**
12 * Constructor for a new TabPage.
13 *
14 * Accepts an object literal <code>mSettings</code> that defines initial
15 * property values, aggregated and associated objects as well as event handlers.
16 *
17 * If the name of a setting is ambiguous (e.g. a property has the same name as an event),
18 * then the framework assumes property, aggregation, association, event in that order.
19 * To override this automatic resolution, one of the prefixes "aggregation:", "association:"
20 * or "event:" can be added to the name of the setting (such a prefixed name must be
21 * enclosed in single or double quotes).
22 *
23 * The supported settings are:
24 * <ul>
25 * <li>Properties
26 * <ul>
27 * <li>{@link #getTabText tabText} : string</li>
28 * <li>{@link #getTabIcon tabIcon} : sap.ui.core.URI</li>
29 * <li>{@link #getTabBadge tabBadge} : string</li></ul>
30 * </li>
31 * <li>Aggregations
32 * <ul></ul>
33 * </li>
34 * <li>Associations
35 * <ul></ul>
36 * </li>
37 * <li>Events
38 * <ul></ul>
39 * </li>
40 * </ul>
41 *
42 *
43 * In addition, all settings applicable to the base type {@link sap.m.Page#constructor sap.m.Page}
44 * can be used as well.
45 *
46 * @param {string} [sId] id for the new control, generated automatically if no id is given
47 * @param {object} [mSettings] initial settings for the new control
48 *
49 * @class
50 * A TabPage is a basic container for a tab-based mobile application screen. Usually one page is displayed at a time and users can navigate to other TabPage through the tab-button located at the bottom of the screen.
51 * @extends sap.m.Page
52 *
53 * @author SAP AG
54 * @version 1.0
55 *
56 * @constructor
57 * @public
58 * @name sap.apb.TabPage
59 */
60 sap.m.Page.extend("sap.apb.TabPage", { metadata : {
61
62 // ---- object ----
63
64 // ---- control specific ----
65 library : "sap.apb",
66 properties : {
67 "tabText" : {type : "string", group : "Misc", defaultValue : null},
68 "tabIcon" : {type : "sap.ui.core.URI", group : "Misc", defaultValue : null},
69 "tabBadge" : {type : "string", group : "Misc", defaultValue : null}
70 }
71 }});
72
73
74 /**
75 * Creates a new subclass of class sap.apb.TabPage with name <code>sClassName</code>
76 * and enriches it with the information contained in <code>oClassInfo</code>.
77 *
78 * <code>oClassInfo</code> might contain the same kind of informations as described in {@link sap.ui.core.Element.extend Element.extend}.
79 *
80 * @param {string} sClassName name of the class to be created
81 * @param {object} [oClassInfo] object literal with informations about the class
82 * @param {function} [FNMetaImpl] constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
83 * @return {function} the created class / constructor function
84 * @public
85 * @static
86 * @name sap.apb.TabPage.extend
87 * @function
88 */
89
90
91 /**
92 * Getter for property <code>tabText</code>.
93 * tabText is the text to be shown on the tab button
94 *
95 * Default value is empty/<code>undefined</code>
96 *
97 * @return {string} the value of property <code>tabText</code>
98 * @public
99 * @name sap.apb.TabPage#getTabText
100 * @function
101 */
102
103 /**
104 * Setter for property <code>tabText</code>.
105 *
106 * Default value is empty/<code>undefined</code>
107 *
108 * @param {string} sTabText new value for property <code>tabText</code>
109 * @return {sap.apb.TabPage} <code>this</code> to allow method chaining
110 * @public
111 * @name sap.apb.TabPage#setTabText
112 * @function
113 */
114
115
116 /**
117 * Getter for property <code>tabIcon</code>.
118 * tabIcon is the icon to be shown on the tab button
119 *
120 * Default value is empty/<code>undefined</code>
121 *
122 * @return {sap.ui.core.URI} the value of property <code>tabIcon</code>
123 * @public
124 * @name sap.apb.TabPage#getTabIcon
125 * @function
126 */
127
128 /**
129 * Setter for property <code>tabIcon</code>.
130 *
131 * Default value is empty/<code>undefined</code>
132 *
133 * @param {sap.ui.core.URI} sTabIcon new value for property <code>tabIcon</code>
134 * @return {sap.apb.TabPage} <code>this</code> to allow method chaining
135 * @public
136 * @name sap.apb.TabPage#setTabIcon
137 * @function
138 */
139
140
141 /**
142 * Getter for property <code>tabBadge</code>.
143 * tabBadge is the badge text to be shown on the tab button
144 *
145 * Default value is empty/<code>undefined</code>
146 *
147 * @return {string} the value of property <code>tabBadge</code>
148 * @public
149 * @name sap.apb.TabPage#getTabBadge
150 * @function
151 */
152
153 /**
154 * Setter for property <code>tabBadge</code>.
155 *
156 * Default value is empty/<code>undefined</code>
157 *
158 * @param {string} sTabBadge new value for property <code>tabBadge</code>
159 * @return {sap.apb.TabPage} <code>this</code> to allow method chaining
160 * @public
161 * @name sap.apb.TabPage#setTabBadge
162 * @function
163 */
164
165