Interface luya\admin\ngrest\base\ActiveWindowInterface
Active Window Interface.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| getIcon() | Return the current icon defined for this Active Window. | luya\admin\ngrest\base\ActiveWindowInterface |
| getIsCompositeItem() | luya\admin\ngrest\base\ActiveWindowInterface | |
| getItemId() | Get the item id of the current ActiveWindow context item id. | luya\admin\ngrest\base\ActiveWindowInterface |
| getItemIds() | Returns an array with all items if its a composite key. | luya\admin\ngrest\base\ActiveWindowInterface |
| getLabel() | Return the current label defined for this Active Window. | luya\admin\ngrest\base\ActiveWindowInterface |
| getTitle() | By default the title just returns the {{getLabel()}} value if not overriden. | luya\admin\ngrest\base\ActiveWindowInterface |
| index() | The default action which is going to be requested when clicking the active window. | luya\admin\ngrest\base\ActiveWindowInterface |
| setActiveWindowHash() | Set the hash of the current active window which is calculated by the ActiveWindow. | luya\admin\ngrest\base\ActiveWindowInterface |
| setConfigHash() | Set the current configratuion hash name to the ActiveWindow. | luya\admin\ngrest\base\ActiveWindowInterface |
| setItemId() | Set the value of the item Id in where the active window context is initialized. | luya\admin\ngrest\base\ActiveWindowInterface |
Method Details
Return the current icon defined for this Active Window.
| public abstract string getIcon ( ) | ||
| return | string |
Returns the material icon name as string. |
|---|---|---|
public function getIcon();
| public abstract \luya\admin\ngrest\base\Whether getIsCompositeItem ( ) | ||
| return | \luya\admin\ngrest\base\Whether |
The current item is a composite key or not. |
|---|---|---|
public function getIsCompositeItem();
Get the item id of the current ActiveWindow context item id.
| public abstract integer|array getItemId ( ) | ||
| return | integer|array |
If its a composite key an array is returned, otherwise the integer number for the PK. |
|---|---|---|
public function getItemId();
Returns an array with all items if its a composite key.
| public abstract array getItemIds ( ) |
public function getItemIds();
Return the current label defined for this Active Window.
| public abstract string getLabel ( ) | ||
| return | string |
Returns the label of the active window, keep in mind this value has not model context. |
|---|---|---|
public function getLabel();
By default the title just returns the {{getLabel()}} value if not overriden.
In getTitle() its allowed to access the model context, which is not allowed in {{getLabel()}}.
Display the username as title could look like this:
public function getTitle()
{
return $this->model->username;
}
| public abstract string getTitle ( ) | ||
| return | string |
Returns the title string which can have model context. |
|---|---|---|
public function getTitle();
The default action which is going to be requested when clicking the active window.
| public abstract string index ( ) | ||
| return | string |
The response string, render and displayed trough the angular ajax request. |
|---|---|---|
public function index();
Set the hash of the current active window which is calculated by the ActiveWindow.
Setting the hash happens in the {{luya\admin\ngrest\render\RenderActiveWindow::render}} method.
| public abstract void setActiveWindowHash ( $hash ) | ||
| $hash | string | |
public function setActiveWindowHash($hash);
Set the current configratuion hash name to the ActiveWindow.
Setting the hash happens in the {{luya\admin\ngrest\render\RenderActiveWindow::render}} method.
| public abstract void setConfigHash ( $hash ) | ||
| $hash | string |
The hash name of the current active config. |
public function setConfigHash($hash);