com.highqsoft.interfaces.fwk

Interface FwkContainerInterface

All Superinterfaces:

FwkInterface, java.io.Serializable

All Known Implementing Classes:

FwkContainer

public interface FwkContainerInterface
extends FwkInterface

The implementation of the FWK container functionality.
There is a naming convetion as follows:
If a method is defined with name methodNameImpl then a static routine must exist that is named methodName

Since:

$Date: 2017/04/06 13:29:09 $

Version:

$Revision: 1.15 $

Author:

Andreas Hofmann

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMANDINTERFACE_KEY The client property keyword for the helpset.
static java.lang.String	CONTROLLER_KEY The client property keyword for the command controller.
static java.lang.String	HELPID_KEY The client property keyword for the help ID.
static java.lang.String	HELPSET_KEY The client property keyword for the helpset.
static java.lang.String	MIMETYPE_PREFIX The mimetype prefix.
static long	mSeconds Timestamp for performance check.

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponentPropertiesImpl(java.lang.Class clazz) Adds the component properties.
void	addComponentPropertiesImpl(java.lang.String className) Adds the component properties.
void	addComponentPropertiesImpl(java.lang.String name, java.lang.Class clazz) Adds the component properties.
void	addComponentPropertiesImpl(java.lang.String name, java.lang.String className) Adds the component properties.
void	addTraceListenerImpl(FwkTraceListenerInterface listener) �Add a trace listener to the listener list.
void	createFromDroppedObjectImpl(java.lang.String infoBusName, java.awt.datatransfer.DataFlavor df, java.lang.Object data) Create an item from the dropped data object.
void	debugImpl(int level, java.lang.String message) Debug message output.
void	debugImpl(int level, java.lang.String[] message) The array variant of the debug print method.
void	exitImpl(int flag) Exits the java environment.
void	fireTraceImpl(FwkTraceEventInterface evt) Fire an existing trace event to any registered listeners.
FwkApplicationInterface	getApplicationImpl(java.awt.event.ActionEvent ev) Get the application that fired the action event.
java.lang.String	getBasicNameImpl(java.lang.String className) Determine the basic name of an application.
FwkDescriptionInterface	getClassDescriptorImpl(java.lang.Class clazz) Get a descriptor of the specified class.
FwkDescriptionInterface	getClassDescriptorImpl(java.lang.String className) Get a descriptor of the specified class.
java.lang.Object	getControllerImpl(java.lang.Object obj) This method returns the controller of an object.
java.awt.datatransfer.DataFlavor[]	getDataFlavorImpl(java.lang.Class clazz) Get the toplevel flavor of the incoming class or an array of length null if no interface was found.
java.awt.datatransfer.DataFlavor[]	getDataFlavorImpl(java.lang.String mimeType) Get a DataFlavor for the given mimetype.
java.awt.datatransfer.DataFlavor[]	getDataFlavorsImpl(java.lang.Class clazz) Get the dataflavors of the incoming class or an array of length null if no interface was found.
java.awt.datatransfer.DataFlavor[]	getDataFlavorsImpl(FwkArrayInterface mimeTypes) Get a DataFlavor for the given mimetypes.
java.awt.datatransfer.DataFlavor[]	getDataFlavorsImpl(java.lang.String[] mimeTypes) Get DataFlavor for the given mimetypes.
int	getDebugLevelImpl() Get the current debug level.
long	getElapsedTimeImpl() Get the elapsed time since startup in milliseconds.
FwkArrayInterface	getFwkMimeTypesImpl() Return the mimetypes of the component.
FwkArrayInterface	getFwkMimeTypesImpl(java.lang.Class clazz) Return the mimetypes of a Class.
FwkArrayInterface	getFwkMimeTypesImpl(java.lang.Object obj) Return the mimetypes of an Object.
java.lang.String	getHelpIDStringImpl(javax.swing.JComponent comp) This method returns the helpID of the event source, or null if not found.
javax.help.HelpSet	getHelpSetImpl(javax.swing.JComponent comp) This method returns the helpSet of the event source, or null if not found.
java.lang.String[]	getLAFNamesImpl() Get LAF names.
java.util.Locale	getLocaleImpl() Get the desired Locale language.
java.lang.String	getLocalHostAddressImpl() Get the IP address of the current machine.
java.lang.String	getLocalHostImpl() Get the node name of the current machine.
java.lang.String	getMimeTypeImpl(java.lang.Class clazz) Get the mimetype of the incoming class.
FwkArrayInterface	getMimeTypesImpl(java.lang.Class clazz) Returns a string array containing all the mimetypes of the given class.
int	getModificationsImpl() Get the number of registered modifications.
boolean	getSystemBooleanImpl(java.lang.String booleanName, boolean defaultBool) Get a system boolean.
java.lang.String	getSystemPropertyImpl(java.lang.String propertyName, java.lang.String defaultValue) Get a system property.
long	getTraceLevelImpl() Get the trace level of the distributor.
FwkArrayInterface	getTraceListenerArrayImpl() Get a vector containing the registered trace listeners.
FwkTraceInterface	getTracerImpl() Get the trace.
java.lang.String	getTranslatedApplicationNameImpl(java.lang.String className) Get the translated (via property information) title for the given class.
java.lang.String	getUserNameImpl() Get the user name of the current user.
int	getYearImpl() Get the current year.
void	initializeImpl(java.lang.String[] args) Initialize the component system system.
void	installLookAndFeelDefaultsImpl() Install the LAF defaults.
java.lang.Object	instantiateImpl(java.lang.String className, java.lang.String errorTitle) Instantiate the requested class.
int	isDropDataFlavorSupportedImpl(java.lang.String infoBusName, java.awt.datatransfer.DataFlavor[] df) Return a boolean whether the given data flavor is supported.
boolean	isRegisteredImpl(FwkApplicationInterface appl) Check whether the application is registered.
boolean	isRegisteredImpl(java.lang.String applName) Check whether the application is registered.
void	printImpl(FwkPrintableInterface printable) The application print command.
void	printStackTraceImpl() Print the stack trace.
FwkInfoBusProducerInterface	registerComponentPropertiesImpl(java.lang.String name, java.lang.Class clazz) Register a new property producer.
void	registerDropProducerImpl(FwkInfoBusDropProducerInterface producer) Register a drop producer.
java.lang.String	registerImpl(FwkApplicationInterface appl) Register the application with the FwkApplicationBus.
void	registerImpl(FwkApplicationInterface appl, FwkArrayInterface mimeTypes) Register the application with the FwkApplicationBus.
void	registerImpl(FwkApplicationInterface appl, java.lang.String mimeType) Register the application with the FwkApplicationBus.
void	registerImpl(FwkApplicationInterface appl, java.lang.String[] mimeTypes) Register the application with the FwkApplicationBus.
void	removeTraceListenerImpl(FwkTraceListenerInterface listener) �Remove a trace listener from the listener list.
void	sendTraceImpl(java.lang.Object source, long level, java.lang.String message, java.lang.String host, java.lang.String user) Send a trace.
void	setLAFImpl(java.lang.String lafName) Install the LAF.
void	setLocaleImpl(java.util.Locale l) Set the locale.
void	setLocaleImpl(java.lang.String language, java.lang.String country) Set the locale.
void	setTraceLevelImpl(long level) Set the trace level of the distributor.
void	showErrorMessageImpl(java.lang.String title, java.lang.String label, java.lang.String label2)
void	showErrorMessageImpl(java.lang.String title, java.lang.String label, java.lang.Throwable throwable)
void	unregisterImpl(FwkApplicationInterface appl) Unregister the application from the ApplicationBus
byte[]	unzipImpl(java.lang.String entry, byte[] arr) UNZIP a byte array.
void	zipImpl(java.io.InputStream in, java.io.OutputStream out, java.lang.String entry) UNZIP an inputstream and put the result into an output stream.
void	zipImpl(java.io.OutputStream out, java.lang.String entry, byte[] arr) ZIP a byte array into a output stream.
byte[]	zipImpl(java.lang.String entry, byte[] arr) ZIP a byte array.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Field Detail

