TabApp.API.js

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.TabApp.
7       jQuery.sap.declare("sap.apb.TabApp");
8       jQuery.sap.require("sap.apb.library");
9       jQuery.sap.require("sap.m.App");
10      
11      /**
12       * Constructor for a new TabApp.
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 #getTransition transition} : sap.apb.TransitionType (default: sap.apb.TransitionType.door)</li></ul>
28       * </li>
29       * <li>Aggregations
30       * <ul></ul>
31       * </li>
32       * <li>Associations
33       * <ul></ul>
34       * </li>
35       * <li>Events
36       * <ul></ul>
37       * </li>
38       * </ul> 
39       *
40       * 
41       * In addition, all settings applicable to the base type {@link sap.m.App#constructor sap.m.App}
42       * can be used as well.
43       *
44       * @param {string} [sId] id for the new control, generated automatically if no id is given 
45       * @param {object} [mSettings] initial settings for the new control
46       *
47       * @class
48       * TabApp is another root element of a UI5 mobile application besides App control. Users can navigate among the TabPages through tab-button located at the bottom of the screen.
49       * @extends sap.m.App
50       *
51       * @author SAP AG 
52       * @version 1.0
53       *
54       * @constructor   
55       * @public
56       * @name sap.apb.TabApp
57       */
58      sap.m.App.extend("sap.apb.TabApp", { metadata : {
59      
60      	// ---- object ----
61      
62      	// ---- control specific ----
63      	library : "sap.apb",
64      	properties : {
65      		"transition" : {type : "sap.apb.TransitionType", group : "", defaultValue : sap.apb.TransitionType.door}
66      	},
67      	aggregations : {
68          	"tabBar" : {type : "sap.m.Bar", multiple : false, visibility : "hidden"}
69      	}
70      }});
71      
72      
73      /**
74       * Creates a new subclass of class sap.apb.TabApp with name <code>sClassName</code> 
75       * and enriches it with the information contained in <code>oClassInfo</code>.
76       * 
77       * <code>oClassInfo</code> might contain the same kind of informations as described in {@link sap.ui.core.Element.extend Element.extend}.
78       *   
79       * @param {string} sClassName name of the class to be created
80       * @param {object} [oClassInfo] object literal with informations about the class  
81       * @param {function} [FNMetaImpl] constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
82       * @return {function} the created class / constructor function
83       * @public
84       * @static
85       * @name sap.apb.TabApp.extend
86       * @function
87       */
88      
89      
90      /**
91       * Getter for property <code>transition</code>.
92       * transition is the transition effect during navigation
93       *
94       * Default value is <code>door</code>
95       *
96       * @return {sap.apb.TransitionType} the value of property <code>transition</code>
97       * @public
98       * @name sap.apb.TabApp#getTransition
99       * @function
100      */
101     
102     /**
103      * Setter for property <code>transition</code>.
104      *
105      * Default value is <code>door</code> 
106      *
107      * @param {sap.apb.TransitionType} oTransition  new value for property <code>transition</code>
108      * @return {sap.apb.TabApp} <code>this</code> to allow method chaining
109      * @public
110      * @name sap.apb.TabApp#setTransition
111      * @function
112      */
113     
114