A card about a mentity

It displays the documentation about the model entity.

Introduced properties

private var _full_doc: Bool

nitc :: CardMEntity :: _full_doc

Render the mentity full documentation?

private var _id: String

nitc :: CardMEntity :: _id

private var _mentity: MEntity

nitc :: CardMEntity :: _mentity

MEntity displayed in this card

private var _title: String

nitc :: CardMEntity :: _title

init defaultinit(mentity: MEntity, full_doc: nullable Bool)

nitc :: CardMEntity :: defaultinit

fun full_doc: Bool

nitc :: CardMEntity :: full_doc

Render the mentity full documentation?

fun full_doc=(full_doc: nullable Bool)

nitc :: CardMEntity :: full_doc=

Render the mentity full documentation?

fun mentity: MEntity

nitc :: CardMEntity :: mentity

MEntity displayed in this card

fun mentity=(mentity: MEntity)

nitc :: CardMEntity :: mentity=

MEntity displayed in this card

Redefined properties

redef type SELF: CardMEntity

nitc $ CardMEntity :: SELF

Type of this instance, automatically specialized in every class

redef fun id: String

nitc $ CardMEntity :: id

Card id

redef fun id=(id: String)

nitc $ CardMEntity :: id=

Card id

redef fun rendering

nitc $ CardMEntity :: rendering

Service used to render the content of the template.

redef fun title: String

nitc $ CardMEntity :: title

Card title

redef fun title=(title: String)

nitc $ CardMEntity :: title=

Card title

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?

fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?

type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.

type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class

private var _content: Array[Writable]

template :: Template :: _content

Each sub-elements

private var _full_doc: Bool

nitc :: CardMEntity :: _full_doc

Render the mentity full documentation?

private var _id: String

nitc :: CardMEntity :: _id

private var _id: String

nitc :: StaticCard :: _id

Card id

private var _is_frozen: Bool

template :: Template :: _is_frozen

Is the template allowing more modification (add)

private var _is_writing: Bool

template :: Template :: _is_writing

Flag to avoid infinite recursivity if a template contains itself

private var _mentity: MEntity

nitc :: CardMEntity :: _mentity

MEntity displayed in this card

private var _render_done: Bool

template :: Template :: _render_done

Flag to avoid multiple rendering

private var _title: String

nitc :: CardMEntity :: _title

private var _title: String

nitc :: StaticCard :: _title

Card title

fun add(element: Writable)

template :: Template :: add

Append an element (String, other Template, etc.) at the end of the template.

fun add_all(elements: Collection[Writable])

template :: Template :: add_all

Append a bunch of elements at the end of the template.

fun add_list(elements: Collection[Writable], sep: Writable, last_sep: Writable)

template :: Template :: add_list

Append a bunch of elements at the end of the template with separations.

fun addn(element: Writable)

template :: Template :: addn

Append element and the end of the template then append a "\n".

protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.

fun class_name: String

core :: Object :: class_name

The class name of the object.

private fun content: Array[Writable]

template :: Template :: content

Each sub-elements

private fun content=(content: Array[Writable])

template :: Template :: content=

Each sub-elements

init defaultinit(mentity: MEntity, full_doc: nullable Bool)

nitc :: CardMEntity :: defaultinit

init defaultinit

core :: Object :: defaultinit

init defaultinit

core :: Writable :: defaultinit

init defaultinit

template :: Template :: defaultinit

init defaultinit(title: String, id: String)

nitc :: StaticCard :: defaultinit

fun force_render

template :: Template :: force_render

Call rendering, if not already done

fun freeze

template :: Template :: freeze

Disable further modification: no more add is allowed

fun full_doc: Bool

nitc :: CardMEntity :: full_doc

Render the mentity full documentation?

fun full_doc=(full_doc: nullable Bool)

nitc :: CardMEntity :: full_doc=

Render the mentity full documentation?

fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.

fun hash: Int

core :: Object :: hash

The hash code of the object.

fun id: String

nitc :: StaticCard :: id

Card id

fun id=(id: String)

nitc :: StaticCard :: id=

Card id

init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.

protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".

