Top menu bar template

Introduced properties

private var _active_item: nullable ListItem

nitc :: DocTopMenu :: _active_item

Active menu item

private var _brand: nullable Link

nitc :: DocTopMenu :: _brand

Brand link to display in first position of the top menu

fun active_item: nullable ListItem

nitc :: DocTopMenu :: active_item

Active menu item

fun active_item=(active_item: nullable ListItem)

nitc :: DocTopMenu :: active_item=

Active menu item

fun brand: nullable Link

nitc :: DocTopMenu :: brand

Brand link to display in first position of the top menu

fun brand=(brand: nullable Link)

nitc :: DocTopMenu :: brand=

Brand link to display in first position of the top menu

init defaultinit(items: nullable Array[ListItem], css_classes: nullable Array[String])

nitc :: DocTopMenu :: defaultinit

Redefined properties

redef type SELF: DocTopMenu

nitc $ DocTopMenu :: SELF

Type of this instance, automatically specialized in every class

redef fun rendering

nitc $ DocTopMenu :: 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 _active_item: nullable ListItem

nitc :: DocTopMenu :: _active_item

Active menu item

private var _brand: nullable Link

nitc :: DocTopMenu :: _brand

Brand link to display in first position of the top menu

private var _content: Array[Writable]

template :: Template :: _content

Each sub-elements

private var _css_classes: Array[String]

html :: BSComponent :: _css_classes

CSS classes to add on this element.

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 _items: Array[ListItem]

html :: HTMLList :: _items

A list contains <li> tags as children.

private var _render_done: Bool

template :: Template :: _render_done

Flag to avoid multiple rendering

fun active_item: nullable ListItem

nitc :: DocTopMenu :: active_item

Active menu item

fun active_item=(active_item: nullable ListItem)

nitc :: DocTopMenu :: active_item=

Active menu item

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_li(item: ListItem)

html :: HTMLList :: add_li

Adds a new ListItem to self.

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

fun brand: nullable Link

nitc :: DocTopMenu :: brand

Brand link to display in first position of the top menu

fun brand=(brand: nullable Link)

nitc :: DocTopMenu :: brand=

Brand link to display in first position of the top menu

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

fun css_classes: Array[String]

html :: BSComponent :: css_classes

CSS classes to add on this element.

protected fun css_classes=(css_classes: nullable Array[String])

html :: BSComponent :: css_classes=

CSS classes to add on this element.

init defaultinit(items: nullable Array[ListItem], css_classes: nullable Array[String])

html :: UnorderedList :: defaultinit

init defaultinit(items: nullable Array[ListItem], css_classes: nullable Array[String])

html :: HTMLList :: defaultinit

init defaultinit(css_classes: nullable Array[String])

html :: BSComponent :: defaultinit

init defaultinit(items: nullable Array[ListItem], css_classes: nullable Array[String])

nitc :: DocTopMenu :: defaultinit

init defaultinit

template :: Template :: defaultinit

init defaultinit

core :: Object :: defaultinit

init defaultinit

core :: Writable :: 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.

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_empty: Bool

html :: HTMLList :: is_empty

Does self contains no items?

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 items: Array[ListItem]

html :: HTMLList :: items

A list contains <li> tags as children.

protected fun items=(items: nullable Array[ListItem])

html :: HTMLList :: items=

A list contains <li> tags as children.

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

fun render_css_classes: String

html :: BSComponent :: render_css_classes

Render self css clases as a class attribute.

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.

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

abstract class BSComponent

html :: BSComponent

Bootstrap component abstraction.

abstract class HTMLList

html :: HTMLList

An abstract HTML list.

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

class UnorderedList

html :: UnorderedList

A <ul> list tag.

Class definitions

nitc $ DocTopMenu

# Top menu bar template
class DocTopMenu
	super UnorderedList

	# Brand link to display in first position of the top menu
	#
	# This is where you want to put your logo.
	var brand: nullable Link is noinit, writable

	# Active menu item
	#
	# Depends on the current page, this allows to hilighted the current item.
	var active_item: nullable ListItem is noinit, writable

	redef fun rendering do
		addn "<nav class='navbar navbar-default navbar-fixed-top'>"
		addn " <div class='container-fluid'>"
		addn "  <div class='navbar-header'>"
		add  "   <button type='button' class='navbar-toggle' "
		addn "       data-toggle='collapse' data-target='#topmenu-collapse'>"
		addn "    <span class='sr-only'>Toggle menu</span>"
		addn "    <span class='icon-bar'></span>"
		addn "    <span class='icon-bar'></span>"
		addn "    <span class='icon-bar'></span>"
		addn "   </button>"
		var brand = self.brand
		if brand != null then
			add "<span class='navbar-brand'>"
			add brand
			add "</span>"
		end
		addn "  </div>"
		addn "  <div class='collapse navbar-collapse' id='topmenu-collapse'>"
		addn "   <ul class='nav navbar-nav'>"
		for item in items do
			if item == active_item then item.css_classes.add "active"
			add item.write_to_string
		end
		addn "   </ul>"
		addn "   <div id='search-placeholder'>"
		addn "   </div>"
		addn "  </div>"
		addn " </div>"
		addn "</nav>"
	end
end

src/doc/static/static_html.nit:272,1--317,3