org.jacpfx.api.component

Interface ComponentBase<L,M>

Type Parameters:

L - defines the message listener type

M - defines the basic message type

All Superinterfaces:

java.lang.Comparable<ComponentBase<L,M>>

All Known Subinterfaces:

Perspective<C,L,A,M>, StatelessCallabackComponent<L,A,M>, SubComponent<L,A,M>, UIComponent<C,L,A,M>

public interface ComponentBase<L,M>
extends java.lang.Comparable<ComponentBase<L,M>>

This Interface represents a very basic component that can exists in JACP environment.

Author:

Andy Moncsek

Method Summary

Modifier and Type	Method and Description
JacpContext<L,M>	getContext() Returns the component context object.
java.lang.String	getLocaleID() Represents the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.
java.lang.String	getResourceBundleLocation() Represents the location of your resource bundle file.
boolean	isStarted() Get if component was activated, can occur if message was send before "init" message arrived.
void	setLocaleID(java.lang.String localeId) Set the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.
void	setResourceBundleLocation(java.lang.String location) Set the location of your resource bundle file.
void	setStarted(boolean started) Set once when component was first started

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isStarted

boolean isStarted()

Get if component was activated, can occur if message was send before "init" message arrived.

Returns:

the active status

setStarted

void setStarted(boolean started)

Set once when component was first started

Parameters:

started, - set to true if the component was initialized correctly.

getLocaleID

java.lang.String getLocaleID()

Represents the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.

Returns:

the locale id

setLocaleID

void setLocaleID(java.lang.String localeId)

Set the Locale ID, see: http://www.oracle.com/technetwork/java/javase/locales-137662.html.

Parameters:

localeId, - The locale id.

getResourceBundleLocation

java.lang.String getResourceBundleLocation()

Represents the location of your resource bundle file.

Returns:

the url of resource bundle

setResourceBundleLocation

void setResourceBundleLocation(java.lang.String location)

Set the location of your resource bundle file.

Parameters:

location - . The location of the resource bundle.

getContext

JacpContext<L,M> getContext()

Returns the component context object.

Returns:

the context object.