Constructor Detail

• UiControllerRoot

  public UiControllerRoot()

Method Detail

• getId

  public String getId()

  Description copied from interface: UiController
  The ID of a controller should only contain ASCII letters, Latin digits, hyphens or underscores. It may also contain slashes ('/') or the hash sign ('#'). It must not contain '?', '&', '=', ':', ';', '\\' or ' '.

  Returns:

  the ID of this object.

  See Also:

  UiController.ID_ROOT, UiController.ID_PAGE, UiController.ID_HOME

• getTitle

  public String getTitle()

  Specified by:

  getTitle in interface AttributeReadTitle

  Specified by:

  getTitle in interface UiController<UiSlot>

  Overrides:

  getTitle in class AbstractUiController<UiSlot>

  Returns:

  the title of this object. Similar to text but more exposed (e.g. displayed in title-bar in case of a window). Will be the empty String if not set.

• createView

  protected UiSlot createView()

  Specified by:

  createView in class AbstractUiController<UiSlot>

  Returns:

  the new instance of the view.

• doEmbed

  protected boolean doEmbed​(String slotId,
                            UiController<?> childController)

  Description copied from class: AbstractUiController
  Override this method for parent controllers to embed children.

  Overrides:

  doEmbed in class AbstractUiController<UiSlot>

  Parameters:

  slotId - the slot ID where to embed the given child UiControllers view.

  childController - the child controller to embed.

  Returns:

  true if the embedded slot is dynamic (e.g. a new closable tab), false otherwise if static and reusable slot in the UI (default).

  See Also:

  AbstractUiController.embed(UiEmbedding, UiController)

• onShow

  protected void onShow()

  Description copied from class: AbstractUiController
  This method gets called whenever the view is shown on the screen. It can be overridden to trigger custom logic - e.g. to update data.

  Overrides:

  onShow in class AbstractUiController<UiSlot>

• doShow

  protected final UiEmbedding doShow​(UiPlace newPlace,
                                     UiEmbedding newSlot)

  Specified by:

  doShow in class AbstractUiController<UiSlot>

  Parameters:

  newPlace - the UiPlace to open. It identifies the leaf child UiController and provides potential parameters.

  newSlot - the optional UiEmbedding where to embed the child controller.

  Returns:

  the UiEmbedding where to embed this controller into a parent controller or null if this is the root controller.