app.framework

Class View<M extends Model,C extends Controller>

java.lang.Object

app.framework.View<M,C>

Type Parameters:

M - The type of model that the view will operate on. This can be omitted if no model will ever be operated on by the view.

C - The type of controller that will operate on the view. This can be omitted if no controller will ever operate on the view.

Direct Known Subclasses:

MenuView, TodoView

public abstract class View<M extends Model,C extends Controller>
extends java.lang.Object

The View class describes all the basic functionality of a view within the MVC architecture.

From Wikipedia:

A view requests information from the model that it uses to generate an output representation to the user.

See Also:

http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller

Constructor Summary

Constructors

Constructor and Description
View(Application application) Initialize a new View instance for the specified Application.

Method Summary

Modifier and Type	Method and Description
protected Application	application() Access the Application that the View is associated with.
protected C	controller() Access the Controller operating on the View.
protected void	controller(C controller) Set the Controller operating on the View.
protected boolean	emit(java.lang.String event) Emit an event with the specified name.
protected <T> boolean	emit(java.lang.String event, T data) Emit an event with the specified name and data.
protected M	model() Access the Model that the View renders.
protected void	model(M model) Set the Model that the View operates on.
protected <T> boolean	off(java.lang.String event, java.util.function.Consumer<T> consumer) Detach a Consumer from the specified event.
protected <T> boolean	on(java.lang.String event, java.util.function.Consumer<T> consumer) Attach a Consumer to the specified event.
abstract javax.swing.JComponent	render() Render the View as a Swing component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

View

public View(Application application)

Initialize a new View instance for the specified Application.

Parameters:

application - The Application that the View is associated with.

Method Detail

application

protected final Application application()

Access the Application that the View is associated with.

Returns:

The Application that the View is associated with.

model

protected final M model()

Access the Model that the View renders.

Returns:

The Model that the View renders.

model

protected final void model(M model)

Set the Model that the View operates on.

Parameters:

model - The Model that the View operates on.

controller

protected final C controller()

Access the Controller operating on the View.

Returns:

The Controller operating on the View.

controller

protected final void controller(C controller)

Set the Controller operating on the View.

Parameters:

controller - The controller operating on the view.

render

public abstract javax.swing.JComponent render()

Render the View as a Swing component.

This method must be implemented by subclasses and is where the View is rendered as a Swing component.

Returns:

The rendered Swing component.

emit

protected final boolean emit(java.lang.String event)

Emit an event with the specified name.

Parameters:

event - The name of the event to emit.

Returns:

A boolean indicating whether or not the event was picked up by a Consumer.

emit

protected final <T> boolean emit(java.lang.String event,
                                 T data)

Emit an event with the specified name and data.

Type Parameters:

T - The type of data to utilize in Consumers.

Parameters:

event - The name of the event to emit.

data - The data to pass on to Consumers.

Returns:

A boolean indicating whether or not the event was picked up by a Consumer.

on

protected final <T> boolean on(java.lang.String event,
                               java.util.function.Consumer<T> consumer)

Attach a Consumer to the specified event.

Type Parameters:

T - The type of data to utilize in Consumers.

Parameters:

event - The name of the event to attach the Consumer to.

consumer - The Consumer to attach to the specified event.

Returns:

A boolean indicating whether or not the operation affected the set of Consumers attached to the specified event.

off

protected final <T> boolean off(java.lang.String event,
                                java.util.function.Consumer<T> consumer)

Detach a Consumer from the specified event.

Type Parameters:

T - The type of data to utilize in Consumers.

Parameters:

event - The name of the event to detach the Consumer from.

consumer - The Consumer to detach from the specified event.

Returns:

A boolean indicating whether or not the operation affected the set of Consumers attached to the specified event.