ilog.views.appframe.event

Class ApplicationEvent

java.lang.Object

java.util.EventObject

ilog.views.appframe.event.ApplicationEvent

All Implemented Interfaces:

Serializable

public class ApplicationEvent
extends EventObject

The application event emitted by the application when a document or application event occurs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPLICATION_CLOSED This event indicates that the application is closed.
static int	APPLICATION_CLOSING This event indicates that the application is closing.
static int	APPLICATION_FIRST The first number in the range of IDs used for application events.
static int	APPLICATION_INITIALIZED This event indicates that the application has been initialized.
static int	APPLICATION_INITIALIZING_SETTINGS This event indicates that the application is reading and initializing its settings.
static int	APPLICATION_LAST The last number in the range of IDs used for application events.
static int	APPLICATION_SAVING_SETTINGS This event indicates that the application is saving the user settings.
static int	DOCUMENT_ACTIVATED This event indicates that a document has been activated.
static int	DOCUMENT_CLOSED This event indicates that a document has been closed.
static int	DOCUMENT_CLOSING This event indicates that a document is being closed.
static int	DOCUMENT_CREATED This event indicates that a document has been created.
static int	DOCUMENT_DEACTIVATED This event indicates that a document has been deactivated.
static int	DOCUMENT_INITIALIZING This event indicates that a document is in the process of being created.
static int	DOCUMENT_SAVED This event indicates that a document has been saved.
static int	DOCUMENT_TEMPLATE_ACTIVATED This event indicates that a document template has been activated.
static int	DOCUMENT_TEMPLATE_DEACTIVATED This event indicates that a document template has been deactivated.
static int	DOCUMENT_VIEW_ACTIVATED This event indicates that a document view has been activated.
static int	DOCUMENT_VIEW_CLOSED This event indicates that a document view has been closed.
static int	DOCUMENT_VIEW_CLOSING This event indicates that a document view is being closed.
static int	DOCUMENT_VIEW_CREATED This event indicates that a document view has been created.
static int	DOCUMENT_VIEW_DEACTIVATED This event indicates that a document view has been deactivated.
static int	DOCUMENT_VIEW_INITIALIZED This event indicates that a document view has been initialized with a new associated document.
static int	MAIN_WINDOW_INITIALIZED This event indicates that a main window has been set to the application.
static int	VIEW_CONTAINER_ACTIVATED This event indicates that a view container has been activated.
static int	VIEW_CONTAINER_CLOSED This event indicates that a view container has been closed.
static int	VIEW_CONTAINER_CLOSING This event indicates that a view container is being closed.
static int	VIEW_CONTAINER_CREATED This event indicates that the creation of a view container has been completed.
static int	VIEW_CONTAINER_CREATING This event indicates that a view container is being created.
static int	VIEW_CONTAINER_DEACTIVATED This event indicates that a view container has been deactivated.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ApplicationEvent(int id, IlvApplication application) Constructs an ApplicationEvent object with the specified id and application source.
ApplicationEvent(int id, IlvDocument document) Constructs an ApplicationEvent with the specified id and document source.
ApplicationEvent(int id, IlvDocument document, IlvDocumentView view, IlvDocumentTemplate documentTemplate) Constructs an ApplicationEvent with the specified id, document, document view, and documentTemplate.
ApplicationEvent(int id, IlvDocument document, IlvDocumentView view, IlvViewContainer container, IlvDocumentTemplate documentTemplate) Constructs an ApplicationEvent with the specified id, document, document view, view container, and documentTemplate.
ApplicationEvent(int id, IlvDocumentTemplate documentTemplate) Constructs an ApplicationEvent object with the specified id and documentTemplate.
ApplicationEvent(int id, IlvDocumentView view) Constructs an ApplicationEvent with the specified id and document view.
ApplicationEvent(int id, IlvViewContainer container) Constructs an ApplicationEvent with the specified id and view container.

Method Summary

Modifier and Type	Method and Description
IlvApplication	getApplication() Returns the application that originated this event.
IlvDocument	getDocument() Returns the document originator of the event; null if this event was not originated by a document.
IlvDocumentTemplate	getDocumentTemplate() Returns the document template that originated the event or the document template of the document, document view, or view container that originated the event.
String	getDocumentTemplateName() Returns the name of the document template of the document or document view that originated the event.
int	getID() Returns the event type.
IlvDocumentView	getView() Returns the document view that originated the event; null if this event was not originated by a document view.
IlvViewContainer	getViewContainer() Returns the view container that originated the event; null if this event was not originated by a view container.
void	setDocument(IlvDocument document) Sets the document that originated the event.
void	setView(IlvDocumentView view) Sets the active view of the document.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_FIRST

public static final int APPLICATION_FIRST

The first number in the range of IDs used for application events.

See Also:

Constant Field Values

DOCUMENT_CREATED

public static final int DOCUMENT_CREATED

This event indicates that a document has been created.

See Also:

