Inheritance diagram for org.turro.collections.CollectionHtmlIterator< E, ID >:

[legend]

Collaboration diagram for org.turro.collections.CollectionHtmlIterator< E, ID >:

[legend]

Public Member Functions
	CollectionHtmlIterator (List collection, ElephantMarker marker)

	CollectionHtmlIterator (List collection, ElephantMarker marker, Writer writer)

void	setSummaryTemplate (String summaryTemplate)

String	getSummaryTemplate ()

void	setFullTemplate (String fullTemplate)

String	getFullTemplate ()

boolean	isNavigatorTop ()

void	setNavigatorTop (boolean navigatorTop)

boolean	isNavigatorBottom ()

void	setNavigatorBottom (boolean navigatorBottom)

boolean	isSearchOption ()

void	setSearchOption (boolean searchOption)

boolean	isForceSummary ()

void	setForceSummary (boolean forceSummary)

boolean	wantItem ()

boolean	isItem ()

Object	addAttribute (String key, Object value)

Writer	getWriter ()

void	load ()

void	forceItem (ID item)

String	getTitle ()

Collection< String >	getMetas ()

void	render ()

boolean	isFirst ()

boolean	isLast ()

String	renderSearchEngine ()

String	renderTree ()

String	renderTreeSelection ()

boolean	isEmpty ()

Public Member Functions inherited from org.turro.collections.CollectionIterator< E, ID >
	CollectionIterator (List< E > collection)

int	getPage ()

void	setPage (int page)

void	initClauses ()

List< E >	getItems ()

int	getTotalCount ()

List< E >	getTotalItems ()

int	item ()

void	current (int value)

int	current ()

int	pages ()

boolean	beginning ()

boolean	end ()

void	next ()

void	previous ()

Protected Member Functions
abstract E	entity (ID value)

abstract void	renderSummary (ElephantMarker marker, E e, int page)

abstract void	renderItem (ElephantMarker marker, E e, int page)

abstract String	title (E e)

abstract Collection< String >	metas (E e)

ID	getIdentifier ()

void	onRenderItem (E e)

boolean	isValid (E e)

ID	parseId (String value)

String	stringId (ID value)

Protected Attributes
HTMLHelper	html

IConstructor	constructor

ElephantMarker	marker

Protected Attributes inherited from org.turro.collections.CollectionIterator< E, ID >
List< E >	items

int	_total = -1

Additional Inherited Members
Static Public Attributes inherited from org.turro.action.content.IContentIterator
static String	PRELOAD_TMPL = "#preload"

Detailed Description

Author: Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 43 of file CollectionHtmlIterator.java.

Constructor & Destructor Documentation

◆ CollectionHtmlIterator() [1/2]

org.turro.collections.CollectionHtmlIterator< E, ID >.CollectionHtmlIterator	(	List	collection,
		ElephantMarker	marker
	)

Definition at line 61 of file CollectionHtmlIterator.java.

                                                                         {
     this(collection, marker, null);
   }

◆ CollectionHtmlIterator() [2/2]

org.turro.collections.CollectionHtmlIterator< E, ID >.CollectionHtmlIterator	(	List	collection,
		ElephantMarker	marker,
		Writer	writer
	)

Definition at line 65 of file CollectionHtmlIterator.java.

                                                                                        {
     super(collection);
     this.marker = marker;
     this.constructor = marker.getConstructor();
     this.writer = writer;
     this.idClass = (Class<ID>) ((ParameterizedType) getClass()
             .getGenericSuperclass()).getActualTypeArguments()[1];
     markerAttributes = new HashMap<>();
   }

Here is the call graph for this function:

Member Function Documentation

◆ addAttribute()

Object org.turro.collections.CollectionHtmlIterator< E, ID >.addAttribute	(	String	key,
		Object	value
	)

Implements org.turro.action.content.IContentIterator.

Definition at line 148 of file CollectionHtmlIterator.java.

                                                        {
     return markerAttributes.put(key, value);
   }

◆ entity()

abstract E org.turro.collections.CollectionHtmlIterator< E, ID >.entity ( ID value )

abstractprotected

◆ forceItem()

void org.turro.collections.CollectionHtmlIterator< E, ID >.forceItem ( ID item )

