Class KaAPI.KFrameAgent

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class KaAPI.KFrameAgent

java.lang.Object
   |
   +----KaAPI.KFrameAgent

public class KFrameAgent
extends Object

This acts as an Agent between the KUIComponents and KFrame.An instance of this class is automatically created by KFrame object and is passed to KUIComponents during init time.

Version:: 1.1 20 Aug 1996
Author:: shiva

KFrameAgent(KFrame): The user should not create an instance of this class.

cloneKUIC(KUIComponent): Clones an un-named KUIComponent from the KUIComponent reference.The arguments of the KUIComponent referenced by kuicRef is used for the cloned component.
cloneKUIC(KUIComponent, String): Clones a named KUIComponent from the KUIComponent reference.The arguments of the KUIComponent referenced by kuicRef is used for the cloned component.
cloneKUIC(KUIComponent, String, String[], String[], String[], String[]): Clones a KUIComponent from the KUIComponent reference.
cloneKUIC(String): Clones an un-named KUIComponent from the variable name given.The arguments of the KUIComponent referenced by the variable name is used for the cloned component.
cloneKUIC(String, String): Clones a named KUIComponent from the variable name given.The arguments of the KUIComponent referenced by the variable name is used for the cloned component.
cloneKUIC(String, String, String[], String[], String[], String[]): Clones a KUIComponent from the variable name given.Any of the arguments except the varName can be 'null' in which case the corresponding information from KUIComponent referenced by varName is taken.
closeFrame(boolean): Closes the KFrame object associated with the Agent.
getArguments(): This returns the Arguments that are specified in <ARGS_AWT> field in the format file.This should be called only in the constructor of the KUIComponent.
getArguments(int): This returns the Arguments that are specified in <ARGS_AWT> field in the format file at the index specified.
getAwtArgs(KUIComponent): Returns the Awt arguments for KUIComponent kuicRef
getAwtArgs(String): Returns the Awt arguments for KUIComponent referenced by varName.
GetColor(String): Converts color string to java.awt.Color
getFrame(): Returns a reference to the KaAPI.KFrame object.
getKaapiArgs(KUIComponent): Returns the Kaapi arguments for KUIComponent kuicRef
getKaapiArgs(String): Returns the Kaapi arguments for KUIComponent referenced by varName.
getKUIC(String): Returns a reference to the KUIComponent given an instance name.
getKuicArgs(KUIComponent): Returns the Kuic arguments for KUIComponent kuicRef
getKuicArgs(String): Returns the Kuic arguments for KUIComponent referenced by varName.
getLocation(String[]): This returns the location information.
GetLocationString(int): Converts Location represented as int to a Location String.
getUicLinks(KUIComponent): Returns the Uiclinks arguments for KUIComponent kuicRef
getUicLinks(String): Returns the Uiclinks arguments for KUIComponent referenced by varName.
getVariableName(KUIComponent): Returns the variable name of the KUIComponent given a reference to a KUIComponent
getVisibility(String[]): This returns the visibility information.
setVisibility(KUIComponent, int): This changes the visibility for a KUIComponent
setVisibility(String, int): This changes the visibility for a KUIComponent
ToNativePath(String): Converts any pathnames to the native pathnames.

KFrameAgent

  public KFrameAgent(KFrame kFrame)

The user should not create an instance of this class.

Parameters:: kFrame - the instance of KaAPI.KFrame

getArguments

  public String[] getArguments()

This returns the Arguments that are specified in <ARGS_AWT> field in the format file.This should be called only in the constructor of the KUIComponent.

Returns:: the Arguments specified in <ARGS_AWT> field in format file

getArguments

  public String getArguments(int index)

This returns the Arguments that are specified in <ARGS_AWT> field in the format file at the index specified. This should be called only in the constructor of the KUIComponent.

Parameters:: index - the index into the list of arguments.
Returns:: the Arguments specified in <ARGS_AWT> field in format file