DOCUMENT_INITIALIZING, Constant Field Values

DOCUMENT_CLOSING

public static final int DOCUMENT_CLOSING

This event indicates that a document is being closed.

See Also:

Constant Field Values

DOCUMENT_CLOSED

public static final int DOCUMENT_CLOSED

This event indicates that a document has been closed.

See Also:

Constant Field Values

DOCUMENT_ACTIVATED

public static final int DOCUMENT_ACTIVATED

This event indicates that a document has been activated.

See Also:

Constant Field Values

DOCUMENT_DEACTIVATED

public static final int DOCUMENT_DEACTIVATED

This event indicates that a document has been deactivated.

See Also:

Constant Field Values

DOCUMENT_SAVED

public static final int DOCUMENT_SAVED

This event indicates that a document has been saved.

Since:

JViews 6.0

See Also:

Constant Field Values

DOCUMENT_TEMPLATE_ACTIVATED

public static final int DOCUMENT_TEMPLATE_ACTIVATED

This event indicates that a document template has been activated.

See Also:

Constant Field Values

DOCUMENT_TEMPLATE_DEACTIVATED

public static final int DOCUMENT_TEMPLATE_DEACTIVATED

This event indicates that a document template has been deactivated.

See Also:

Constant Field Values

DOCUMENT_VIEW_CREATED

public static final int DOCUMENT_VIEW_CREATED

This event indicates that a document view has been created.

See Also:

Constant Field Values

DOCUMENT_VIEW_INITIALIZED

public static final int DOCUMENT_VIEW_INITIALIZED

This event indicates that a document view has been initialized with a new associated document.

See Also:

Constant Field Values

DOCUMENT_VIEW_CLOSING

public static final int DOCUMENT_VIEW_CLOSING

This event indicates that a document view is being closed.

See Also:

Constant Field Values

DOCUMENT_VIEW_CLOSED

public static final int DOCUMENT_VIEW_CLOSED

This event indicates that a document view has been closed.

See Also:

Constant Field Values

DOCUMENT_VIEW_ACTIVATED

public static final int DOCUMENT_VIEW_ACTIVATED

This event indicates that a document view has been activated.

See Also:

Constant Field Values

DOCUMENT_VIEW_DEACTIVATED

public static final int DOCUMENT_VIEW_DEACTIVATED

This event indicates that a document view has been deactivated.

See Also:

Constant Field Values

VIEW_CONTAINER_CREATING

public static final int VIEW_CONTAINER_CREATING

This event indicates that a view container is being created. The view container has been created, but is not yet associated with document views.

See Also:

Constant Field Values

VIEW_CONTAINER_CREATED

public static final int VIEW_CONTAINER_CREATED

This event indicates that the creation of a view container has been completed. The container has been created and document views may have been created and added to the container.

See Also:

Constant Field Values

VIEW_CONTAINER_ACTIVATED

public static final int VIEW_CONTAINER_ACTIVATED

This event indicates that a view container has been activated.

See Also:

Constant Field Values

VIEW_CONTAINER_DEACTIVATED

public static final int VIEW_CONTAINER_DEACTIVATED

This event indicates that a view container has been deactivated.

See Also:

Constant Field Values

VIEW_CONTAINER_CLOSING

public static final int VIEW_CONTAINER_CLOSING

This event indicates that a view container is being closed.

See Also:

Constant Field Values

VIEW_CONTAINER_CLOSED

public static final int VIEW_CONTAINER_CLOSED

This event indicates that a view container has been closed.

See Also:

Constant Field Values

APPLICATION_INITIALIZING_SETTINGS

public static final int APPLICATION_INITIALIZING_SETTINGS

This event indicates that the application is reading and initializing its settings. This event can be processed for adding new settings to the application. This event is triggered before the application is initialized.

See Also:

APPLICATION_INITIALIZED, Constant Field Values

APPLICATION_INITIALIZED

public static final int APPLICATION_INITIALIZED

This event indicates that the application has been initialized. The application is initialized after its method IlvApplication.initialize() has been called. The settings of the application have been read and all the components of the application, such as its main frame, its menu, or its toolbars, have been initialized.

See Also:

APPLICATION_CLOSING, APPLICATION_CLOSED, Constant Field Values

APPLICATION_CLOSING

public static final int APPLICATION_CLOSING

This event indicates that the application is closing.

See Also:

APPLICATION_CLOSED, APPLICATION_INITIALIZED, Constant Field Values

APPLICATION_SAVING_SETTINGS

public static final int APPLICATION_SAVING_SETTINGS

This event indicates that the application is saving the user settings. This event can be processed for saving the settings of a user component.

See Also:

APPLICATION_INITIALIZED, Constant Field Values

MAIN_WINDOW_INITIALIZED

public static final int MAIN_WINDOW_INITIALIZED

This event indicates that a main window has been set to the application. This event can be processed for adding new components to the main window.

See Also:

Constant Field Values

APPLICATION_CLOSED

