org.dmd.mvw.tools.mvwgenerator.extended

Class View

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.ViewDMW

org.dmd.mvw.tools.mvwgenerator.extended.View

All Implemented Interfaces:

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

public class View
extends ViewDMW
implements CodeGenComponentIF

The View class extends the basic View definition to provide a variety of consistency checking and the creation of various information required to format the View interface.

The generated code from this falls into 3 main areas: the ViewIF and its associated ViewPresenterIF and the ViewBaseImpl.

The ViewIF will contain the various viewMethods and will require the viewImports.

The ViewPresenterIF will contain the various presenterMethods and presenterImports as well as any local event dependencies.

The ViewBaseImpl will have dependencies on the events that it fires and the usesRunContextItem indications.

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	View()
protected	View(ViewDMO obj, org.dmd.dms.ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
String	getAsyncImport()
String	getAsyncInterface()
String	getBaseImplImport()
String	getDataMethods()
String	getExtendedClassImport()
String	getExtendedClassPackage()
String	getInterfaceImports()
org.dmd.util.codegen.ImportManager	getPresenterImplImports()
String	getPresenterImport()
String	getPresenterMethods()
RunContextItem	getRunContextItem()
String	getViewImplImports()
String	getViewImplMethods()
String	getViewImport()
String	getViewMethods()
void	initCodeGenInfo()
boolean	requiresEventBus() A convenience method to check to see whether or not the View broadcasts any events, in which case it requires the eventBus RunContextItem.
void	resetCodeGenInfo() Resets the component's code generation information.
void	setRunContextItem(RunContextItem i)

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

addBroadcast, addBroadcastOnly, addClickEvent, addClickEvent, addDeleteEvent, addDeleteEvent, addDisplayDMO, addDisplayDMO, addExtendsInterface, addExtendsInterface, addLocal, addPresenterImport, addPresenterImport, addPresenterMethod, addPresenterMethod, addSelectEvent, addSelectEvent, addSharedImport, addSharedImport, addUsesRunContextItem, addViewImport, addViewImport, addViewMethod, addViewMethod, clickEventContains, cloneIt, delBroadcast, delBroadcastOnly, delClickEvent, delClickEvent, delDeleteEvent, delDeleteEvent, delDisplayDMO, delDisplayDMO, deleteEventContains, delExtendsInterface, delExtendsInterface, delLocal, delPresenterImport, delPresenterImport, delPresenterMethod, delPresenterMethod, delSelectEvent, delSelectEvent, delSharedImport, delSharedImport, delUsesRunContextItem, delViewImport, delViewImport, delViewMethod, delViewMethod, displayDMOContains, equals, extendsInterfaceContains, getBroadcastCopy, getBroadcastHasValue, getBroadcastIsEmpty, getBroadcastIterable, getBroadcastOnlyCopy, getBroadcastOnlyHasValue, getBroadcastOnlyIsEmpty, getBroadcastOnlyIterable, getBroadcastOnlySize, getBroadcastSize, getClickEventCopy, getClickEventHasValue, getClickEventIsEmpty, getClickEventIterable, getClickEventSize, getCreateEvent, getDeleteEventCopy, getDeleteEventHasValue, getDeleteEventIsEmpty, getDeleteEventIterable, getDeleteEventSize, getDisplayDMOCopy, getDisplayDMOHasValue, getDisplayDMOIsEmpty, getDisplayDMOIterable, getDisplayDMOSize, getDMO, getExtendsInterfaceCopy, getExtendsInterfaceHasValue, getExtendsInterfaceIsEmpty, getExtendsInterfaceIterable, getExtendsInterfaceSize, getLocalCopy, getLocalHasValue, getLocalIsEmpty, getLocalIterable, getLocalSize, getModificationRecorder, getModifyEvent, getObjectName, getObjectNameAttribute, getPresenterImportCopy, getPresenterImportHasValue, getPresenterImportIsEmpty, getPresenterImportIterable, getPresenterImportSize, getPresenterMethodCopy, getPresenterMethodHasValue, getPresenterMethodIsEmpty, getPresenterMethodIterable, getPresenterMethodSize, getSelectEventCopy, getSelectEventHasValue, getSelectEventIsEmpty, getSelectEventIterable, getSelectEventSize, getSharedImportCopy, getSharedImportHasValue, getSharedImportIsEmpty, getSharedImportIterable, getSharedImportSize, getSubpackage, getUseBaseClass, getUsesRunContextItemCopy, getUsesRunContextItemHasValue, getUsesRunContextItemIsEmpty, getUsesRunContextItemIterable, getUsesRunContextItemSize, getViewImportCopy, getViewImportHasValue, getViewImportIsEmpty, getViewImportIterable, getViewImportSize, getViewMethodCopy, getViewMethodHasValue, getViewMethodIsEmpty, getViewMethodIterable, getViewMethodSize, getViewName, hashCode, isCodeSplit, isWidget, presenterImportContains, presenterMethodContains, remBroadcast, remBroadcastOnly, remClickEvent, remCodeSplit, remCreateEvent, remDeleteEvent, remDisplayDMO, remExtendsInterface, remLocal, remModifyEvent, remPresenterImport, remPresenterMethod, remSelectEvent, remSharedImport, remSubpackage, remUseBaseClass, remUsesRunContextItem, remViewImport, remViewMethod, remViewName, remWidget, selectEventContains, setCodeSplit, setCodeSplit, setCreateEvent, setCreateEvent, setModifyEvent, setModifyEvent, setSubpackage, setSubpackage, setUseBaseClass, setUseBaseClass, setViewName, setViewName, setWidget, setWidget, sharedImportContains, viewImportContains, viewMethodContains

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

View

public View()

View

protected View(ViewDMO obj,
               org.dmd.dms.ClassDefinition cd)

Method Detail

resetCodeGenInfo

public void resetCodeGenInfo()

Description copied from interface: CodeGenComponentIF

Resets the component's code generation information.

Specified by:

resetCodeGenInfo in interface CodeGenComponentIF

setRunContextItem

public void setRunContextItem(RunContextItem i)

getRunContextItem

public RunContextItem getRunContextItem()

requiresEventBus

public boolean requiresEventBus()

A convenience method to check to see whether or not the View broadcasts any events, in which case it requires the eventBus RunContextItem.

Returns:

true is there are any broadcast events and false otherwise.

getPresenterImport

public String getPresenterImport()

getViewImport

public String getViewImport()

getBaseImplImport

public String getBaseImplImport()

getPresenterImplImports

public org.dmd.util.codegen.ImportManager getPresenterImplImports()

getExtendedClassImport

public String getExtendedClassImport()

Returns:

the fully qualified name of this view's extended implementation.

getExtendedClassPackage

public String getExtendedClassPackage()

initCodeGenInfo

public void initCodeGenInfo()
                     throws org.dmd.util.exceptions.ResultException,
                            org.dmd.dmc.DmcValueException

Throws:

org.dmd.util.exceptions.ResultException

org.dmd.dmc.DmcValueException

getInterfaceImports

public String getInterfaceImports()

getViewImplImports

public String getViewImplImports()

getViewImplMethods

public String getViewImplMethods()

getPresenterMethods

public String getPresenterMethods()

getViewMethods

public String getViewMethods()

getDataMethods

public String getDataMethods()

getAsyncImport

public String getAsyncImport()

Returns:

the import for ViewAsyncIF associated with this presenter.

getAsyncInterface

public String getAsyncInterface()

Returns:

the ViewAsyncIF name for this view.