org.modelio.api.ui.form.models

Class NoteFieldData

java.lang.Object

org.modelio.api.ui.form.models.NoteFieldData

All Implemented Interfaces:

IFormFieldData

public class NoteFieldData
extends java.lang.Object
implements IFormFieldData

Constructor Summary

Constructors

Constructor and Description
NoteFieldData(IModelingSession modelingSession, ModelElement me, java.lang.String moduleName, java.lang.String noteTypeName) Creates a note field data.
NoteFieldData(IModelingSession modelingSession, ModelElement me, java.lang.String moduleName, java.lang.String noteTypeName, java.lang.String newNoteType)

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	computeNoteLabel(IModelingSession modelingSession, NoteType noteType, java.lang.String noteTypeName)
protected IModelingSession	getModelingSession()
java.lang.String	getName()
protected Note	getNote()
IFormFieldType	getType()
java.lang.Object	getValue()
protected NoteType	resolveNoteModel(ModelElement el, java.lang.String aModuleName, java.lang.String type)
void	setValue(java.lang.Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteFieldData

public NoteFieldData(IModelingSession modelingSession,
                     ModelElement me,
                     java.lang.String moduleName,
                     java.lang.String noteTypeName)

Creates a note field data.

Notes will be created as HTML if the note type MIME type is HTML, plain text in all other cases.

Parameters:

modelingSession - the Modeling session, needed since 3.8 .

me - the edited element

moduleName - the note type module

noteTypeName - the note type module name

NoteFieldData

public NoteFieldData(IModelingSession modelingSession,
                     ModelElement me,
                     java.lang.String moduleName,
                     java.lang.String noteTypeName,
                     java.lang.String newNoteType)

Parameters:

modelingSession - the Modeling session, needed since 3.8 .

me - the edited element

moduleName - the note type module

noteTypeName - the note type module name

newNoteType - the new notes MIME type : either "plain" or "html"

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface IFormFieldData

getType

public IFormFieldType getType()

Specified by:

getType in interface IFormFieldData

getValue

public java.lang.Object getValue()

Specified by:

getValue in interface IFormFieldData

setValue

public void setValue(java.lang.Object value)

Specified by:

setValue in interface IFormFieldData

computeNoteLabel

protected static java.lang.String computeNoteLabel(IModelingSession modelingSession,
                                                   NoteType noteType,
                                                   java.lang.String noteTypeName)

getModelingSession

protected IModelingSession getModelingSession()

getNote

protected Note getNote()

resolveNoteModel

protected NoteType resolveNoteModel(ModelElement el,
                                    java.lang.String aModuleName,
                                    java.lang.String type)