public interface IAppHistoryEntry
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.
IAppHistory
,
IAppSessionGyro
Modifier and Type | Method and Description |
---|---|
int |
getBackwardAnimation()
Gets the backward panel animation.
|
IAppHistoryBackward |
getBackwardOperation()
Gets the programmatic operation for backward.
|
String |
getBackwardUIFocus()
Gets the UI reference to the backward focus.
|
IVSComponent |
getBackwardVSFocus()
Gets the non-virtualized VS component for backward focus.
|
int |
getForwardAnimation()
Gets the forward panel animation.
|
IAppHistoryForward |
getForwardOperation()
Gets the programmatic operation for forward.
|
String |
getForwardUIFocus()
Gets the UI reference to the forward focus.
|
IVSComponent |
getForwardVSFocus()
Gets the non-virtualized VS component for forward focus.
|
String |
isBackwardEnabled(IClientSessionGyro clientGyro)
Returns if the backward operation is enabled or not.
|
String |
isBackwardFocusEnabled(IClientSessionGyro clientGyro)
Returns if the focus to the backward UI component if possible, otherwise the VS component.
|
String |
isForwardEnabled(IClientSessionGyro clientGyro)
Returns if the forward operation is enabled or not.
|
String |
isForwardFocusEnabled(IClientSessionGyro clientGyro)
Returns if the focus to the forward UI component if possible, otherwise the VS component.
|
String |
performBackward(IClientSessionGyro clientGyro,
IAppHistoryOperationCompleted completedCallback)
Performs the backward operation for the client session in question.
|
String |
performForward(IClientSessionGyro clientGyro,
IAppHistoryOperationCompleted completedCallback)
Performs the forward operation for the client session in question.
|
boolean |
setBackwardAnimation(int animation)
Sets the backward panel animation.
|
String |
setBackwardFocus(IClientSessionGyro clientGyro)
Sets the focus to the backward UI component if possible, otherwise the VS component.
|
boolean |
setBackwardInfo(IAppHistoryBackward backward)
Sets the backward programmatic operation to use for the entry.
|
boolean |
setBackwardInfo(IVSComponent vsComp)
Sets the backward VirtualSpace focus information for the entry.
|
boolean |
setBackwardInfo(UIComp uiComp)
Sets the backward UI focus information for the entry.
|
boolean |
setForwardAnimation(int animation)
Sets the forward panel animation.
|
String |
setForwardFocus(IClientSessionGyro clientGyro)
Sets the focus to the forward UI component if possible, otherwise the VS component.
|
boolean |
setForwardInfo(IAppHistoryForward forward)
Sets the forward programmatic operation to use for the entry.
|
boolean |
setForwardInfo(IVSComponent vsComp)
Sets the forward VirtualSpace focus information for the entry.
|
boolean |
setForwardInfo(UIComp uiComp)
Sets the forward UI focus information for the entry.
|
boolean setBackwardInfo(UIComp uiComp)
setBackwardInfo(IVSComponent)
.uiComp
- The UI component, null for none.IllegalArgumentException
- If the parameter is not valid.boolean setForwardInfo(UIComp uiComp)
setForwardInfo(IVSComponent)
.uiComp
- The UI component, null for none.IllegalArgumentException
- If the parameter is not valid.boolean setBackwardInfo(IVSComponent vsComp)
vsComp
- The VS component, null for none.IllegalArgumentException
- If the parameter is not valid.boolean setForwardInfo(IVSComponent vsComp)
vsComp
- The VS component, null for none.IllegalArgumentException
- If the parameter is not valid.boolean setBackwardInfo(IAppHistoryBackward backward)
backward
- The instance of the backward operation to use or null for none.boolean setForwardInfo(IAppHistoryForward forward)
forward
- The instance of the backward operation to use or null for none.boolean setBackwardAnimation(int animation)
animation
- The animation value, or -1 for none.IllegalArgumentException
- If the animation value is not acceptable, i.e. is
not a value that comes from the IUIPanelAnimation
class.boolean setForwardAnimation(int animation)
animation
- The animation value, or -1 for none.IllegalArgumentException
- If the animation value is not acceptable, i.e. is
not a value that comes from the IUIPanelAnimation
class.String getBackwardUIFocus()
String getForwardUIFocus()
IVSComponent getBackwardVSFocus()
IVSComponent getForwardVSFocus()
IAppHistoryBackward getBackwardOperation()
IAppHistoryForward getForwardOperation()
int getBackwardAnimation()
int getForwardAnimation()
String isBackwardEnabled(IClientSessionGyro clientGyro)
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.
clientGyro
- The client session requesting the backward operation enabled state.null
meaning enabled, otherwise the reason string for being disabled.String isForwardEnabled(IClientSessionGyro clientGyro)
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.
clientGyro
- The client session requesting the forward operation enabled state.null
meaning enabled, otherwise the reason string for being disabled.String performBackward(IClientSessionGyro clientGyro, IAppHistoryOperationCompleted completedCallback)
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.
clientGyro
- The client session requesting the backward operation execution.completedCallback
- The callback is called when operation has completed, null for none.null
meaning enabled and the operation has begun (perhaps not completed yet),
otherwise the reason string for being disabled.String performForward(IClientSessionGyro clientGyro, IAppHistoryOperationCompleted completedCallback)
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.
clientGyro
- The client session requesting the forward operation execution.completedCallback
- The callback is called when operation has completed, null for none.null
meaning enabled and the operation has begun (perhaps not completed yet),
otherwise the reason string for being disabled.String isBackwardFocusEnabled(IClientSessionGyro clientGyro)
setBackwardFocus(IClientSessionGyro)
.
This method should be called during the processing of
IAppHistoryBackward.isBackwardEnabled(IAppHistoryEntry, IClientSessionGyro)
.clientGyro
- The client session requesting the forward operation execution.String isForwardFocusEnabled(IClientSessionGyro clientGyro)
setForwardFocus(IClientSessionGyro)
.
This method should be called during the processing of
IAppHistoryForward.isForwardEnabled(IAppHistoryEntry, IClientSessionGyro)
.clientGyro
- The client session requesting the forward operation execution.String setBackwardFocus(IClientSessionGyro clientGyro)
Focus is set as:
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.
clientGyro
- The client session requesting the forward operation execution.String setForwardFocus(IClientSessionGyro clientGyro)
Focus is set as:
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.
clientGyro
- The client session requesting the forward operation execution.iizi® is a registered trademark of Mindus SARL. © Copyright 2019 Mindus SARL. All rights reserved.