de.starface.integration.uci.java.v30.messages.events
Interface UciFunctionKeyEvents


@UciService(value="ucp.v30.events.functionKey")
@RpcInterface(value="ucp.v30.events.functionKey")
@RpcValueTranslation(version=30)
public interface UciFunctionKeyEvents

This interface defines the function key events that can be received by the UCI client implementation in order to handle function key changes entries.


Method Summary
 void functionKeysChanged(List<FunctionKey> functionKeys)
          This event allows the UCI client to get informed when the configuration of the function keys of the user changed.
 void functionKeySearchTerminates(String searchId)
          This event allows the UCI client to get informed when the function key searching is terminated.
 void receiveFunctionKeyState(FunctionKey functionKeyProperties)
          The ReceiveFunctionKeyState event provides a number of properties about the function key the state is changing of.
 

Method Detail

receiveFunctionKeyState

void receiveFunctionKeyState(FunctionKey functionKeyProperties)
The ReceiveFunctionKeyState event provides a number of properties about the function key the state is changing of.

Parameters:
functionKeyProperties - the different properties of the function key

functionKeysChanged

void functionKeysChanged(List<FunctionKey> functionKeys)
This event allows the UCI client to get informed when the configuration of the function keys of the user changed.

Parameters:
functionKeys - the new function keys the user has

functionKeySearchTerminates

void functionKeySearchTerminates(String searchId)
This event allows the UCI client to get informed when the function key searching is terminated.

Parameters:
searchId - the id of the terminated search


Copyright © 2012 STARFACE GmbH. All rights reserved.