SAP ABAP Class /UI5/CL_THEME_API (UI Theming: Public theming API (needs rework))
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-THD (Application Component) Theme Designer
⤷
/UI5/THEMING_INFRA (Package) UI Theming Infrastructure
SAP_UI (Software Component) User Interface Technology⤷
CA-UI2-THD (Application Component) Theme Designer⤷
/UI5/THEMING_INFRA (Package) UI Theming InfrastructureProperties
| Class | /UI5/CL_THEME_API | |
| Short Description | UI Theming: Public theming API (needs rework) | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /UI5/THEMING_INFRA | UI Theming Infrastructure |
| Created | 20120713 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  /UI5/CL_THEME_ENTITY |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class /UI5/CL_THEME_API has no interface implemented.
Friends
Class /UI5/CL_THEME_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_THEME_NAMESPACE |
Constant | Public | Type reference (TYPE) | STRING | 'com.sap.ui.ui_theming' | 20120713 | ||
| 2 | E_THEME_ENTITY |
Constant | Public | See coding | 20130116 | ||||
| 3 | M_THEME_KEY |
Instance attribute | Private | Type reference (TYPE) | /UI5/THEME_LIBRARY_KEY | Key of a Theme Library | 20120713 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BUILD_THEME_PARAMETERS |
Static method | Public | Method | Build URL Parameter(s) to supply a theme | 20130304 |
| 2 | CALC_CACHE_STRING |
Static method | Public | Method | Calculates the cache string | 20130319 |
| 3 | CUSTOM_THEME_EXISTS |
Static method | Public | Method | Check if custom theme exists | 20130903 |
| 4 | GET_CACHE_TOKEN |
Static method | Public | Method | Get hash from cache string | 20130319 |
| 5 | GET_CUSTOM_THEMES |
Static method | Public | Method | Get list of custom themes | 20140423 |
| 6 | GET_FILE |
Static method | Public | Method | Get theming file | 20130118 |
| 7 | GET_FILE_OPAQUE |
Static method | Public | Method | Get file, Search it through theme hierarchy | 20130116 |
| 8 | GET_LEGACY_CSSURL |
Static method | Public | Method | Get URL for sap-cssurl | 20130116 |
| 9 | GET_PATH_FROM_LEGACY_URL |
Static method | Public | Method | Get theme path from legacy CSS path syntax (like sap-cssurl) | 20130116 |
| 10 | GET_SERVER_URL |
Static method | Public | Method | Get server URL | 20130325 |
| 11 | GET_THEME_INFO |
Static method | Public | Method | Get information about a theme | 20140423 |
| 12 | GET_THEME_ROOT |
Static method | Public | Method | Get theme root | 20130305 |
| 13 | LIST_THEME_DATA |
Static method | Public | Method | List theming data of custom themes | 20130325 |
Events
Class /UI5/CL_THEME_API has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_ITEM | Public | Type reference (TYPE) | /UI5/CFS | 20120713 | |
|
| 2 | T_LIST | Public | See coding | 20120713 | t_list type standard table of /ui5/cfs with default key
|
||
| 3 | T_THEME_DATA | Public | See coding | 20130325 | begin of t_theme_data,
theme type string,
framework type string,
library type string.
include type /ui5/cfs.
types:
end of t_theme_data
|
||
| 4 | T_THEME_DATA_TAB | Public | See coding | 20130325 | t_theme_data_tab type standard table of t_theme_data with default key
|
||
| 5 | T_THEME_ENTITY_KEY | Public | See coding | 20130118 | begin of t_theme_entity_key,
framework type string,
library type string,
theme type string,
file type string,
entity_path type string,
offset_path type string,
end of t_theme_entity_key
|
Method Signatures
Method BUILD_THEME_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
BUILD_IN_FOR_SAP_THEMES | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | SAP-Themes will not be delivered using the theming infra. | 20130419 | |
| 2 | Importing |
CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | SY-MANDT | Client ID of Current User | 20130305 | |
| 3 | Importing |
LEGACY_SUPPORT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20130314 | ||
| 4 | Importing |
SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130304 | ||
| 5 | Importing |
THEME_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | 20130304 | |||
| 6 |  Returning |
THEME_PARAMETERS | Value transfer | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20130304 | ||
| 7 | Importing |
THEME_ROOT | Call by reference | Type reference (TYPE) | CSEQUENCE | 20130304 |
Method BUILD_THEME_PARAMETERS on class /UI5/CL_THEME_API has no exception.
Method CALC_CACHE_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
TOKEN | Value transfer | Type reference (TYPE) | STRING | 20130319 |
Method CALC_CACHE_STRING on class /UI5/CL_THEME_API has no exception.
Method CUSTOM_THEME_EXISTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CLIENT | Call by reference | Type reference (TYPE) | MANDT | SY-MANDT | Client | 20130904 | |
| 2 | Returning |
EXISTS | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20130903 | |||
| 3 | Importing |
FRAMEWORK | Call by reference | Type reference (TYPE) | STRING | 20130903 | |||
| 4 | Importing |
LIBRARY | Call by reference | Type reference (TYPE) | STRING | 20130903 | |||
| 5 | Importing |
THEME_ID | Call by reference | Type reference (TYPE) | STRING | 20130903 |
Method CUSTOM_THEME_EXISTS on class /UI5/CL_THEME_API has no exception.
Method GET_CACHE_TOKEN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | SY-MANDT | 20130320 | ||
| 2 | Returning |
TOKEN | Value transfer | Type reference (TYPE) | STRING | 20130319 |
Method GET_CACHE_TOKEN on class /UI5/CL_THEME_API has no exception.
Method GET_CUSTOM_THEMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
SEARCH_FRAMEWORK | Call by reference | Type reference (TYPE) | STRING | 'Base' | Return themes for that framework | 20140423 | |
| 2 | Importing |
SEARCH_LIBRARY | Call by reference | Type reference (TYPE) | STRING | 'baseLib' | Return themes for that library | 20140423 | |
| 3 | Returning |
THEME_IDS | Value transfer | Type reference (TYPE) | STRING_TABLE | Table of Strings | 20140423 |
Method GET_CUSTOM_THEMES on class /UI5/CL_THEME_API has no exception.
Method GET_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PATH | Call by reference | Type reference (TYPE) | STRING | 20130118 | |||
| 2 | Importing |
PATH_INFO | Call by reference | Type reference (TYPE) | /UI5/CL_THEME_ENTITY=>T_PATH_INFO | 20130118 | |||
| 3 | Returning |
RESOURCE | Value transfer | Object reference (TYPE REF TO) | /UI5/IF_VFS_FILE | WebDAV API | 20130118 | ||
| 4 | Importing |
ZIP | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20130118 |
Method GET_FILE on class /UI5/CL_THEME_API has no exception.
Method GET_FILE_OPAQUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
FILE | Value transfer | Object reference (TYPE REF TO) | /UI5/IF_VFS_FILE | Virtual File System - File API | 20130116 | ||
| 2 | Importing |
PATH | Call by reference | Type reference (TYPE) | STRING | 20130116 |
Method GET_FILE_OPAQUE on class /UI5/CL_THEME_API has no exception.
Method GET_LEGACY_CSSURL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CSSURL | Value transfer | Type reference (TYPE) | STRING | 20130314 | |||
| 2 | Importing |
LEGACY_DEVICE | Call by reference | Type reference (TYPE) | CSEQUENCE | 'ie6' | 20130314 | ||
| 3 | Importing |
LEGACY_THEME_PART | Call by reference | Type reference (TYPE) | CSEQUENCE | 'ur' | 20130314 | ||
| 4 | Importing |
THEME_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | 20130314 | |||
| 5 | Importing |
THEME_ROOT | Call by reference | Type reference (TYPE) | CSEQUENCE | 20130314 |
Method GET_LEGACY_CSSURL on class /UI5/CL_THEME_API has no exception.
Method GET_PATH_FROM_LEGACY_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LEGACY_PATH | Call by reference | Type reference (TYPE) | STRING | 20130116 | |||
| 2 |  Exporting |
PATH | Value transfer | Type reference (TYPE) | STRING | 20130116 | |||
| 3 | Exporting |
THEME_ENTITY | Call by reference | Type reference (TYPE) | I | 20130116 |
Method GET_PATH_FROM_LEGACY_URL on class /UI5/CL_THEME_API has no exception.
Method GET_SERVER_URL Signature
Method GET_SERVER_URL on class /UI5/CL_THEME_API has no parameter.
Method GET_SERVER_URL on class /UI5/CL_THEME_API has no exception.
Method GET_THEME_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EXTENDS_THEME_ID | Call by reference | Type reference (TYPE) | STRING | 20140423 | |||
| 2 | Exporting |
LABEL | Call by reference | Type reference (TYPE) | STRING | 20140423 | |||
| 3 | Exporting |
TEXT_DIRECTIONS | Call by reference | Type reference (TYPE) | STRING | 20140423 | |||
| 4 | Importing |
THEME_ID | Call by reference | Type reference (TYPE) | STRING | 20140423 | |||
| 5 | Exporting |
VENDOR | Call by reference | Type reference (TYPE) | STRING | 20140423 |
Method GET_THEME_INFO on class /UI5/CL_THEME_API has no exception.
Method GET_THEME_ROOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ADMIN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130305 | ||
| 2 | Importing |
ALWAYS_HTTPS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130325 | ||
| 3 | Importing |
CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | SY-MANDT | Client ID of Current User | 20130305 | |
| 4 | Importing |
SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130325 | ||
| 5 | Returning |
THEME_ROOT | Value transfer | Type reference (TYPE) | STRING | 20130305 | |||
| 6 | Importing |
WITH_CACHE_TOKEN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130325 | ||
| 7 | Importing |
WITH_SERVER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130325 |
Method GET_THEME_ROOT on class /UI5/CL_THEME_API has no exception.
Method LIST_THEME_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
THEME_DATA_TAB | Value transfer | Type reference (TYPE) | T_THEME_DATA_TAB | 20130325 |
Method LIST_THEME_DATA on class /UI5/CL_THEME_API has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |
