public abstract class BaseComponent extends java.lang.Object implements Iconic, Stateful, ArooaSessionAware, ArooaContextAware, PropertyChangeNotifier
Constructor and Description |
---|
BaseComponent() |
Modifier and Type | Method and Description |
---|---|
void |
addIconListener(IconListener listener)
Add an icon listener.
|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener l)
Add a property change listener.
|
void |
addStateListener(StateListener listener)
Add a job state listener.
|
protected void |
configure(java.lang.Object component)
Configure the runtime for the given component.
|
void |
destroy()
When running a job embedded in code, this method should always
be called to clear up resources.
|
protected abstract void |
fireDestroyedState()
Subclasses must override this to fire the destroyed state.
|
protected void |
firePropertyChange(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
Fire a property change event.
|
protected ArooaSession |
getArooaSession()
Allow sub classes access the the session.
|
javax.swing.ImageIcon |
iconForId(java.lang.String iconId)
Return an icon tip for a given id.
|
protected abstract IconHelper |
iconHelper()
Subclasses must provide a
IconHelper . |
void |
initialise()
When running a job embedded in code, it may be necessary
to call this method to initialise the job.
|
StateEvent |
lastStateEvent()
Returns the last JobState event.
|
protected abstract org.slf4j.Logger |
logger() |
protected void |
onConfigured()
Subclasses override this method to perform post configuration
initialisation.
|
protected void |
onDestroy()
Subclasses override this method to clear up resources.
|
protected void |
onInitialised()
Subclasses override this method to perform post creation
initialisation.
|
void |
removeIconListener(IconListener listener)
Remove an icon listener.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener l)
Remove a property change listener.
|
void |
removeStateListener(StateListener listener)
Remove a job state listener.
|
protected void |
save()
Implementations override this to save their state on state
change.
|
protected void |
save(java.lang.Object o)
Save this job.
|
void |
setArooaContext(ArooaContext context) |
void |
setArooaSession(ArooaSession session)
Here for the tests...
|
protected abstract StateHandler<?> |
stateHandler()
Subclasses must provide a
StateHandler . |
protected abstract StateHandler<?> stateHandler()
StateHandler
.protected abstract IconHelper iconHelper()
IconHelper
.public void setArooaSession(ArooaSession session)
setArooaSession
in interface ArooaSessionAware
session
- protected ArooaSession getArooaSession()
public void setArooaContext(ArooaContext context)
setArooaContext
in interface ArooaContextAware
protected abstract org.slf4j.Logger logger()
protected void save() throws ComponentPersistException
ComponentPersistException
protected void configure(java.lang.Object component) throws ArooaConfigurationException
component
- The component to configure.ArooaConfigurationException
protected void save(java.lang.Object o) throws ComponentPersistException
ComponentPersistException
public StateEvent lastStateEvent()
This is not a property so that it can't be accessed directly in scripts.
lastStateEvent
in interface Stateful
public void addStateListener(StateListener listener)
addStateListener
in interface Stateful
listener
- The listener.public void removeStateListener(StateListener listener)
removeStateListener
in interface Stateful
listener
- The listener.public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
addPropertyChangeListener
in interface PropertyChangeNotifier
l
- The property change listener.public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
removePropertyChangeListener
in interface PropertyChangeNotifier
l
- The property change listener.protected void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
propertyName
- oldValue
- newValue
- public javax.swing.ImageIcon iconForId(java.lang.String iconId)
public void addIconListener(IconListener listener)
addIconListener
in interface Iconic
listener
- The listener.public void removeIconListener(IconListener listener)
removeIconListener
in interface Iconic
listener
- The listener.public void initialise() throws JobDestroyedException
JobDestroyedException
public void destroy() throws JobDestroyedException
JobDestroyedException
protected void onInitialised()
protected void onConfigured()
protected void onDestroy()
protected abstract void fireDestroyedState()