Interface KaAPI.KUIComponent 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface KaAPI.KUIComponent

public interface KUIComponent
extends Object
All CLASSes that should be part of the KaAPI framework should implement this interface
Version:
1.1 04 Aug 1996
Author:
shiva
See Also:
KFrame

Variable Index

o UIC_LOCATION_CENTER
o UIC_LOCATION_EAST
o UIC_LOCATION_NONE
o UIC_LOCATION_NORTH
o UIC_LOCATION_SOUTH
o UIC_LOCATION_WEST
o UIC_MAX_LOCATIONS
o UIC_VISIBILITY_HIDE
o UIC_VISIBILITY_SHOW
o UIC_VISIBILITY_TOGGLE

Method Index

o addUIC(KUIComponent)
This function will be called only for a Container KUIComponent when a KUIComponent is to be added to this Container.
o getUICLocation()
Should return the location information got from frameAgent.getLocation()
o getUICVisibility()
Should return the visibility information got from frameAgent.getVisibility()
o initUIC(String[], String[], String[], KFrameAgent)
Constructor for the KUIComponent.
o setUICVisibility(int)
This function resets the visibility information.This should return a boolean value indicating if it has accepeted the change in its visibility.

Variables

o UIC_LOCATION_NONE 
  public final static int UIC_LOCATION_NONE
o UIC_LOCATION_SOUTH 
  public final static int UIC_LOCATION_SOUTH
o UIC_LOCATION_NORTH 
  public final static int UIC_LOCATION_NORTH
o UIC_LOCATION_EAST 
  public final static int UIC_LOCATION_EAST
o UIC_LOCATION_WEST 
  public final static int UIC_LOCATION_WEST
o UIC_LOCATION_CENTER 
  public final static int UIC_LOCATION_CENTER
o UIC_MAX_LOCATIONS 
  public final static int UIC_MAX_LOCATIONS
o UIC_VISIBILITY_TOGGLE 
  public final static int UIC_VISIBILITY_TOGGLE
o UIC_VISIBILITY_SHOW 
  public final static int UIC_VISIBILITY_SHOW
o UIC_VISIBILITY_HIDE 
  public final static int UIC_VISIBILITY_HIDE

Methods

o initUIC 
  public abstract void initUIC(String argsKaapi[],
                               String argsKuic[],
                               String uicLinks[],
                               KFrameAgent frameAgent)
Constructor for the KUIComponent.

To get the location and visibility information use frameAgent.getLocation(argsKaapi) , frameAgent.getVisibility(argsKaapi)

Caution : frameAgent.getKUIC(uicLinks[]) should not be called from this function.
Parameters:
argsKaapi - Arguments that are specific to KaAPI framework
argsKuic - Arguments that are defined for the KUIComponent
uicLinks - an array containing the links to other KUIComponents
frameAgent - An Agent to communicate with the KFrame object
o getUICLocation 
  public abstract int getUICLocation()
Should return the location information got from frameAgent.getLocation()
o getUICVisibility 
  public abstract int getUICVisibility()
Should return the visibility information got from frameAgent.getVisibility()
o setUICVisibility 
  public abstract boolean setUICVisibility(int visFlag)
This function resets the visibility information.This should return a boolean value indicating if it has accepeted the change in its visibility.
Parameters:
visFlag - should be one of UIC_VISIBILITY_XXXX
Returns:
true if it has accepeted the visFlag and false otherwise
o addUIC 
  public abstract void addUIC(KUIComponent kuiComp)
This function will be called only for a Container KUIComponent when a KUIComponent is to be added to this Container.
Parameters:
kuiComp - the KUIComponent to be added to this container. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index