getKUIC

  public KUIComponent getKUIC(String varName)

Returns a reference to the KUIComponent given an instance name.

Parameters:: varName - the name of the instance
Returns:: the reference to the KUIComponent

getVariableName

  public String getVariableName(KUIComponent kuicRef)

Returns the variable name of the KUIComponent given a reference to a KUIComponent

Parameters:: kuicRef - reference to a KUIComponent
Returns:: the variable name of the KUIComponent

getFrame

  public Frame getFrame()

Returns a reference to the KaAPI.KFrame object. This call can be used to get the parent frame when creating Dialogs.

Returns:: the KaAPI.KFrame

getLocation

  public int getLocation(String argsKaapi[])

This returns the location information.

Parameters:: argsKaapi - arguments for KaAPI as speciifed in the format file
Returns:: the location as KUIComponent.UIC_LOCATION_XXXX

getVisibility

  public int getVisibility(String argsKaapi[])

This returns the visibility information.

Parameters:: argsKaapi - arguments for KaAPI as speciifed in the format file
Returns:: the KUIComponent.UIC_VISIBILITY_XXXX

setVisibility

  public boolean setVisibility(String kuicName,
                               int visFlag)

This changes the visibility for a KUIComponent

Parameters:: kuicName - name of the KUIComponent specified in format file; visFlag - should be KUIComponent.UIC_VISIBILITY_XXXX
Returns:: true if the visibility change has been accepted by the KUIComponent, false otherwise

setVisibility

  public boolean setVisibility(KUIComponent kuic,
                               int visFlag)

This changes the visibility for a KUIComponent

Parameters:: kuic - reference to KUIComponent; visFlag - should be KUIComponent.UIC_VISIBILITY_XXXX
Returns:: true if the visibility change has been accepted by the KUIComponent, false otherwise

cloneKUIC

  public KUIComponent cloneKUIC(String varName)

Clones an un-named KUIComponent from the variable name given.The arguments of the KUIComponent referenced by the variable name is used for the cloned component.

Parameters:: varName - KUIComponent's variable name
Returns:: KUIComponent on successful cloning and null on failure

cloneKUIC

  public KUIComponent cloneKUIC(String varName,
                                String varNameForClone)

Clones a named KUIComponent from the variable name given.The arguments of the KUIComponent referenced by the variable name is used for the cloned component.

Parameters:: varName - KUIComponent's variable name; varNameForClone - variable name for the clone component
Returns:: KUIComponent on successful cloning and null on failure

cloneKUIC

  public KUIComponent cloneKUIC(KUIComponent kuicRef)

Clones an un-named KUIComponent from the KUIComponent reference.The arguments of the KUIComponent referenced by kuicRef is used for the cloned component.

Parameters:: kuicRef - object instance of KUIComponent
Returns:: KUIComponent on successful cloning and null on failure

cloneKUIC

  public KUIComponent cloneKUIC(KUIComponent kuicRef,
                                String varNameForClone)

Clones a named KUIComponent from the KUIComponent reference.The arguments of the KUIComponent referenced by kuicRef is used for the cloned component.

Parameters:: kuicRef - object instance of KUIComponent; varNameForClone - variable name for the clone component
Returns:: KUIComponent on successful cloning and null on failure

cloneKUIC

  public KUIComponent cloneKUIC(String varName,
                                String varNameForClone,
                                String argsKaapi[],
                                String argsAwt[],
                                String argsKuic[],
                                String uicLinks[])

Clones a KUIComponent from the variable name given.Any of the arguments except the varName can be 'null' in which case the corresponding information from KUIComponent referenced by varName is taken.

Parameters:: varName - KUIComponent's variable name; varNameForClone - variable name for the clone component; argsKaapi - Kaapi arguments; argsAwt - Awt arguments; argsKuic - Kuic arguments; uicLinks - UIC links arguments
Returns:: KUIComponent on successful cloning and null on failure
See Also:: getKaapiArgs, getKuicArgs, getAwtArgs, getUicLinks

