SAP ABAP Class CL_XSLFO_AREA (Area - super class)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-I18 (Application Component) Internationalization (I18N)
⤷
S_XSL_FO_AREA_MODEL (Package) (obsolote prototype) XSL Formatted Objects Area Model
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-I18 (Application Component) Internationalization (I18N)⤷
S_XSL_FO_AREA_MODEL (Package) (obsolote prototype) XSL Formatted Objects Area ModelMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SERIALIZABLE_OBJECT | Serializable Object | 20080206 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_XSLFO_BLOCK_AREA | Area - normal block | 20080208 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_XSLFO_INLINE_AREA | Area - normal inline | 20080208 |
| 3 | Inheritance (c INHERITING FROM c_ref) | CL_XSLFO_LINE_AREA | Area - normal line | 20080208 |
| 4 | Inheritance (c INHERITING FROM c_ref) | CL_XSLFO_ROOT_AREA | Area - root | 20080220 |
Properties
| Class | CL_XSLFO_AREA | |
| Short Description | Area - super class | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_XSL_FO_AREA_MODEL | (obsolote prototype) XSL Formatted Objects Area Model |
| Created | 20080206 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SERIALIZABLE_OBJECT | Serializable Object | 20080206 |
Friends
Class CL_XSLFO_AREA has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_CLASS_ABSOLUTE |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 1 | XSL-FO enumerated data type | 20080215 | |
| 2 | CO_CLASS_ABSOLUTE_REFERENCE |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 129 | XSL-FO enumerated data type | 20080215 | |
| 3 | CO_CLASS_NORMAL |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 0 | XSL-FO enumerated data type | 20080215 | |
| 4 | CO_CLASS_NORMAL_REFERENCE |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 128 | XSL-FO enumerated data type | 20080215 | |
| 5 | CO_HUGE_DISTANCE |
Constant | Public | Type reference (TYPE) | XSLFO_LENGTH | 1417322 | XSL:FO length unit (1/72000 inch) | 20090911 | |
| 6 | CO_HUGE_INTEGER |
Constant | Public | Type reference (TYPE) | XSLFO_LENGTH | 2000000000 | XSL:FO length unit (1/72000 inch) | 20090911 | |
| 7 | CO_NAME_PAGE |
Constant | Public | Type reference (TYPE) | STRING | 'page' | 20080208 | ||
| 8 | CO_NAME_ROOT |
Constant | Public | Type reference (TYPE) | STRING | 'root' | 20080208 | ||
| 9 | CO_NULL_AREA |
Static Attribute | Public | Object reference (TYPE REF TO) | CL_XSLFO_AREA | Area - super class | 20080219 | ||
| 10 | CO_TYPE_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 0 | XSL-FO enumerated data type | 20080208 | |
| 11 | CO_TYPE_BASIC_LINK_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 10 | XSL-FO enumerated data type | 20090929 | |
| 12 | CO_TYPE_BASIC_LINK_END_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 11 | XSL-FO enumerated data type | 20090929 | |
| 13 | CO_TYPE_BLOCK_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 2 | XSL-FO enumerated data type | 20080208 | |
| 14 | CO_TYPE_IMAGE_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 7 | XSL-FO enumerated data type | 20081118 | |
| 15 | CO_TYPE_INLINE_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 4 | XSL-FO enumerated data type | 20080208 | |
| 16 | CO_TYPE_LEADER_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 6 | XSL-FO enumerated data type | 20080305 | |
| 17 | CO_TYPE_LINE_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 3 | XSL-FO enumerated data type | 20080208 | |
| 18 | CO_TYPE_PAGENR_CITATION_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 9 | XSL-FO enumerated data type | 20090911 | |
| 19 | CO_TYPE_PAGENUMBER_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 8 | XSL-FO enumerated data type | 20090911 | |
| 20 | CO_TYPE_PAGE_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 1 | XSL-FO enumerated data type | 20080218 | |
| 21 | CO_TYPE_TEXT_AREA |
Constant | Public | Type reference (TYPE) | XSLFO_ENUM | 5 | XSL-FO enumerated data type | 20080208 | |
| 22 | MO_FIRST_CHILD |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_XSLFO_AREA | Area - super class | 20080206 | ||
| 23 | MO_FOLLOWING |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_XSLFO_AREA | Area - super class | 20080206 | ||
| 24 | MO_LAST_CHILD |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_XSLFO_AREA | Area - super class | 20080206 | ||
| 25 | MO_MARKS |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_XSLFO_AREA_MARKS | 20080220 | |||
| 26 | MO_PARENT |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_XSLFO_AREA | Area - super class | 20080206 | ||
| 27 | MO_PRECEDING |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_XSLFO_AREA | Area - super class | 20080206 | ||
| 28 | MV_BOTTOM |
Instance attribute | Public | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080215 | ||
| 29 | MV_CLASS |
Instance attribute | Public | Type reference (TYPE) | XSLFO_ENUM | XSL-FO enumerated data type | 20080215 | ||
| 30 | MV_HEIGHT |
Instance attribute | Public | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080215 | ||
| 31 | MV_LEFT |
Instance attribute | Public | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080215 | ||
| 32 | MV_NAME |
Instance attribute | Public | Type reference (TYPE) | STRING | 20080207 | |||
| 33 | MV_RIGHT |
Instance attribute | Public | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080215 | ||
| 34 | MV_TOP |
Instance attribute | Public | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080215 | ||
| 35 | MV_TYPE |
Instance attribute | Public | Type reference (TYPE) | XSLFO_ENUM | XSL-FO enumerated data type | 20080206 | ||
| 36 | MV_WIDTH |
Instance attribute | Public | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080215 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_CHILD |
Instance method | Public | Method | Add area as last child | 20080206 |
| 2 | ADD_FIRST_CHILD |
Instance method | Public | Method | Add area as first child | 20080215 |
| 3 | FIND_CHILD_BY_NAME |
Instance method | Public | Method | Find child area by its name | 20080215 |
| 4 | GET_CLASS |
Instance method | Public | Method | Get class of area (normal,absolute) | 20080215 |
| 5 | GET_NUM_OF_SPACES |
Instance method | Public | Method | get number of spaces of text area | 20090914 |
| 6 | GET_TYPE |
Instance method | Public | Method | Get type of area (page,block,inline,text,...) | 20080226 |
| 7 | HAS_CHILDREN |
Instance method | Public | Method | Return true if area has any children | 20080227 |
| 8 | IS_REFERENCE_AREA |
Instance method | Public | Method | Return true if area is reference area | 20080215 |
| 9 | IS_TEXT_IN_LINE_AREA |
Instance method | Public | Method | check whether the line area is empty or not | 20090914 |
| 10 | RECALC_HEIGHT_AND_WIDTH |
Instance method | Public | Method | Recalculate area size | 20080215 |
| 11 | REMOVE_FROM_PARENT |
Instance method | Public | Method | Remove this area from its parent and siblings | 20080215 |
| 12 | RENDER |
Instance method | Public | Method | Render area and its child areas recursively | 20080207 |
| 13 | SET_AS_REFERENCE_AREA |
Instance method | Public | Method | Set this area as reference area | 20080215 |
| 14 | TRAVERSE_FOR_BLOCK_ID |
Instance method | Public | Method | Run through the areas to identify the block id | 20090914 |
Events
Class CL_XSLFO_AREA has no event.
Types
Class CL_XSLFO_AREA has no local type.
Method Signatures
Method ADD_CHILD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_AREA | Call by reference | Object reference (TYPE REF TO) | CL_XSLFO_AREA | 20080206 |
Method ADD_CHILD on class CL_XSLFO_AREA has no exception.
Method ADD_FIRST_CHILD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_AREA | Call by reference | Object reference (TYPE REF TO) | CL_XSLFO_AREA | 20080215 |
Method ADD_FIRST_CHILD on class CL_XSLFO_AREA has no exception.
Method FIND_CHILD_BY_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | STRING | 20080215 | |||
| 2 |  Returning |
RO_AREA | Value transfer | Object reference (TYPE REF TO) | CL_XSLFO_AREA | 20080215 |
Method FIND_CHILD_BY_NAME on class CL_XSLFO_AREA has no exception.
Method GET_CLASS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_CLASS | Value transfer | Type reference (TYPE) | XSLFO_ENUM | XSL-FO enumerated data type | 20080215 |
Method GET_CLASS on class CL_XSLFO_AREA has no exception.
Method GET_NUM_OF_SPACES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
IV_NUM_SPACES | Call by reference | Type reference (TYPE) | I | Number of spaces in a line area | 20090914 | ||
| 2 |  Changing |
IV_SPACE_END_LAST_LINE | Call by reference | Type reference (TYPE) | ABAP_BOOL | True, if the line area ends with space | 20090914 | ||
| 3 | Exporting |
IV_SPACE_WIDTH | Call by reference | Type reference (TYPE) | I | 20090914 |
Method GET_NUM_OF_SPACES on class CL_XSLFO_AREA has no exception.
Method GET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_TYPE | Value transfer | Type reference (TYPE) | XSLFO_ENUM | XSL-FO enumerated data type | 20080226 |
Method GET_TYPE on class CL_XSLFO_AREA has no exception.
Method HAS_CHILDREN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_BOOL | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20080227 |
Method HAS_CHILDREN on class CL_XSLFO_AREA has no exception.
Method IS_REFERENCE_AREA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_BOOL | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20080215 |
Method IS_REFERENCE_AREA on class CL_XSLFO_AREA has no exception.
Method IS_TEXT_IN_LINE_AREA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
IV_NOT_EMPTY | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090914 |
Method IS_TEXT_IN_LINE_AREA on class CL_XSLFO_AREA has no exception.
Method RECALC_HEIGHT_AND_WIDTH Signature
Method RECALC_HEIGHT_AND_WIDTH on class CL_XSLFO_AREA has no parameter.
Method RECALC_HEIGHT_AND_WIDTH on class CL_XSLFO_AREA has no exception.
Method REMOVE_FROM_PARENT Signature
Method REMOVE_FROM_PARENT on class CL_XSLFO_AREA has no parameter.
Method REMOVE_FROM_PARENT on class CL_XSLFO_AREA has no exception.
Method RENDER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ALIGN | Call by reference | Type reference (TYPE) | I | Kind of alingment | 20090914 | ||
| 2 | Importing |
IV_BASELINE | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080220 | ||
| 3 | Importing |
IV_DELTA_SPACE | Call by reference | Type reference (TYPE) | I | the delta shiffting for space | 20090914 | ||
| 4 | Importing |
IV_REFX | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080222 | ||
| 5 | Importing |
IV_REFY | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080222 | ||
| 6 | Changing |
IV_REST_LINE_WIDTH | Call by reference | Type reference (TYPE) | I | Different Width between line compared to widest line | 20090914 | ||
| 7 | Changing |
IV_REST_SPACE | Call by reference | Type reference (TYPE) | I | Addition shiffting for space | 20090914 | ||
| 8 | Importing |
IV_X | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080208 | ||
| 9 | Importing |
IV_Y | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20080208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_XSLFO_OUTPUT_ERROR |
XSL-FO Render Error | 20081014 |
Method SET_AS_REFERENCE_AREA Signature
Method SET_AS_REFERENCE_AREA on class CL_XSLFO_AREA has no parameter.
Method SET_AS_REFERENCE_AREA on class CL_XSLFO_AREA has no exception.
Method TRAVERSE_FOR_BLOCK_ID Signature
Method TRAVERSE_FOR_BLOCK_ID on class CL_XSLFO_AREA has no parameter.
Method TRAVERSE_FOR_BLOCK_ID on class CL_XSLFO_AREA has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 711 |
