|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.universAAL.middleware.bus.member.BusMember
org.universAAL.middleware.bus.member.Caller
org.universAAL.middleware.ui.UICaller
public abstract class UICaller
Provides the interface to be implemented by applications together with shared
code. Only instances of this class can send UIRequest
s. The
convention of the IUIBus
regarding the registration parameters is the
following:
UICaller
s provide no registration parametersUIHandler
s may pass an array of
UIHandlerProfile
s as their initial
subscriptions and can always add new (and remove old) subscriptions
dynamically.
Field Summary |
---|
Fields inherited from class org.universAAL.middleware.bus.member.BusMember |
---|
busResourceURI, owner, theBus |
Constructor Summary | |
---|---|
protected |
UICaller(ModuleContext context)
Instantiates a new UICaller . |
Method Summary | |
---|---|
void |
abortDialog(String dialogID)
Abort dialog. |
void |
adaptationParametersChanged(UIRequest call,
String changedProp)
Adaptation parameters changed. |
void |
busDyingOut(AbstractBus bus)
This method is called when the bus is stopped to announce this to the bus members. |
abstract void |
communicationChannelBroken()
Method to be called when the communication of the UICaller with
the IDialogManager is lost. |
abstract void |
dialogAborted(String dialogID,
Resource data)
Dialog aborted. |
void |
dialogSuspended(String dialogID)
Dialog suspended. |
String |
getMyID()
Id with which the UICaller is registered in the IUIBus |
void |
handleReply(BusMessage msg)
Handle reply. |
abstract void |
handleUIResponse(UIResponse uiResponse)
Handle UIResponse - that comes from UIHandler carrying
user input. |
void |
resumeDialog(String dialogID,
Resource dialogData)
Resume dialog. |
void |
sendUIRequest(UIRequest uiRequest)
Sends UIRequest . |
Methods inherited from class org.universAAL.middleware.bus.member.BusMember |
---|
close, getType, getURI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected UICaller(ModuleContext context)
UICaller
.
context
- the module contextMethod Detail |
---|
public void abortDialog(String dialogID)
dialogID
- the dialog idpublic final void adaptationParametersChanged(UIRequest call, String changedProp)
call
- the UIRequest
changedProp
- the changed proppublic final void busDyingOut(AbstractBus bus)
BusMember
busDyingOut
in class BusMember
bus
- bus on which this member has been registeredBusMember.busDyingOut(AbstractBus)
public abstract void communicationChannelBroken()
UICaller
with
the IDialogManager
is lost.
Any pending request might be resend at this point.
All affected pending dialogs will be aborted
right after this call (with null data).
public abstract void dialogAborted(String dialogID, Resource data)
dialogID
- the dialog iddata
- the data collected up until abortion, it might be null if the data could not be retrieved.public final void dialogSuspended(String dialogID)
dialogID
- the dialog idpublic final void handleReply(BusMessage msg)
msg
- the BusMessage
public abstract void handleUIResponse(UIResponse uiResponse)
UIResponse
- that comes from UIHandler
carrying
user input.
uiResponse
- the UIResponse
public void resumeDialog(String dialogID, Resource dialogData)
dialogID
- the dialog iddialogData
- the dialog datapublic final void sendUIRequest(UIRequest uiRequest)
UIRequest
.
uiRequest
- the UIRequest
NullPointerException
- if the ui request is nullpublic String getMyID()
UICaller
is registered in the IUIBus
UICaller
ID
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |