class DocTab

nitc :: DocTab

A documentation tabulated view

Introduced properties

private var _content: Array[StaticCard]

nitc :: DocTab :: _content

Tab content
private var _icon: nullable String

nitc :: DocTab :: _icon

Tab header icon
private var _id: String

nitc :: DocTab :: _id

Tab uniq id in the page
private var _is_active: Bool

nitc :: DocTab :: _is_active

Is this tab displayed by default?
private var _metadata: DocSidebar

nitc :: DocTab :: _metadata

Tab metadata sidebar
private var _show_sidebar: Bool

nitc :: DocTab :: _show_sidebar

Show sidebar for this page?
private var _sidebar: DocSidebar

nitc :: DocTab :: _sidebar

Tab sidebar
private var _title: String

nitc :: DocTab :: _title

Table title
fun content: Array[StaticCard]

nitc :: DocTab :: content

Tab content
protected fun content=(content: Array[StaticCard])

nitc :: DocTab :: content=

Tab content
init defaultinit(id: String, title: String, is_active: nullable Bool, icon: nullable String)

nitc :: DocTab :: defaultinit

fun icon: nullable String

nitc :: DocTab :: icon

Tab header icon
fun icon=(icon: nullable String)

nitc :: DocTab :: icon=

Tab header icon
fun id: String

nitc :: DocTab :: id

Tab uniq id in the page
fun id=(id: String)

nitc :: DocTab :: id=

Tab uniq id in the page
fun is_active: Bool

nitc :: DocTab :: is_active

Is this tab displayed by default?
fun is_active=(is_active: nullable Bool)

nitc :: DocTab :: is_active=

Is this tab displayed by default?
fun is_empty: Bool

nitc :: DocTab :: is_empty

Is this tab empty?
fun metadata: DocSidebar

nitc :: DocTab :: metadata

Tab metadata sidebar
protected fun metadata=(metadata: DocSidebar)

nitc :: DocTab :: metadata=

Tab metadata sidebar
fun show_sidebar: Bool

nitc :: DocTab :: show_sidebar

Show sidebar for this page?
fun show_sidebar=(show_sidebar: Bool)

nitc :: DocTab :: show_sidebar=

Show sidebar for this page?
fun sidebar: DocSidebar

nitc :: DocTab :: sidebar

Tab sidebar
protected fun sidebar=(sidebar: DocSidebar)

nitc :: DocTab :: sidebar=

Tab sidebar
fun title: String

nitc :: DocTab :: title

Table title
fun title=(title: String)

nitc :: DocTab :: title=

Table title

Redefined properties

redef type SELF: DocTab

nitc $ DocTab :: SELF

Type of this instance, automatically specialized in every class
redef fun rendering

nitc :: static_html $ DocTab :: rendering

Service used to render the content of the template.

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 _content: Array[StaticCard]

nitc :: DocTab :: _content

Tab content
private var _icon: nullable String

nitc :: DocTab :: _icon

Tab header icon
private var _id: String

nitc :: DocTab :: _id

Tab uniq id in the page
private var _is_active: Bool

nitc :: DocTab :: _is_active

Is this tab displayed by default?
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 _metadata: DocSidebar

nitc :: DocTab :: _metadata

Tab metadata sidebar
private var _render_done: Bool

template :: Template :: _render_done

Flag to avoid multiple rendering
private var _show_sidebar: Bool

nitc :: DocTab :: _show_sidebar

Show sidebar for this page?
private var _sidebar: DocSidebar

nitc :: DocTab :: _sidebar

Tab sidebar
private var _title: String

nitc :: DocTab :: _title

Table 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.
fun content: Array[StaticCard]

nitc :: DocTab :: content

Tab content
private fun content: Array[Writable]

template :: Template :: content

Each sub-elements
private fun content=(content: Array[Writable])

template :: Template :: content=

Each sub-elements
protected fun content=(content: Array[StaticCard])

nitc :: DocTab :: content=

Tab content
init defaultinit(id: String, title: String, is_active: nullable Bool, icon: nullable String)

nitc :: DocTab :: 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 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 icon: nullable String

nitc :: DocTab :: icon

Tab header icon
fun icon=(icon: nullable String)

nitc :: DocTab :: icon=

Tab header icon
fun id: String

nitc :: DocTab :: id

Tab uniq id in the page
fun id=(id: String)

nitc :: DocTab :: id=

Tab uniq id in the page
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_active: Bool

nitc :: DocTab :: is_active

Is this tab displayed by default?
fun is_active=(is_active: nullable Bool)

nitc :: DocTab :: is_active=

Is this tab displayed by default?
fun is_empty: Bool

nitc :: DocTab :: is_empty

Is this tab empty?
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 metadata: DocSidebar

nitc :: DocTab :: metadata

Tab metadata sidebar
protected fun metadata=(metadata: DocSidebar)

nitc :: DocTab :: metadata=

Tab metadata sidebar
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
fun show_sidebar: Bool

nitc :: DocTab :: show_sidebar

Show sidebar for this page?
fun show_sidebar=(show_sidebar: Bool)

nitc :: DocTab :: show_sidebar=

Show sidebar for this page?
fun sidebar: DocSidebar

nitc :: DocTab :: sidebar

Tab sidebar
protected fun sidebar=(sidebar: DocSidebar)

nitc :: DocTab :: sidebar=

Tab sidebar
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun title: String

nitc :: DocTab :: title

Table title
fun title=(title: String)

nitc :: DocTab :: title=

Table 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).
package_diagram nitc::DocTab DocTab template::Template Template nitc::DocTab->template::Template core::Writable Writable template::Template->core::Writable ...core::Writable ... ...core::Writable->core::Writable nitc::DocTabLink DocTabLink nitc::DocTabLink->nitc::DocTab

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Writable

core :: Writable

Things that can be efficienlty written to a Writer

Parents

class Template

template :: Template

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

Children

Class definitions

nitc $ DocTab 
# A documentation tabulated view
class DocTab

	# Tab uniq id in the page
	var id: String is writable

	# Table title
	var title: String is writable

	# Is this tab displayed by default?
	var is_active = false is optional, writable

	# Tab header icon
	var icon: nullable String = null is optional, writable

	# Tab content
	var content = new Array[StaticCard]

	# Tab sidebar
	var sidebar = new DocSidebar

	# Tab metadata sidebar
	var metadata = new DocSidebar

	# Is this tab empty?
	fun is_empty: Bool do return content.is_empty
end
src/doc/static/static_base.nit:305,1--331,3

nitc :: static_html $ DocTab 
redef class DocTab
	super Template

	# Show sidebar for this page?
	var show_sidebar = true is writable

	# Tab link for tab headers
	fun tab_link: Template do
		var tpl = new Template
		tpl.addn "<li class='{if is_active then "active" else ""}'>"
		tpl.addn " <a data-toggle='tab' href='#{id}'>"

		var icon = self.icon
		if icon != null then
			tpl.addn "  <span class='glyphicon glyphicon-{icon}'></span>"
		end
		tpl.addn " {title}"
		tpl.addn " </a>"
		tpl.addn "</li>"
		return tpl
	end

	redef fun rendering do
		var has_left = show_sidebar and sidebar.cards.not_empty
		var has_right = metadata.cards.not_empty

		addn "<div class='tab-pane {if is_active then "active" else ""}' id='{id}'>"
		if has_left then
			addn " <div class='col-sm-3'>"
			addn sidebar
			addn " </div>"
		end
		var cols = 12
		if has_left then cols -= 3
		if has_right then cols -= 3
		addn " <div class='col-sm-{cols}'>"
		for card in content do addn card
		addn " </div>"
		if has_right then
			addn " <div class='col-sm-3'>"
			addn metadata
			addn " </div>"
		end
		addn "</div>"
	end
end
src/doc/static/static_html.nit:205,1--250,3
Nit tools. Version .