CONTROLLER_KEY

static final java.lang.String CONTROLLER_KEY

The client property keyword for the command controller.

See Also:

Constant Field Values

HELPID_KEY

static final java.lang.String HELPID_KEY

The client property keyword for the help ID.

See Also:

Constant Field Values

HELPSET_KEY

static final java.lang.String HELPSET_KEY

The client property keyword for the helpset.

See Also:

Constant Field Values

COMMANDINTERFACE_KEY

static final java.lang.String COMMANDINTERFACE_KEY

The client property keyword for the helpset.

See Also:

Constant Field Values

mSeconds

static final long mSeconds

Timestamp for performance check.

MIMETYPE_PREFIX

static final java.lang.String MIMETYPE_PREFIX

The mimetype prefix.

See Also:

Constant Field Values

Method Detail

registerComponentPropertiesImpl

FwkInfoBusProducerInterface registerComponentPropertiesImpl(java.lang.String name,
                                                          java.lang.Class clazz)

Register a new property producer.

Parameters:

clazz - Class to be initialized.

See Also:

#eaPropertyProducer

addComponentPropertiesImpl

void addComponentPropertiesImpl(java.lang.Class clazz)

Adds the component properties.

Parameters:

clazz - Class to be initialized.

addComponentPropertiesImpl