Definition at line 170 of file CollectionHtmlIterator.java.

                                  {
     this.item = item;
     if(item != null) {
       entity = entity(item);
     }
   }

◆ getFullTemplate()

String org.turro.collections.CollectionHtmlIterator< E, ID >.getFullTemplate ( )

Definition at line 87 of file CollectionHtmlIterator.java.

                                   {
     return Strings.isBlank(fullTemplate) ? "full" : fullTemplate;
   }

Here is the caller graph for this function:

◆ getIdentifier()

ID org.turro.collections.CollectionHtmlIterator< E, ID >.getIdentifier ( )

protected

Definition at line 271 of file CollectionHtmlIterator.java.

                                {
     if(constructor.isHeadless() || forceSummary) {
       return null;
     }
     KeyValueMap kvm = MarkerHelper.getObfuscatedParameters();
     if(kvm != null && !kvm.isEmpty() && kvm.containsKey("item")) {
       return parseId(kvm.get("item"));
     }
     return parseId(constructor.getParameter("item"));
     //return constructor.isHeadless() ? null : (ID) ObjectString.parseString(constructor.getParameter("item"), idClass, false);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMetas()

Collection<String> org.turro.collections.CollectionHtmlIterator< E, ID >.getMetas ( )

Definition at line 181 of file CollectionHtmlIterator.java.

                                        {
     return entity != null ? metas(entity) : null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSummaryTemplate()

String org.turro.collections.CollectionHtmlIterator< E, ID >.getSummaryTemplate ( )

Definition at line 79 of file CollectionHtmlIterator.java.

                                      {
     return Strings.isBlank(summaryTemplate) ? "summary" : summaryTemplate;
   }

Here is the caller graph for this function:

◆ getTitle()

String org.turro.collections.CollectionHtmlIterator< E, ID >.getTitle ( )

Definition at line 177 of file CollectionHtmlIterator.java.

                            {
     return entity != null ? title(entity) : null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWriter()

Writer org.turro.collections.CollectionHtmlIterator< E, ID >.getWriter ( )

Implements org.turro.action.content.IContentIterator.

Definition at line 153 of file CollectionHtmlIterator.java.

                             {
     try {
       return writer != null ? writer : constructor.getOut();
     } catch (IOException ex) {
       Logger.getLogger(CollectionHtmlIterator.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
     return null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEmpty()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isEmpty ( )

Implements org.turro.action.content.IContentIterator.

Definition at line 261 of file CollectionHtmlIterator.java.

                            {
     return getTotalCount() < 1;
   }

Here is the call graph for this function:

◆ isFirst()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isFirst ( )

Definition at line 240 of file CollectionHtmlIterator.java.

                            {
     return currentIndex == 0;
   }

Here is the caller graph for this function:

◆ isForceSummary()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isForceSummary ( )

Definition at line 131 of file CollectionHtmlIterator.java.

                                   {
     return forceSummary;
   }

◆ isItem()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isItem ( )

Definition at line 143 of file CollectionHtmlIterator.java.

                           {
     return entity != null;
   }

Here is the caller graph for this function:

◆ isLast()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isLast ( )

Definition at line 244 of file CollectionHtmlIterator.java.

                           {
     return currentIndex == currentSize - 1;
   }

Here is the caller graph for this function:

◆ isNavigatorBottom()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isNavigatorBottom ( )

Definition at line 99 of file CollectionHtmlIterator.java.

                                      {
     return navigatorBottom;
   }

◆ isNavigatorTop()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isNavigatorTop ( )

Definition at line 91 of file CollectionHtmlIterator.java.

                                   {
     return navigatorTop;
   }

◆ isSearchOption()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isSearchOption ( )

Definition at line 123 of file CollectionHtmlIterator.java.

                                   {
     return searchOption;
   }

◆ isValid()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.isValid ( E e )

protected

Definition at line 285 of file CollectionHtmlIterator.java.

                                  {
     return e != null;
   }

Here is the caller graph for this function:

◆ load()

void org.turro.collections.CollectionHtmlIterator< E, ID >.load ( )

Implements org.turro.action.content.IContentIterator.

Definition at line 163 of file CollectionHtmlIterator.java.

                      {
     item = getIdentifier();
     if(item != null) {
       entity = entity(item);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ metas()

abstract Collection<String> org.turro.collections.CollectionHtmlIterator< E, ID >.metas ( E e )

abstractprotected

Here is the caller graph for this function:

◆ onRenderItem()

void org.turro.collections.CollectionHtmlIterator< E, ID >.onRenderItem ( E e )

protected

Definition at line 283 of file CollectionHtmlIterator.java.

283 {}

◆ parseId()

ID org.turro.collections.CollectionHtmlIterator< E, ID >.parseId ( String value )

protected

Reimplemented in org.turro.alliance.client.ProjectGrantCollectionIterator.

Definition at line 289 of file CollectionHtmlIterator.java.

                                      {
     return (ID) ObjectString.parseString(value, idClass, false);
   }

Here is the caller graph for this function:

◆ render()

void org.turro.collections.CollectionHtmlIterator< E, ID >.render ( )

Implements org.turro.action.content.IContentIterator.

Definition at line 186 of file CollectionHtmlIterator.java.

                        {
     initClauses();
     marker.putAll(markerAttributes);
     marker.put("iterator", this);
     marker.put("navigatorTop", navigatorTop);
     marker.put("navigatorBottom", navigatorBottom);
     marker.put("searchOption", searchOption);
     page = constructor.isHeadless() ? 0 : (Integer) ObjectString.parseString(constructor.getParameter("page"), Integer.class, true);
     if(entity != null) {
       if(isValid(entity)) {
         html = new HTMLHelper(constructor, writer);
         CollectionNavigator navigator = new CollectionNavigator(this);
         marker.put("navigator", navigator);
         marker.put("empty", false);
         marker.put("divider", false);
         marker.put("header", true);
         marker.put("footer", true);
         marker.put("single", true);
         renderItem(marker, entity, page);
         html.endAllTags();
       }
     } else {
       current(page);
       if(items == null) {
         return;
       }
       html = new HTMLHelper(constructor, writer);
       CollectionNavigator navigator = new CollectionNavigator(this);
       marker.put("navigator", navigator);
       currentIndex = 0; 
       currentSize = items.size();
       if(currentSize == 0) {
         marker.put("empty", true);
         marker.put("divider", false);
         marker.put("header", true);
         marker.put("footer", true);
         marker.put("single", false);
         renderSummary(marker, null, current());
       } else {
         marker.put("empty", false);
         marker.put("single", false);
         for(E e : items) {
           if(isValid(e)) {
             marker.put("divider", !isFirst());
             marker.put("header", isFirst());
             marker.put("footer", isLast());
             renderSummary(marker, e, current());
           }
           currentIndex++;
         }
       }
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderItem()

abstract void org.turro.collections.CollectionHtmlIterator< E, ID >.renderItem	(	ElephantMarker	marker,
		E	e,
		int	page
	)

abstractprotected

Here is the caller graph for this function:

◆ renderSearchEngine()

String org.turro.collections.CollectionHtmlIterator< E, ID >.renderSearchEngine ( )

Reimplemented in org.turro.alliance.client.ProjectGrantCollectionIterator.

Definition at line 248 of file CollectionHtmlIterator.java.

                                      {
     return ""; //searchEngine != null ? searchEngine.render(constructor) : "";
   }

◆ renderSummary()

abstract void org.turro.collections.CollectionHtmlIterator< E, ID >.renderSummary	(	ElephantMarker	marker,
		E	e,
		int	page
	)

abstractprotected

Here is the caller graph for this function:

◆ renderTree()

String org.turro.collections.CollectionHtmlIterator< E, ID >.renderTree ( )

Definition at line 252 of file CollectionHtmlIterator.java.

                              {
     return ""; //navigationTree != null ? navigationTree.parse() : "";
   }

◆ renderTreeSelection()

String org.turro.collections.CollectionHtmlIterator< E, ID >.renderTreeSelection ( )

Definition at line 256 of file CollectionHtmlIterator.java.

                                       {
     return ""; //navigationTree != null ? navigationTree.parseSelected() : "";
   }

◆ setForceSummary()

void org.turro.collections.CollectionHtmlIterator< E, ID >.setForceSummary ( boolean forceSummary )

Definition at line 135 of file CollectionHtmlIterator.java.

                                                     {
     this.forceSummary = forceSummary;
   }

◆ setFullTemplate()

void org.turro.collections.CollectionHtmlIterator< E, ID >.setFullTemplate ( String fullTemplate )

Definition at line 83 of file CollectionHtmlIterator.java.

                                                    {
     this.fullTemplate = fullTemplate;
   }

Here is the caller graph for this function:

◆ setNavigatorBottom()

void org.turro.collections.CollectionHtmlIterator< E, ID >.setNavigatorBottom ( boolean navigatorBottom )

Definition at line 103 of file CollectionHtmlIterator.java.

                                                           {
     this.navigatorBottom = navigatorBottom;
   }

Here is the caller graph for this function:

◆ setNavigatorTop()

void org.turro.collections.CollectionHtmlIterator< E, ID >.setNavigatorTop ( boolean navigatorTop )

Definition at line 95 of file CollectionHtmlIterator.java.

                                                     {
     this.navigatorTop = navigatorTop;
   }

Here is the caller graph for this function:

◆ setSearchOption()

void org.turro.collections.CollectionHtmlIterator< E, ID >.setSearchOption ( boolean searchOption )

Definition at line 127 of file CollectionHtmlIterator.java.

                                                     {
     this.searchOption = searchOption;
   }

◆ setSummaryTemplate()

void org.turro.collections.CollectionHtmlIterator< E, ID >.setSummaryTemplate ( String summaryTemplate )

Definition at line 75 of file CollectionHtmlIterator.java.

                                                          {
     this.summaryTemplate = summaryTemplate;
   }

Here is the caller graph for this function:

◆ stringId()

String org.turro.collections.CollectionHtmlIterator< E, ID >.stringId ( ID value )

protected

Definition at line 293 of file CollectionHtmlIterator.java.

                                       {
     return String.valueOf(value);
   }

◆ title()

abstract String org.turro.collections.CollectionHtmlIterator< E, ID >.title ( E e )

abstractprotected

Here is the caller graph for this function:

◆ wantItem()

boolean org.turro.collections.CollectionHtmlIterator< E, ID >.wantItem ( )

Definition at line 139 of file CollectionHtmlIterator.java.

                             {
     return getIdentifier() != null;
   }

Here is the call graph for this function:

Member Data Documentation

◆ constructor

IConstructor org.turro.collections.CollectionHtmlIterator< E, ID >.constructor

protected

Definition at line 46 of file CollectionHtmlIterator.java.

◆ html

HTMLHelper org.turro.collections.CollectionHtmlIterator< E, ID >.html

protected

Definition at line 45 of file CollectionHtmlIterator.java.

◆ marker

ElephantMarker org.turro.collections.CollectionHtmlIterator< E, ID >.marker

protected

Definition at line 47 of file CollectionHtmlIterator.java.

The documentation for this class was generated from the following file:

CollectionHtmlIterator.java

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CollectionHtmlIterator() [1/2]

◆ CollectionHtmlIterator() [2/2]

Member Function Documentation

◆ addAttribute()

◆ entity()

◆ forceItem()

◆ getFullTemplate()

◆ getIdentifier()

◆ getMetas()

◆ getSummaryTemplate()

◆ getTitle()

◆ getWriter()

◆ isEmpty()

◆ isFirst()

◆ isForceSummary()

◆ isItem()

◆ isLast()

◆ isNavigatorBottom()

◆ isNavigatorTop()

◆ isSearchOption()

◆ isValid()

◆ load()

◆ metas()

◆ onRenderItem()

◆ parseId()

◆ render()

◆ renderItem()

◆ renderSearchEngine()

◆ renderSummary()

◆ renderTree()

◆ renderTreeSelection()

◆ setForceSummary()

◆ setFullTemplate()

◆ setNavigatorBottom()

◆ setNavigatorTop()

◆ setSearchOption()

◆ setSummaryTemplate()

◆ stringId()

◆ title()

◆ wantItem()

Member Data Documentation

◆ constructor

◆ html

◆ marker