cloneKUIC

  public KUIComponent cloneKUIC(KUIComponent kuicRef,
                                String varNameForClone,
                                String argsKaapi[],
                                String argsAwt[],
                                String argsKuic[],
                                String uicLinks[])

Clones a KUIComponent from the KUIComponent reference. Any of the arguments except kuicRef can be 'null' in which case the corresponding information from KUIComponent referenced by kuicRef is taken.

Parameters:: kuicRef - object instance of KUIComponent; varNameForClone - variable name for the clone component; argsKaapi - Kaapi arguments; argsAwt - Awt arguments; argsKuic - Kuic arguments; uicLinks - UIC links arguments
Returns:: KUIComponent on successful cloning and null on failure
See Also:: getKaapiArgs, getKuicArgs, getAwtArgs, getUicLinks

getKaapiArgs

  public String[] getKaapiArgs(String varName)

Returns the Kaapi arguments for KUIComponent referenced by varName.

Parameters:: varName - the name of the KUIComponent
Returns:: the Kaapi arguments

getKaapiArgs

  public String[] getKaapiArgs(KUIComponent kuicRef)

Returns the Kaapi arguments for KUIComponent kuicRef

Parameters:: kuicRef - reference to a KUIComponent
Returns:: the Kaapi arguments

getAwtArgs

  public String[] getAwtArgs(String varName)

Returns the Awt arguments for KUIComponent referenced by varName.

Parameters:: varName - the name of the KUIComponent
Returns:: the Awt arguments

getAwtArgs

  public String[] getAwtArgs(KUIComponent kuicRef)

Returns the Awt arguments for KUIComponent kuicRef

Parameters:: kuicRef - reference to a KUIComponent
Returns:: the Awt arguments

getKuicArgs

  public String[] getKuicArgs(String varName)

Returns the Kuic arguments for KUIComponent referenced by varName.

Parameters:: varName - the name of the KUIComponent
Returns:: the Kuic arguments

getKuicArgs

  public String[] getKuicArgs(KUIComponent kuicRef)

Returns the Kuic arguments for KUIComponent kuicRef

Parameters:: kuicRef - reference to a KUIComponent
Returns:: the Kuic arguments

getUicLinks

  public String[] getUicLinks(String varName)

Returns the Uiclinks arguments for KUIComponent referenced by varName.

Parameters:: varName - the name of the KUIComponent
Returns:: the Uiclinks arguments

getUicLinks

  public String[] getUicLinks(KUIComponent kuicRef)

Returns the Uiclinks arguments for KUIComponent kuicRef

Parameters:: kuicRef - reference to a KUIComponent
Returns:: the Uiclinks arguments

closeFrame

  public void closeFrame(boolean exitApp)

Closes the KFrame object associated with the Agent. If the exitApp is true then all KFrames associated with the application are closed, else only the KFrame object of the Agent is closed.

Parameters:: exitApp - flag to indicate the Frame(s) to be closed

GetColor

  public static Color GetColor(String colorString)

Converts color string to java.awt.Color

Parameters:: colorString - strings like "red","blue" etc
Returns:: the predefined colors in java.awt.Color
See Also:: Color

GetLocationString

  public static String GetLocationString(int location)

Converts Location represented as int to a Location String. For example if location is UIC_LOCATION_SOUTH the value returned is "South"

Parameters:: location - should be any UIC_LOCATION_XXXX constant defined in KUIComponent interface
Returns:: Location as a java.lang.String
See Also:: KUIComponent

ToNativePath

  public static String ToNativePath(String pathName)

Converts any pathnames to the native pathnames.

Parameters:: pathName - the path that needs to converted.
Returns:: converted pathname

All Packages  Class Hierarchy  This Package  Previous  Next  Index