void addComponentPropertiesImpl(java.lang.String name,
                              java.lang.Class clazz)

Adds the component properties.

Parameters:

name - The name of the property file without path and extention.

clazz - Class to be initialized.

addComponentPropertiesImpl

void addComponentPropertiesImpl(java.lang.String className)

Adds the component properties.

Parameters:

className - Name of the class to be initialized.

addComponentPropertiesImpl

void addComponentPropertiesImpl(java.lang.String name,
                              java.lang.String className)

Adds the component properties.

Parameters:

name - The name of the property file without path and extention.

clazzName - Class name string to be inialized.

getApplicationImpl

FwkApplicationInterface getApplicationImpl(java.awt.event.ActionEvent ev)

Get the application that fired the action event.

Parameters:

ev - The action event.

Returns:

The application that fired the action event.

getBasicNameImpl

java.lang.String getBasicNameImpl(java.lang.String className)

Determine the basic name of an application. The basic name is the class name without the path. Example: The basic name of "com.xyzcompany.application.DoSomething" is "DoSomething".

Parameters:

className - The name of the class whose basic name is requested.

Returns:

The basic name or an empty string.

getFwkMimeTypesImpl

FwkArrayInterface getFwkMimeTypesImpl()

Return the mimetypes of the component.

Returns:

The mime type string array.

getFwkMimeTypesImpl

FwkArrayInterface getFwkMimeTypesImpl(java.lang.Object obj)

Return the mimetypes of an Object.

Parameters:

obj - The object that should be instrospected.

Returns:

The mime type string array.

getFwkMimeTypesImpl

FwkArrayInterface getFwkMimeTypesImpl(java.lang.Class clazz)

Return the mimetypes of a Class.

Parameters:

clazz - The class that should be instrospected.

Returns:

The mime type string array.

getClassDescriptorImpl

FwkDescriptionInterface getClassDescriptorImpl(java.lang.String className)

Get a descriptor of the specified class. This method tries to execute the static class method getDescriptor.

Parameters:

className - The name of the class to be ask for the descriptor.

getClassDescriptorImpl

FwkDescriptionInterface getClassDescriptorImpl(java.lang.Class clazz)

Get a descriptor of the specified class. This method tries to execute the static class method getDescriptor.

Parameters:

clazz - The class to be ask for the descriptor.

getControllerImpl

java.lang.Object getControllerImpl(java.lang.Object obj)

This method returns the controller of an object. The object must either be a JComponent or it must implements the method getProperty.
If the incoming object is a JComponent the method executes the method getClientProperty with the keyword CONTROLLER_KEY and returns the retrieved value.
If the incoming object isn't a JComponent the method tries to invoke the getProperty method with the keyword CONTROLLER_KEY and return the found value.

Parameters:

obj - The object from that the controller is requested.

Returns:

The property value that is stored under the keyword CONTROLLER_KEY.

