org.jrebirth.af.api.component.basic

Interface Component<R extends FacadeReady<R>>

Type Parameters:

R - A type that implements FacadeReady

All Superinterfaces:

CommandReady, FacadeReady<R>, ModelReady, ServiceReady

All Known Subinterfaces:

Behavior<D,C>, BehavioredComponent<C>, Command, CommandBean<WB>, DialogCommand, DockableBehavior, FXMLModel, LoadEdtFileService, Model, ModelObject<O>, ModuleModel, MultiCommand<WB>, SecurityBehavior, SecurityService, Service, SlideModel<S>, SwipableBehavior, Undoable<WB>

All Known Implementing Classes:

AbstractBaseCommand, AbstractBaseModel, AbstractBehavior, AbstractBehavioredComponent, AbstractComponent, AbstractDialogCommand, AbstractFormModel, AbstractFXMLModel, AbstractFXMLObjectModel, AbstractModel, AbstractModelBehavior, AbstractMultiCommand, AbstractObjectModel, AbstractRestService, AbstractService, AbstractSimpleModel, AbstractSimpleObjectModel, AbstractSingleCommand, AbstractSlideModel, AbstractTemplateModel, AbstractUndoableCommand, AccessBallCommand, AddDockCommand, AddTabCommand, AttachModelCommand, BallModel, BasicOpenDialogCommand, ChainServiceCommand, ChainWaveCommand, ClassicModel, CommandFacadeBallModel, ControlsModel, CreateBallCommand, CreateShapeCommand, CRUDRestService, DefaultBeanCommand, DefaultCommand, DefaultFormModel, DefaultFXMLModel, DefaultFXMLObjectModel, DefaultModel, DefaultMultiBeanCommand, DefaultMultiCommand, DefaultObjectModel, DefaultPoolBeanCommand, DefaultPoolCommand, DefaultService, DefaultSimpleModel, DefaultSimpleObjectModel, DefaultUIBeanCommand, DefaultUICommand, DefaultUndoableCommand, DestroyBallCommand, DetachModelCommand, DialogDaemonCommand, DisplayInfoPropertiesCommand, DockableBehaviorImpl, DockPaneModel, EditorModel, EmbeddedModel, FacadeBallModel, FadeInOutCommand, FadeTransitionCommand, FXMLShowCaseModel, GroupRefCommand, HybridModel, ImageSlideModel, IncludedModel, LoadEdtFileServiceImpl, MainModel, NodeSlicerCommand, OpenEventTrackerFileCommand, PrepareModelCommand, PresentationService, ProcessEventCommand, PropertiesModel, QandAModel, RandomFadingService, RedoCommand, RefCommand, RemoveDockCommand, SampleCommand, SampleModel, SamplePoolCommand, SampleService, SampleUICommand, SecurityBehaviorImpl, ShowErrorDialog, ShowFadingModelCommand, ShowModelCommand, ShowNextSlideCommand, ShowPreviousSlideCommand, ShowSlideCommand, ShowSlideMenuCommand, ShowTemporaryCommand, SimpleDialogCommand, SimpleModel, SlideMenuModel, SlideStackModel, SlidingDoorService, SplashModel, StackModel, StackUpCommand, StageCommand, StageService, StandaloneModel, StyleSheetTrackerService, SwipableBehaviorImpl, SwitchFullScreenCommand, TabbedPaneModel, TabDemoModel, TaskTrackerService, UndoCommand, UndoModel, UndoRedoService, UpdateCursorCommand, WorkbenchModel, WorkbenchModel

public interface Component<R extends FacadeReady<R>>
extends FacadeReady<R>

The interface EnhancedComponent. Define the contract used to manage waves.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
<C extends Component<?>> C	findInnerComponent(InnerComponent<C> innerComponent) Get an inner component.
void	listen(WaveChecker waveChecker, Method method, WaveType... waveType) Begin to listen the type of wave for the current component.
void	listen(WaveChecker waveChecker, WaveType... waveType) Begin to listen the type of wave for the current component.
void	listen(WaveType... waveType) Begin to listen the type of wave for the current component.
Component<?>	rootComponent() Return the root component (for inner component).
void	rootComponent(Component<?> rootComponent) Define the root component for an inner component.
void	sendWave(Wave wave) Send a wave to the notifier.
Wave	sendWave(WaveType waveType, WaveData<?>... waveData) Send a wave to the notifier.
<WB extends WaveBean> Wave	sendWave(WaveType waveType, WB waveBean) Send a wave to the notifier.
void	unlisten(WaveType... waveTypes) Stop to listen the type of wave for the current component.

Methods inherited from interface org.jrebirth.af.api.facade.FacadeReady

key, key, localFacade, localFacade, release, setup

Methods inherited from interface org.jrebirth.af.api.link.ModelReady

attachUi, getModel, getModel, getModels, getModels

Methods inherited from interface org.jrebirth.af.api.link.ServiceReady

getService, getService, getServices, getServices, returnData

Methods inherited from interface org.jrebirth.af.api.link.CommandReady

callCommand, callCommand, getCommand, getCommand, getCommands, getCommands

Method Detail

listen

void listen(WaveType... waveType)

Begin to listen the type of wave for the current component. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true

Parameters:

waveType - the type(s) to listen

listen

void listen(WaveChecker waveChecker,
            WaveType... waveType)

Begin to listen the type of wave for the current component. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true The wave checker is used to filter the wave if the checker returns false

Parameters:

waveChecker - the wave checker used to forward the wave only if the checker return true

waveType - the type(s) to listen

listen

void listen(WaveChecker waveChecker,
            Method method,
            WaveType... waveType)

Begin to listen the type of wave for the current component. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true The wave checker is used to filter the wave if the checker returns false

Parameters:

waveChecker - the wave checker used to forward the wave only if the checker return true

method - the annotated method concerned

waveType - the type(s) to listen

unlisten

void unlisten(WaveType... waveTypes)

Stop to listen the type of wave for the current component.

Parameters:

waveTypes - the type(s) to stop to listen

sendWave

void sendWave(Wave wave)

Send a wave to the notifier. The wave will automatically be sent from JRebirthThread.

Parameters:

wave - the wave to send

sendWave

<WB extends WaveBean> Wave sendWave(WaveType waveType,
                                    WB waveBean)

Send a wave to the notifier. The wave will automatically be sent from JRebirthThread.

Parameters:

waveType - the type of wave to send

waveBean - the wave bean

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

sendWave

Wave sendWave(WaveType waveType,
              WaveData<?>... waveData)

Send a wave to the notifier. The wave will automatically be sent from JRebirthThread.

Parameters:

waveType - the type of wave to send

waveData - the data (key-value

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

rootComponent

Component<?> rootComponent()

Return the root component (for inner component).

Returns:

the root component of the inner component

rootComponent

void rootComponent(Component<?> rootComponent)

Define the root component for an inner component.

Parameters:

rootComponent - The root component to set.

findInnerComponent

<C extends Component<?>> C findInnerComponent(InnerComponent<C> innerComponent)

Get an inner component. If the component isn't registered try to create it

Type Parameters:

C - the type of the inner component

Parameters:

innerComponent - the entry that describes the inner component

keyPart - additional object that are part of the inner component's unique key

Returns:

the inner component instance