Interface IAppHistoryEntry

  • All Known Implementing Classes:
    AppHistoryEntry

    public interface IAppHistoryEntry
    An entry in the application history.

    It is used for backward and optionally forward navigation. The main purpose for this class is to provide information for programmatical use. The information held gets its information from the IAppSessionGyro instance.

    Author:
    Christopher Mindus
    See Also:
    IAppHistory, IAppSessionGyro
    • Method Detail

      • setBackwardInfo

        boolean setBackwardInfo​(UIComp uiComp)
        Sets the backward UI focus information for the entry. It is recommended to also set the VirtualSpace component too, using setBackwardInfo(IVSComponent).
        Parameters:
        uiComp - The UI component, null for none.
        Returns:
        true for changed values, false for no changes.
        Throws:
        java.lang.IllegalArgumentException - If the parameter is not valid.
      • setForwardInfo

        boolean setForwardInfo​(UIComp uiComp)
        Sets the forward UI focus information for the entry. It is recommended to also set the VirtualSpace component too, using setForwardInfo(IVSComponent).
        Parameters:
        uiComp - The UI component, null for none.
        Returns:
        true for changed values, false for no changes.
        Throws:
        java.lang.IllegalArgumentException - If the parameter is not valid.
      • setBackwardInfo

        boolean setBackwardInfo​(IVSComponent vsComp)
        Sets the backward VirtualSpace focus information for the entry.
        Parameters:
        vsComp - The VS component, null for none.
        Returns:
        true for changed values, false for no changes.
        Throws:
        java.lang.IllegalArgumentException - If the parameter is not valid.
      • setForwardInfo

        boolean setForwardInfo​(IVSComponent vsComp)
        Sets the forward VirtualSpace focus information for the entry.
        Parameters:
        vsComp - The VS component, null for none.
        Returns:
        true for changed values, false for no changes.
        Throws:
        java.lang.IllegalArgumentException - If the parameter is not valid.
      • setBackwardInfo

        boolean setBackwardInfo​(IAppHistoryBackward backward)
        Sets the backward programmatic operation to use for the entry.
        Parameters:
        backward - The instance of the backward operation to use or null for none.
        Returns:
        true for changed values, false for no changes.
      • setForwardInfo

        boolean setForwardInfo​(IAppHistoryForward forward)
        Sets the forward programmatic operation to use for the entry.
        Parameters:
        forward - The instance of the backward operation to use or null for none.
        Returns:
        true for changed values, false for no changes.
      • setBackwardAnimation

        boolean setBackwardAnimation​(int animation)
        Sets the backward panel animation.
        Parameters:
        animation - The animation value, or -1 for none.
        Returns:
        true if value changed, false for no change.
        Throws:
        java.lang.IllegalArgumentException - If the animation value is not acceptable, i.e. is not a value that comes from the IUIPanelAnimation class.
      • setForwardAnimation

        boolean setForwardAnimation​(int animation)
        Sets the forward panel animation.
        Parameters:
        animation - The animation value, or -1 for none.
        Returns:
        true if value changed, false for no change.
        Throws:
        java.lang.IllegalArgumentException - If the animation value is not acceptable, i.e. is not a value that comes from the IUIPanelAnimation class.
      • getBackwardUIFocus

        java.lang.String getBackwardUIFocus()
        Gets the UI reference to the backward focus.
        Returns:
        The property reference for the backward UI focus, null for none.
      • getForwardUIFocus

        java.lang.String getForwardUIFocus()
        Gets the UI reference to the forward focus.
        Returns:
        The property reference for the forward UI focus, null for none.
      • getBackwardVSFocus

        IVSComponent getBackwardVSFocus()
        Gets the non-virtualized VS component for backward focus.
        Returns:
        The non-virtualized VS component for backward focus, null for none.
      • getForwardVSFocus

        IVSComponent getForwardVSFocus()
        Gets the non-virtualized VS component for forward focus.
        Returns:
        The non-virtualized VS component for forward focus, null for none.
      • getBackwardOperation

        IAppHistoryBackward getBackwardOperation()
        Gets the programmatic operation for backward.
        Returns:
        The interface instance, null for none.
      • getForwardOperation

        IAppHistoryForward getForwardOperation()
        Gets the programmatic operation for forward.
        Returns:
        The interface instance, null for none.
      • getBackwardAnimation

        int getBackwardAnimation()
        Gets the backward panel animation.
        Returns:
        The panel animation, or -1 for none.
      • getForwardAnimation

        int getForwardAnimation()
        Gets the forward panel animation.
        Returns:
        The panel animation, or -1 for none.
      • isBackwardEnabled

        java.lang.String isBackwardEnabled​(IClientSessionGyro clientGyro)
        Returns if the backward operation is enabled or not.

        If a null String is returned, the operation is enabled, otherwise the string is the reason why to operation is disabled. This reason is used typically for developers, logging and debugging.

        Parameters:
        clientGyro - The client session requesting the backward operation enabled state.
        Returns:
        Default null meaning enabled, otherwise the reason string for being disabled.
      • isForwardEnabled

        java.lang.String isForwardEnabled​(IClientSessionGyro clientGyro)
        Returns if the forward operation is enabled or not.

        If a null String is returned, the operation is enabled, otherwise the string is the reason why to operation is disabled. This reason is used typically for developers, logging and debugging.

        Parameters:
        clientGyro - The client session requesting the forward operation enabled state.
        Returns:
        Default null meaning enabled, otherwise the reason string for being disabled.
      • performBackward

        java.lang.String performBackward​(IClientSessionGyro clientGyro,
                                         IAppHistoryOperationCompleted completedCallback)
        Performs the backward operation for the client session in question.

        If a null String is returned, the operation is enabled, otherwise the string is the reason why to operation is disabled. This reason is used typically for developers, logging and debugging.

        Note: this operation may be lengthy and may not complete in the same thread. This means that the completedCallback could be called from another thread.

        Parameters:
        clientGyro - The client session requesting the backward operation execution.
        completedCallback - The callback is called when operation has completed, null for none.
        Returns:
        Default null meaning enabled and the operation has begun (perhaps not completed yet), otherwise the reason string for being disabled.
      • performForward

        java.lang.String performForward​(IClientSessionGyro clientGyro,
                                        IAppHistoryOperationCompleted completedCallback)
        Performs the forward operation for the client session in question.

        If a null String is returned, the operation is enabled, otherwise the string is the reason why to operation is disabled. This reason is used typically for developers, logging and debugging.

        Note: this operation may be lengthy and may not complete in the same thread. This means that the completedCallback could be called from another thread.

        Parameters:
        clientGyro - The client session requesting the forward operation execution.
        completedCallback - The callback is called when operation has completed, null for none.
        Returns:
        Default null meaning enabled and the operation has begun (perhaps not completed yet), otherwise the reason string for being disabled.
      • isBackwardFocusEnabled

        java.lang.String isBackwardFocusEnabled​(IClientSessionGyro clientGyro)
        Returns if the focus to the backward UI component if possible, otherwise the VS component. This method is intended to be used for programmatic history operation that also includes a focus part that requires a call to setBackwardFocus(IClientSessionGyro). This method should be called during the processing of IAppHistoryBackward.isBackwardEnabled(IAppHistoryEntry, IClientSessionGyro).
        Parameters:
        clientGyro - The client session requesting the forward operation execution.
        Returns:
        Failure string, i.e. null for success, otherwise an error message.
      • isForwardFocusEnabled

        java.lang.String isForwardFocusEnabled​(IClientSessionGyro clientGyro)
        Returns if the focus to the forward UI component if possible, otherwise the VS component. This method is intended to be used for programmatic history operation that also includes a focus part that requires a call to setForwardFocus(IClientSessionGyro). This method should be called during the processing of IAppHistoryForward.isForwardEnabled(IAppHistoryEntry, IClientSessionGyro).
        Parameters:
        clientGyro - The client session requesting the forward operation execution.
        Returns:
        Failure string, i.e. null for success, otherwise an error message.
      • setBackwardFocus

        java.lang.String setBackwardFocus​(IClientSessionGyro clientGyro)
        Sets the focus to the backward UI component if possible, otherwise the VS component.

        Focus is set as:

        1. If the UI component is defined, the currently open panels will be used to verify if this reference matches, and if so, that component will be focused. If it didn't match, or in case the request focus operation failed, the UI component will not be used for focusing, rather step 2 below.
        2. If the VS component is specified, it will be used to set the focus, and perhaps virtualized a VirtualSpace and/or panel(s).

        This method is intended to be used if the programmatic operations instance needs to set the focus from the data saved in this history entry.

        Parameters:
        clientGyro - The client session requesting the forward operation execution.
        Returns:
        Failure string, i.e. null for success, otherwise an error message.
      • setForwardFocus

        java.lang.String setForwardFocus​(IClientSessionGyro clientGyro)
        Sets the focus to the forward UI component if possible, otherwise the VS component.

        Focus is set as:

        1. If the UI component is defined, the currently open panels will be used to verify if this reference matches, and if so, that component will be focused. If it didn't match, or in case the request focus operation failed, the UI component will not be used for focusing, rather step 2 below.
        2. If the VS component is specified, it will be used to set the focus, and perhaps virtualized a VirtualSpace and/or panel(s).

        This method is intended to be used if the programmatic operations instance needs to set the focus from the data saved in this history entry.

        Parameters:
        clientGyro - The client session requesting the forward operation execution.
        Returns:
        Failure string, i.e. null for success, otherwise an error message.