getLocaleImpl

java.util.Locale getLocaleImpl()

Get the desired Locale language.

Returns:

The Local object of the container.

getLocalHostImpl

java.lang.String getLocalHostImpl()

Get the node name of the current machine.

Returns:

The name of the node.

getLocalHostAddressImpl

java.lang.String getLocalHostAddressImpl()

Get the IP address of the current machine.

Returns:

The IP address of the node.

getMimeTypeImpl

java.lang.String getMimeTypeImpl(java.lang.Class clazz)

Get the mimetype of the incoming class.

Parameters:

clazz - The class to be introspected.

The - mime type string.

getMimeTypesImpl

FwkArrayInterface getMimeTypesImpl(java.lang.Class clazz)

Returns a string array containing all the mimetypes of the given class.

Parameters:

clazz - The class that should be introspected.

Returns:

A FwkArray containing the Mimetypes.

getModificationsImpl

int getModificationsImpl()

Get the number of registered modifications. This number is useful to determine wether or not a save operation is required.

Returns:

The number of registered modifications.

getTranslatedApplicationNameImpl

java.lang.String getTranslatedApplicationNameImpl(java.lang.String className)

Get the translated (via property information) title for the given class.

Parameters:

className - The name of the class.

Returns:

The translated title.

getUserNameImpl

java.lang.String getUserNameImpl()

Get the user name of the current user.

Returns:

The name of the user.

initializeImpl

void initializeImpl(java.lang.String[] args)

Initialize the component system system. The initialization can only be done once. Subsequent calls will be ignored.

Parameters:

name - The name of program.

version - The version of the program.

args - The command line arguments of the program.

instantiateImpl

java.lang.Object instantiateImpl(java.lang.String className,
                               java.lang.String errorTitle)

Instantiate the requested class. For singleton classes the one and only instance of that class is returned.

Parameters:

className - The name of the class to get an instance from.

errorTitle - The title of the error message.

setLocaleImpl

void setLocaleImpl(java.lang.String language,
                 java.lang.String country)

Set the locale.
Use the command line arguments to specifiy the language and the country.
example: -language en -country US

Parameters:

language - The language string.

country - The country string.

setLocaleImpl

void setLocaleImpl(java.util.Locale l)

Set the locale.
Use the command line arguments to specifiy the language and the country.
example: -language en -country US

Parameters:

l - The new Locale

printImpl

void printImpl(FwkPrintableInterface printable)
               throws java.lang.RuntimeException

The application print command. This method uses the default page format.

Parameters:

The - printable object.

Throws:

java.lang.RuntimeException

printStackTraceImpl

void printStackTraceImpl()

Print the stack trace.

debugImpl

void debugImpl(int level,
             java.lang.String message)

Debug message output.
This method looks for the property keyword FwkContainer.DebugLevel
If the found level is lower than 1000 and the given level is lower equal the found level the message will be printed.
If the found level is greater than 1000 the message will be printed if the given level is equal to the found one.

Level	Description
0	all messages will be printed
1	low level
2
3
4
5

debugImpl

void debugImpl(int level,
             java.lang.String[] message)

The array variant of the debug print method.

getDebugLevelImpl

int getDebugLevelImpl()

Get the current debug level.

Returns:

The current debug level.

getDataFlavorImpl

java.awt.datatransfer.DataFlavor[] getDataFlavorImpl(java.lang.String mimeType)

Get a DataFlavor for the given mimetype.

Parameters:

mimeType - The mimetype string.

Returns:

A data flavor array containing the flavor of the given mimetype. If the operation fails the array contains null.

getDataFlavorsImpl

java.awt.datatransfer.DataFlavor[] getDataFlavorsImpl(FwkArrayInterface mimeTypes)

Get a DataFlavor for the given mimetypes.

Parameters:

mimeTypes - The FWK mimetype array.

Returns:

A data flavor array containing the flavor of the given mimetypes. If the operation fails the array contains null.

getDataFlavorsImpl

java.awt.datatransfer.DataFlavor[] getDataFlavorsImpl(java.lang.String[] mimeTypes)

