iPageUIExtension
deprecated api
**<del>Deprecated</del>**
If you need to include: * JS/CSS files/snippets, use {@see \iBackofficeLinkedScriptsExtension}, {@see \iBackofficeLinkedStylesheetsExtension}, etc instead * HTML (and optionally JS/CSS), use {@see \iPageUIBlockExtension} to manipulate {@see \Combodo\iTop\Application\UI\Base\UIBlock} instead
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 | 2.0 |
|---|---|
| deprecated |
* JS/CSS files/snippets, use {@see \iBackofficeLinkedScriptsExtension}, {@see \iBackofficeLinkedStylesheetsExtension}, etc instead
-
HTML (and optionally JS/CSS), use {@see \iPageUIBlockExtension} to manipulate {@see \Combodo\iTop\Application\UI\Base\UIBlock} instead |
Public methods
GetBannerHtml
public
Add content to the "admin banner"
public GetBannerHtml($oPage)
Parameters
| types | name | default | description |
|---|---|---|---|
| \iTopWebPage | $oPage | The page to insert stuff into. |
Returns
string The HTML content to add into the page
GetNorthPaneHtml
public
Add content to the header of the page
public GetNorthPaneHtml($oPage)
Parameters
| types | name | default | description |
|---|---|---|---|
| \iTopWebPage | $oPage | The page to insert stuff into. |
Returns
string The HTML content to add into the page
GetSouthPaneHtml
public
Add content to the footer of the page
public GetSouthPaneHtml($oPage)
Parameters
| types | name | default | description |
|---|---|---|---|
| \iTopWebPage | $oPage | The page to insert stuff into. |
Returns
string The HTML content to add into the page