org.openbp.guiclient.event
Class OpenEvent

java.lang.Object
  java.util.EventObject
      org.openbp.jaspira.event.JaspiraEvent
          org.openbp.guiclient.event.OpenEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

FileOpenEvent

public class OpenEvent
extends JaspiraEvent

This event is used if an object is to be opened in its associated editor.

Author:

Stephan Moritz

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openbp.jaspira.event.JaspiraEvent

CONSUMED, HANDELED, STACKABLE, TYPE_BOTTOM_UP, TYPE_DIRECT, TYPE_FLOOD, TYPE_GLOBAL, UNCONSUMABLE

Fields inherited from class java.util.EventObject

source

Constructor Summary

OpenEvent(Plugin source, java.lang.String eventName, java.lang.Object o)
Constructor.

Method Summary

int	getAssociationProperty() Gets the association property (as alternative to a MIME type).
java.lang.String[]	getMimeTypes() Gets the mIME type(s) of the object.
java.lang.Object	getUnderlyingObject() Gets the underlying object.
boolean	isCreate() Gets the flag if a new instance of the object should be create if it is not existend.
boolean	isReadonly() Gets the flag if the object should be opened in read only mode.
void	setAssociationProperty(int associationProperty) Sets the association property (as alternative to a MIME type).
void	setCreate(boolean create) Sets the flag if a new instance of the object should be create if it is not existend.
void	setMimeTypes(java.lang.String[] mimeTypes) Sets the mIME type(s) of the object.
void	setReadonly(boolean readonly) Sets the flag if the object should be opened in read only mode.
void	setUnderlyingObject(java.lang.Object underlyingObject) Sets the underlying object.

Methods inherited from class org.openbp.jaspira.event.JaspiraEvent

brand, getBrand, getEventGroup, getEventName, getFlags, getLevel, getObject, getOriginalEvent, getSourcePlugin, getTargetClassName, getTargetPluginId, getType, isConsumed, isStackable, isUnconsumable, setObject, setTargetClassName, setTargetPluginId, toString, updateFlags, updateFlags

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenEvent

public OpenEvent(Plugin source,
                 java.lang.String eventName,
                 java.lang.Object o)

Constructor. In Comparison to the object that shall be opened the underlying object contains the environmental information of former.

Parameters:

source - Source of the event

eventName - Name of the event

o - Object that shall be opened (i.e. FileName)

Method Detail

isReadonly

public boolean isReadonly()

Gets the flag if the object should be opened in read only mode.

setReadonly

public void setReadonly(boolean readonly)

Sets the flag if the object should be opened in read only mode.

isCreate

public boolean isCreate()

Gets the flag if a new instance of the object should be create if it is not existend.

setCreate

public void setCreate(boolean create)

Sets the flag if a new instance of the object should be create if it is not existend.

getUnderlyingObject

public java.lang.Object getUnderlyingObject()

Gets the underlying object. In Comparison to the object that shall be opened the underlying object contains the environmental information of former.

setUnderlyingObject

public void setUnderlyingObject(java.lang.Object underlyingObject)

Sets the underlying object.

getMimeTypes

public java.lang.String[] getMimeTypes()

Gets the mIME type(s) of the object.

setMimeTypes

public void setMimeTypes(java.lang.String[] mimeTypes)

Sets the mIME type(s) of the object.

getAssociationProperty

public int getAssociationProperty()

Gets the association property (as alternative to a MIME type).

setAssociationProperty

public void setAssociationProperty(int associationProperty)

Sets the association property (as alternative to a MIME type).