Get DataFlavor for the given mimetypes.

Parameters:

mimeTypes - The mimetype string array.

Returns:

A data flavor array containing the flavor of the given mimetypes. If the operation fails the array contains null.

getDataFlavorImpl

java.awt.datatransfer.DataFlavor[] getDataFlavorImpl(java.lang.Class clazz)

Get the toplevel flavor of the incoming class or an array of length null if no interface was found.

Parameters:

clazz - The class to be introspected.

The - data flavor of the last mime type string of the filed MIMETYPE.

getDataFlavorsImpl

java.awt.datatransfer.DataFlavor[] getDataFlavorsImpl(java.lang.Class clazz)

Get the dataflavors of the incoming class or an array of length null if no interface was found.

Parameters:

clazz - The class to be introspected.

The - data flavor of the last mime type string of the filed MIMETYPE.

registerDropProducerImpl

void registerDropProducerImpl(FwkInfoBusDropProducerInterface producer)

Register a drop producer.

Parameters:

producer - an infobus data producer.

isDropDataFlavorSupportedImpl

int isDropDataFlavorSupportedImpl(java.lang.String infoBusName,
                                java.awt.datatransfer.DataFlavor[] df)

Return a boolean whether the given data flavor is supported.

Parameters:

infoBusName - The name of the infobus.

df - the falvor array to be checked.

Returns:

-1 if no flavor is support else the index into the flavor array.

createFromDroppedObjectImpl

void createFromDroppedObjectImpl(java.lang.String infoBusName,
                               java.awt.datatransfer.DataFlavor df,
                               java.lang.Object data)
                                 throws java.lang.RuntimeException

Create an item from the dropped data object.

Parameters:

infoBusName - the name of the bus on that the item should be created,

df - The data flavor of the dropped object.

data - The dropped object.

Throws:

java.lang.RuntimeException

installLookAndFeelDefaultsImpl

void installLookAndFeelDefaultsImpl()

Install the LAF defaults.

setLAFImpl

void setLAFImpl(java.lang.String lafName)

Install the LAF.

Parameters:

name - The name of the LAF to be installed.

getLAFNamesImpl

java.lang.String[] getLAFNamesImpl()

Get LAF names.

Returns:

An array containing the LAF names.

registerImpl

java.lang.String registerImpl(FwkApplicationInterface appl)
                              throws java.lang.RuntimeException

Register the application with the FwkApplicationBus.

Parameters:

appl - The application to be registered.

mimeType - The mimetype string.

Throws:

java.lang.RuntimeException - if the application is eternal and already registered.

registerImpl

void registerImpl(FwkApplicationInterface appl,
                java.lang.String mimeType)
                  throws java.lang.RuntimeException

Register the application with the FwkApplicationBus.

Parameters:

appl - The application to be registered.

mimeType - The mimetype string.

Throws:

java.lang.RuntimeException - if the application is eternal and already registered.

registerImpl

void registerImpl(FwkApplicationInterface appl,
                java.lang.String[] mimeTypes)
                  throws java.lang.RuntimeException

Register the application with the FwkApplicationBus.

Parameters:

appl - The application to be registered.

mimeTypes - The mimetype list.

Throws:

java.lang.RuntimeException - if the application is eternal and already registered.

registerImpl

void registerImpl(FwkApplicationInterface appl,
                FwkArrayInterface mimeTypes)
                  throws java.lang.RuntimeException

Register the application with the FwkApplicationBus.

Parameters:

appl - The application to be registered.

mimeTypes - The mimetype array.

Throws:

java.lang.RuntimeException - if the application is eternal and already registered.

isRegisteredImpl

boolean isRegisteredImpl(FwkApplicationInterface appl)

Check whether the application is registered.

Parameters:

appl - The application to be checked.

Returns:

true if the application is already registered.

isRegisteredImpl

boolean isRegisteredImpl(java.lang.String applName)

Check whether the application is registered.

Parameters:

applName - The name of the application to be checked.

Returns:

true if the application is already registered.

unregisterImpl

void unregisterImpl(FwkApplicationInterface appl)

Unregister the application from the ApplicationBus

