Package com._1c.g5.aef2.scenes

Interface IScene

All Superinterfaces:
IServiceEventTracker
All Known Implementing Classes:
Scene
public interface IScene extends IServiceEventTracker
Scene manages the component tree.
See Also:

  • Method Details

    • getEngine

      IEngine getEngine()
      Returns:
      the engine this scene belongs to.

    • getRenderer

      IRenderer<?> getRenderer()
      Returns:
      this scene renderer.

    • setComponent

      void setComponent(IComponent<?> component)
      Sets the root component of this scene.
      Parameters:
      component - the component to set as the root.

    • getComponent

      IComponent<?> getComponent()
      Returns the root component of this scene.
      Returns:
      the root component of this scene.

    • setRenderer

      void setRenderer(IRenderer<?> renderer)
      Sets this scene renderer.
      Parameters:
      renderer - the renderer to set.

    • refresh

      void refresh()
      Refreshes this scene presentation completely.

    • refresh

      void refresh(IComponent<?> component)
      Refreshes this scene's subtree presentation starting at the given component.
      Parameters:
      component - the component to start from.

    • relayout

      void relayout()
      Triggers this scene's layout processing.

    • commit

      void commit(IComponent<?> component)
      Commits the model for the given component.
      Parameters:
      component - the component to perform commit for.
      See Also:

    • addSceneListener

      void addSceneListener(ISceneListener listener)
      Adds this scene listener.
      Parameters:
      listener - the listener to add.

    • removeSceneListener

      void removeSceneListener(ISceneListener listener)
      Removes this scene listener.
      Parameters:
      listener - the listener to remove.

    • dispose

      void dispose()
      Disposes this scene.

    • registerServiceConsumer

      void registerServiceConsumer(IServiceConsumer<?> serviceConsumer)
      Registers a given service consumer instance.
      Parameters:
      serviceConsumer - a service consumer.
      See Also:

    • registerSearchProvider

      void registerSearchProvider(IComponentSearchProvider searchProvider)
      Registers a provider to be used by the scene for searching components.
      Parameters:
      searchProvider - The search provider

    • unregisterSearchProvider

      void unregisterSearchProvider(IComponentSearchProvider searchProvider)
      Unregisters a provider used by the scene for searching components.
      Parameters:
      delegate - The identifying delegate

    • queueEvent

      void queueEvent(Object query, IClientEvent event)
      Finds a component by a query using the registered search providers and queues an event for it.
      Parameters:
      query - The query for identifying the component to queue the event to
      event - The event to be queued
      See Also:

    • handleComponentEvent

      void handleComponentEvent(IComponent<?> component, IEvent event)
      Notifies the scene that a component-specific event has happened.
      Parameters:
      component - The component from which originates the event
      event - The event that has happened with the component

    • putState

      IState putState(IComponent<?> component, IState state)
      Puts the specified state for the given component.
      Parameters:
      component - the component, cannot be null.
      state - the state, can be null if there are no previous state for the specified component
      Returns:
      the previous stored state, can be null.

    • clearState

      IState clearState(IComponent<?> component)
      Clears state for the given component.
      Parameters:
      component - the component, cannot be null.
      Returns:
      the previous stored state, can be null if there are no state for the specified component.

    • getState

      IState getState(IComponent<?> component)
      Returns the current state for the given component.
      Parameters:
      component - the component, cannot be null.
      Returns:
      the current state, can be null if there are no state for the specified component.