fun is_frozen: Bool

template :: Template :: is_frozen

Is the template allowing more modification (add)

protected fun is_frozen=(is_frozen: Bool)

template :: Template :: is_frozen=

Is the template allowing more modification (add)

intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).

fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?

intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.

private fun is_writing: Bool

template :: Template :: is_writing

Flag to avoid infinite recursivity if a template contains itself

private fun is_writing=(is_writing: Bool)

template :: Template :: is_writing=

Flag to avoid infinite recursivity if a template contains itself

fun mentity: MEntity

nitc :: CardMEntity :: mentity

MEntity displayed in this card

fun mentity=(mentity: MEntity)

nitc :: CardMEntity :: mentity=

MEntity displayed in this card

private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.

fun new_sub: Template

template :: Template :: new_sub

Return a new basic template that is automatically added in self (using add)

intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.

fun output

core :: Object :: output

Display self on stdout (debug only).

intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).

private fun render_done: Bool

template :: Template :: render_done

Flag to avoid multiple rendering

private fun render_done=(render_done: Bool)

template :: Template :: render_done=

Flag to avoid multiple rendering

protected fun rendering

template :: Template :: rendering

Service used to render the content of the template.

fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization

intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.

fun title: String

nitc :: StaticCard :: title

Card title

fun title=(title: String)

nitc :: StaticCard :: title=

Card title

abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.

abstract fun write_to(stream: Writer)

core :: Writable :: write_to

Write itself to a stream

fun write_to_bytes: Bytes

core :: Writable :: write_to_bytes

Like write_to but return a new Bytes (may be quite large)

fun write_to_file(filepath: String)

core :: Writable :: write_to_file

Like write_to but take care of creating the file

fun write_to_string: String

core :: Writable :: write_to_string

Like write_to but return a new String (may be quite large).

Ancestors

interface Object

The root of the class hierarchy.

class Template

template :: Template

Templates are simple hierarchical pieces of text used for efficient stream writing.

interface Writable

core :: Writable

Things that can be efficienlty written to a Writer

Parents

abstract class StaticCard

nitc :: StaticCard

A card that can be rendered to HTML

Children

class CardCatalogPackage

nitc :: CardCatalogPackage

A card that displays a package from a Nit catalog

class CardCode

nitc :: CardCode

A card that displays the code of a MEntity

class CardGraph

nitc :: CardGraph

A card that displays a graph

class CardInheritance

nitc :: CardInheritance

A card about the inheritance of a MEntity

class CardLinearizationList

nitc :: CardLinearizationList

A card about the linearization of a MEntity

class CardMDoc

nitc :: CardMDoc

A card that displays the content of a MDoc

class CardMetadata

nitc :: CardMetadata

A card that displays the metadata about a package in the Nit catalog

Descendants

class CardLinearizationDef

nitc :: CardLinearizationDef

A card about a definition in a linearization list

class CardMdSummary

nitc :: CardMdSummary

A card that displays the summary of a Markdown document

Class definitions

nitc $ CardMEntity

# A card about a mentity
#
# It displays the documentation about the model entity.
class CardMEntity
	super StaticCard
	autoinit(mentity, full_doc)

	# MEntity displayed in this card
	var mentity: MEntity is writable

	# Render the mentity full documentation?
	var full_doc = false is optional, writable

	redef var id = mentity.html_id is lazy
	redef var title = mentity.html_name is lazy

	redef fun rendering do
		addn """
		<div id='{{{id}}}' class='card'>
			<div class='card-left text-center'>
			{{{mentity.html_icon.write_to_string}}}
			</div>
			<div class='card-body'>
				<h5 class='card-heading'>
					{{{mentity.html_declaration.write_to_string}}}
				</h5>
				<p><small>{{{mentity.html_namespace.write_to_string}}}</small></p>"""
		var mdoc = mentity.mdoc_or_fallback
		if mdoc != null then
			if full_doc then
				addn mdoc.html_documentation
			else
				addn mdoc.html_synopsis
			end
		end
		addn """
			</div>
		</div>"""
	end
end

src/doc/static/static_cards.nit:176,1--215,3