public static final int APPLICATION_CLOSED

This event indicates that the application is closed. This event is triggered after the application has closed all its open documents and saved its settings.

See Also:

APPLICATION_INITIALIZED, APPLICATION_CLOSING, Constant Field Values

DOCUMENT_INITIALIZING

public static final int DOCUMENT_INITIALIZING

This event indicates that a document is in the process of being created. This event is fired before the document reads its content from a stream or gets initialized by default.

If the initialization process succeeded, the event DOCUMENT_CREATED is fired.

Since:

JViews 6.0

See Also:

DOCUMENT_CREATED, Constant Field Values

APPLICATION_LAST

public static int APPLICATION_LAST

The last number in the range of IDs used for application events.

Constructor Detail

ApplicationEvent

public ApplicationEvent(int id,
                        IlvDocument document)

Constructs an ApplicationEvent with the specified id and document source.

Parameters:

id - The ID of the application event.

document - The document that originated the event.

ApplicationEvent

public ApplicationEvent(int id,
                        IlvDocumentView view)

Constructs an ApplicationEvent with the specified id and document view.

Parameters:

id - The ID of the application event.

view - The document view that originated the event.

ApplicationEvent

public ApplicationEvent(int id,
                        IlvDocument document,
                        IlvDocumentView view,
                        IlvDocumentTemplate documentTemplate)

Constructs an ApplicationEvent with the specified id, document, document view, and documentTemplate.

ApplicationEvent

public ApplicationEvent(int id,
                        IlvDocument document,
                        IlvDocumentView view,
                        IlvViewContainer container,
                        IlvDocumentTemplate documentTemplate)

Constructs an ApplicationEvent with the specified id, document, document view, view container, and documentTemplate.

ApplicationEvent

public ApplicationEvent(int id,
                        IlvViewContainer container)

Constructs an ApplicationEvent with the specified id and view container.

ApplicationEvent

public ApplicationEvent(int id,
                        IlvDocumentTemplate documentTemplate)

Constructs an ApplicationEvent object with the specified id and documentTemplate.

Parameters:

id - The ID of the application event.

documentTemplate - The document template that is activated or deactivated.

ApplicationEvent

public ApplicationEvent(int id,
                        IlvApplication application)

Constructs an ApplicationEvent object with the specified id and application source.

Parameters:

id - The ID of the document event.

application - The application that originated the event.

See Also:

APPLICATION_INITIALIZED, MAIN_WINDOW_INITIALIZED, APPLICATION_CLOSED, APPLICATION_CLOSING

Method Detail

getDocument

public IlvDocument getDocument()

Returns the document originator of the event; null if this event was not originated by a document.

See Also:

setDocument(ilog.views.appframe.docview.IlvDocument), DOCUMENT_CREATED, DOCUMENT_CLOSING, DOCUMENT_CLOSED, DOCUMENT_ACTIVATED, DOCUMENT_DEACTIVATED

setDocument

public void setDocument(IlvDocument document)

Sets the document that originated the event.

Parameters:

document - The document that originated the event.

See Also:

getDocument()

getID

public int getID()

Returns the event type.

getView

public IlvDocumentView getView()

Returns the document view that originated the event; null if this event was not originated by a document view.

See Also:

setView(ilog.views.appframe.docview.IlvDocumentView), DOCUMENT_VIEW_CREATED, DOCUMENT_VIEW_INITIALIZED, DOCUMENT_VIEW_CLOSING, DOCUMENT_VIEW_CLOSED, DOCUMENT_VIEW_ACTIVATED, DOCUMENT_VIEW_DEACTIVATED

setView

public void setView(IlvDocumentView view)

Sets the active view of the document.

Parameters:

view - The new document view of the event.

See Also:

getView()

getViewContainer

public IlvViewContainer getViewContainer()

Returns the view container that originated the event; null if this event was not originated by a view container.

Returns:

the view container.

See Also:

VIEW_CONTAINER_CREATED, VIEW_CONTAINER_ACTIVATED, VIEW_CONTAINER_DEACTIVATED, VIEW_CONTAINER_CLOSING, VIEW_CONTAINER_CLOSED

getDocumentTemplate

public IlvDocumentTemplate getDocumentTemplate()

Returns the document template that originated the event or the document template of the document, document view, or view container that originated the event.

See Also:

getDocumentTemplateName(), DOCUMENT_TEMPLATE_ACTIVATED, DOCUMENT_TEMPLATE_DEACTIVATED

getDocumentTemplateName

public String getDocumentTemplateName()

Returns the name of the document template of the document or document view that originated the event.

Returns:

The name of the document template.

getApplication

public IlvApplication getApplication()

Returns the application that originated this event.

See Also:

APPLICATION_INITIALIZING_SETTINGS, APPLICATION_INITIALIZED, APPLICATION_CLOSING, APPLICATION_SAVING_SETTINGS, MAIN_WINDOW_INITIALIZED, APPLICATION_CLOSED