Parameters:

appl - The application to be registered.

exitImpl

void exitImpl(int flag)

Exits the java environment.

Parameters:

flag - The exit status.

getElapsedTimeImpl

long getElapsedTimeImpl()

Get the elapsed time since startup in milliseconds.

Returns:

The elapsed time since startup in milliseconds.

getSystemBooleanImpl

boolean getSystemBooleanImpl(java.lang.String booleanName,
                           boolean defaultBool)

Get a system boolean. Use default boolean if an exception occurs.

Parameters:

booleanName - The requested property name.

defaultBool - The default if no property available or a security exception occurred.

Returns:

The requested boolean value.

getSystemPropertyImpl

java.lang.String getSystemPropertyImpl(java.lang.String propertyName,
                                     java.lang.String defaultValue)

Get a system property. Use default name if an exception occurs.

Parameters:

propertyName - The requested property name.

defaultName - The default if no property available or a security exception occurred.

Returns:

The requested property.

getYearImpl

int getYearImpl()

Get the current year.

Returns:

The current year.

getTracerImpl

FwkTraceInterface getTracerImpl()

Get the trace.

Returns:

The tracer.

getTraceListenerArrayImpl

FwkArrayInterface getTraceListenerArrayImpl()

Get a vector containing the registered trace listeners.

Returns:

The requested array.

addTraceListenerImpl

void addTraceListenerImpl(FwkTraceListenerInterface listener)

�Add a trace listener to the listener list.

Parameters:

listener - The trace listener.

removeTraceListenerImpl

void removeTraceListenerImpl(FwkTraceListenerInterface listener)

�Remove a trace listener from the listener list.

Parameters:

listener - The trace listener to be removed.

fireTraceImpl

void fireTraceImpl(FwkTraceEventInterface evt)

Fire an existing trace event to any registered listeners.

Parameters:

evt - The trace event.

setTraceLevelImpl

void setTraceLevelImpl(long level)

Set the trace level of the distributor.

Parameters:

the - new level.

getTraceLevelImpl

long getTraceLevelImpl()

Get the trace level of the distributor.

Parameters:

the - new level.

sendTraceImpl

void sendTraceImpl(java.lang.Object source,
                 long level,
                 java.lang.String message,
                 java.lang.String host,
                 java.lang.String user)

Send a trace.

getHelpIDStringImpl

java.lang.String getHelpIDStringImpl(javax.swing.JComponent comp)

This method returns the helpID of the event source, or null if not found.

Parameters:

ev - The action event source.

getHelpSetImpl

javax.help.HelpSet getHelpSetImpl(javax.swing.JComponent comp)

This method returns the helpSet of the event source, or null if not found.

Parameters:

ev - The action event source.

showErrorMessageImpl

void showErrorMessageImpl(java.lang.String title,
                        java.lang.String label,
                        java.lang.String label2)

showErrorMessageImpl

void showErrorMessageImpl(java.lang.String title,
                        java.lang.String label,
                        java.lang.Throwable throwable)

zipImpl

void zipImpl(java.io.OutputStream out,
           java.lang.String entry,
           byte[] arr)

ZIP a byte array into a output stream.

Parameters:

out - The output stream

entry - The name of the newly created entry.

arr - The array to be zipped.

zipImpl

byte[] zipImpl(java.lang.String entry,
             byte[] arr)

ZIP a byte array. If an exception accured the method returns an array of length 0.

Parameters:

arr - The array to be zipped.

entry - The name of the newly created entry.

Returns:

The zipped array.

zipImpl

void zipImpl(java.io.InputStream in,
           java.io.OutputStream out,
           java.lang.String entry)

UNZIP an inputstream and put the result into an output stream.

Parameters:

out - The output stream

in - The input stream.

entry - The name or pattern of the entry(ies) to be unzipped.

unzipImpl

byte[] unzipImpl(java.lang.String entry,
               byte[] arr)

UNZIP a byte array. If an exception accured the method returns an array of length 0.

Parameters:

arr - The array to be unzipped.

entry - The name or pattern of the entry(ies) to be unzipped.

Returns:

The unzipped array.