org.dmd.mvw.tools.mvwgenerator.extended

Class Event

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW

org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition

org.dmd.mvw.tools.mvwgenerator.generated.dmw.EventDMW

org.dmd.mvw.tools.mvwgenerator.extended.Event

All Implemented Interfaces:

org.dmd.dmc.DmcContainerIF, org.dmd.dmc.DmcNamedObjectIF, CodeGenComponentIF

public class Event
extends EventDMW
implements CodeGenComponentIF

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
void	addFiresEventImports(org.dmd.util.codegen.ImportManager im)
void	addHandlesEventImports(org.dmd.util.codegen.ImportManager im)
void	addImport(org.dmd.util.codegen.ImportManager im) Adds the import statement for this event to the import manager
void	checkSanity() Based on local, firedBy and handledBy, we to see if everything is kosher.
void	firedBy(MvwDefinition d)
void	firedLocally(View v)
String	getAbstractMethod()
TreeMap<org.dmd.dmc.types.CamelCaseName,MvwDefinition>	getFiredBy()
String	getFireMethod()
TreeMap<org.dmd.dmc.types.CamelCaseName,MvwDefinition>	getHandledBy()
TreeMap<org.dmd.dmc.types.CamelCaseName,MvwDefinition>	getLocallyFired()
int	getLongestType()
ArrayList<String>	getMembers()
String	getRegisterForEvent()
ArrayList<String>	getTypes()
String	getViewBroadcastMethod()
String	getViewBroadcastOnlyMethod()
String	getViewLocalMethod()
void	handledBy(MvwDefinition d)
boolean	needGwtEvent() A GwtEvent is only required if the event is destined for the EventBus i.e.
void	resetCodeGenInfo() Resets the component's code generation information.
void	showReferences()

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmw.EventDMW

addImportThis, addImportThis, cloneIt, delImportThis, delImportThis, equals, getArgVector, getDMO, getEventName, getImportThisCopy, getImportThisHasValue, getImportThisIsEmpty, getImportThisIterable, getImportThisSize, getModificationRecorder, getObjectName, getObjectNameAttribute, hashCode, importThisContains, isFiredInThisModule, remArgVector, remEventName, remFiredInThisModule, remImportThis, setArgVector, setArgVector, setEventName, setEventName, setFiredInThisModule, setFiredInThisModule

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition

resolveReferences

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW

addDescription, addDescription, delDescription, delDescription, descriptionContains, getCamelCaseName, getDefinedInModule, getDescriptionCopy, getDescriptionHasValue, getDescriptionIsEmpty, getDescriptionIterable, getDescriptionSize, getFile, getLineNumber, remCamelCaseName, remDefinedInModule, remDescription, remFile, remLineNumber, setCamelCaseName, setCamelCaseName, setDefinedInModule, setDefinedInModule, setFile, setFile, setLineNumber, setLineNumber

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Event

public Event()

Method Detail

showReferences

public void showReferences()

getFiredBy

public TreeMap<org.dmd.dmc.types.CamelCaseName,MvwDefinition> getFiredBy()

getHandledBy

public TreeMap<org.dmd.dmc.types.CamelCaseName,MvwDefinition> getHandledBy()

getLocallyFired

public TreeMap<org.dmd.dmc.types.CamelCaseName,MvwDefinition> getLocallyFired()

addImport

public void addImport(org.dmd.util.codegen.ImportManager im)

Adds the import statement for this event to the import manager

Parameters:

im -

addFiresEventImports

public void addFiresEventImports(org.dmd.util.codegen.ImportManager im)

addHandlesEventImports

public void addHandlesEventImports(org.dmd.util.codegen.ImportManager im)

getAbstractMethod

public String getAbstractMethod()

getRegisterForEvent

public String getRegisterForEvent()

getTypes

public ArrayList<String> getTypes()

getMembers

public ArrayList<String> getMembers()

getLongestType

public int getLongestType()

firedLocally

public void firedLocally(View v)

firedBy

public void firedBy(MvwDefinition d)

handledBy

public void handledBy(MvwDefinition d)

checkSanity

public void checkSanity()
                 throws org.dmd.util.exceptions.ResultException

Based on local, firedBy and handledBy, we to see if everything is kosher.

Throws:

org.dmd.util.exceptions.ResultException

needGwtEvent

public boolean needGwtEvent()
                     throws org.dmd.util.exceptions.ResultException

A GwtEvent is only required if the event is destined for the EventBus i.e. if anyone is firing or handling the event. If an event is only used locally, we don't bother generating the GwtEvent.

A special case exists for events that are defined in base modules but never fired in that module. In that case the firedInThisModule flag is set to false and, in that case, we will always generate the event.

Returns:

true the event is fired or handled by any component.

Throws:

org.dmd.util.exceptions.ResultException - if the event is handled but never fired.

getViewLocalMethod

public String getViewLocalMethod()

getViewBroadcastMethod

public String getViewBroadcastMethod()

getViewBroadcastOnlyMethod

public String getViewBroadcastOnlyMethod()

getFireMethod

public String getFireMethod()

resetCodeGenInfo

public void resetCodeGenInfo()

Description copied from interface: CodeGenComponentIF

Resets the component's code generation information.

Specified by:

resetCodeGenInfo in interface CodeGenComponentIF