:: Version 3.2.0 ::
iPageUIBlockExtension
api
Implement this interface to add content to any iTopWebPage
There are 3 places where content can be added:
- The north pane: (normaly empty/hidden) at the top of the page, spanning the whole width of the page
- The south pane: (normaly empty/hidden) at the bottom of the page, spanning the whole width of the page
- The admin banner (two tones gray background) at the left of the global search. Limited space, use it for short messages
Each of the methods of this interface is supposed to return the HTML to be inserted at the specified place and can use the passed iTopWebPage object to add javascript or CSS definitions
Tags
| since | 3.0.0 |
|---|
API synthesis
List of the public API methods. When manipulating iPageUIBlockExtension, You can call those methods:
-
GetBannerBlock() — Add content to the “admin banner”
-
GetFooterBlock() — Add content to the footer of the page
-
GetHeaderBlock() — Add content to the header of the page
Public methods
GetBannerBlock
api public
Add content to the "admin banner"
public GetBannerBlock()
Parameters
none
Returns
\Combodo\iTop\Application\UI\Base\iUIBlock|null The Block to add into the page
GetFooterBlock
api public
Add content to the footer of the page
public GetFooterBlock()
Parameters
none
Returns
\Combodo\iTop\Application\UI\Base\iUIBlock|null The Block to add into the page
GetHeaderBlock
api public
Add content to the header of the page
public GetHeaderBlock()
Parameters
none
Returns
\Combodo\iTop\Application\UI\Base\iUIBlock|null The Block to add into the page
3_2_0/customization/api/extensions/ipageuiblockextension.txt
· Last modified: 2024/09/10 10:25 by 127.0.0.1