class CatalogPage

nitc :: CatalogPage

A HTML page in a catalog

This is just a template with the header pre-filled and the footer injected at rendering. Therefore, once instantiated, the content can just be added to it.

Introduced properties

private var _catalog: Catalog

nitc :: CatalogPage :: _catalog

The associated catalog, used to groups options and other global data
private var _more_head: Template

nitc :: CatalogPage :: _more_head

Placeholder to include additional things before the </head>.
private var _rootpath: String

nitc :: CatalogPage :: _rootpath

Relative path to the root directory (with the index file).
private fun add_piwik

nitc :: CatalogPage :: add_piwik

Inject piwik HTML code if required
fun catalog: Catalog

nitc :: CatalogPage :: catalog

The associated catalog, used to groups options and other global data
protected fun catalog=(catalog: Catalog)

nitc :: CatalogPage :: catalog=

The associated catalog, used to groups options and other global data
init defaultinit(catalog: Catalog, rootpath: String)

nitc :: CatalogPage :: defaultinit

fun more_head: Template

nitc :: CatalogPage :: more_head

Placeholder to include additional things before the </head>.
protected fun more_head=(more_head: Template)

nitc :: CatalogPage :: more_head=

Placeholder to include additional things before the </head>.
fun rootpath: String

nitc :: CatalogPage :: rootpath

Relative path to the root directory (with the index file).
protected fun rootpath=(rootpath: String)

nitc :: CatalogPage :: rootpath=

Relative path to the root directory (with the index file).

Redefined properties

redef type SELF: CatalogPage

nitc $ CatalogPage :: SELF

Type of this instance, automatically specialized in every class
redef init init

nitc $ CatalogPage :: init

redef fun rendering

nitc $ CatalogPage :: 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 _catalog: Catalog

nitc :: CatalogPage :: _catalog

The associated catalog, used to groups options and other global data
private var _content: Array[Writable]

template :: Template :: _content

Each sub-elements
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 _more_head: Template

nitc :: CatalogPage :: _more_head

Placeholder to include additional things before the </head>.
private var _render_done: Bool

template :: Template :: _render_done

Flag to avoid multiple rendering
private var _rootpath: String

nitc :: CatalogPage :: _rootpath

Relative path to the root directory (with the index file).
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.
private fun add_piwik

nitc :: CatalogPage :: add_piwik

Inject piwik HTML code if required
fun addn(element: Writable)

template :: Template :: addn

Append element and the end of the template then append a "\n".
fun catalog: Catalog

nitc :: CatalogPage :: catalog

The associated catalog, used to groups options and other global data
protected fun catalog=(catalog: Catalog)

nitc :: CatalogPage :: catalog=

The associated catalog, used to groups options and other global data
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(catalog: Catalog, rootpath: String)

nitc :: CatalogPage :: 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_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 more_head: Template

nitc :: CatalogPage :: more_head

Placeholder to include additional things before the </head>.
protected fun more_head=(more_head: Template)

nitc :: CatalogPage :: more_head=

Placeholder to include additional things before the </head>.
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 rootpath: String

nitc :: CatalogPage :: rootpath

Relative path to the root directory (with the index file).
protected fun rootpath=(rootpath: String)

nitc :: CatalogPage :: rootpath=

Relative path to the root directory (with the index file).
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).
package_diagram nitc::CatalogPage CatalogPage template::Template Template nitc::CatalogPage->template::Template core::Writable Writable template::Template->core::Writable ...core::Writable ... ...core::Writable->core::Writable

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.

Class definitions

nitc $ CatalogPage 
# A HTML page in a catalog
#
# This is just a template with the header pre-filled and the footer injected at rendering.
# Therefore, once instantiated, the content can just be added to it.
class CatalogPage
	super Template

	# The associated catalog, used to groups options and other global data
	var catalog: Catalog

	# Placeholder to include additional things before the `</head>`.
	var more_head = new Template

	# Relative path to the root directory (with the index file).
	#
	# Use "" for pages in the root directory
	# Use ".." for pages in a subdirectory
	var rootpath: String

	redef init
	do
		add """
<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">
	<link rel="stylesheet" media="all" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
	<link rel="stylesheet" media="all" href="{{{rootpath / "style.css"}}}">
"""
		add more_head

		add """
</head>
<body>
<div class='container-fluid'>
 <div class='row'>
  <nav id='topmenu' class='navbar navbar-default navbar-fixed-top' role='navigation'>
   <div class='container-fluid'>
    <div class='navbar-header'>
     <button type='button' class='navbar-toggle' data-toggle='collapse' data-target='#topmenu-collapse'>
      <span class='sr-only'>Toggle menu</span>
      <span class='icon-bar'></span>
      <span class='icon-bar'></span>
      <span class='icon-bar'></span>
     </button>
     <span class='navbar-brand'><a href="http://nitlanguage.org/">Nitlanguage.org</a></span>
    </div>
    <div class='collapse navbar-collapse' id='topmenu-collapse'>
     <ul class='nav navbar-nav'>
      <li><a href="{{{rootpath / "index.html"}}}">Catalog</a></li>
     </ul>
    </div>
   </div>
  </nav>
 </div>
"""
	end

	# Inject piwik HTML code if required
	private fun add_piwik
	do
		var tracker_url = catalog.piwik_tracker
		if tracker_url == null then return

		var site_id = catalog.piwik_site_id

		tracker_url = tracker_url.trim
		if tracker_url.chars.last != '/' then tracker_url += "/"
		add """
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://{{{tracker_url.escape_to_c}}}";
_paq.push(['setTrackerUrl', u+'piwik.php']);
_paq.push(['setSiteId', {{{site_id}}}]);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript';
g.defer=true; g.async=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
})();

</script>
<noscript><p><img src="http://{{{tracker_url.html_escape}}}piwik.php?idsite={{{site_id}}}" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code -->
"""

	end

	redef fun rendering
	do
		add """
</div> <!-- container-fluid -->
<script src='https://code.jquery.com/jquery-latest.min.js'></script>
<script src='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js'></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/bootstrap-table/1.8.1/bootstrap-table-all.min.js'></script>
"""
		add_piwik
		add """

</body>
</html>
"""
	end
end
src/nitcatalog.nit:29,1--133,3
Nit tools. Version .