org.turro.documentation.model.DocumentationContentIterator Class Reference

Inheritance diagram for org.turro.documentation.model.DocumentationContentIterator:

Collaboration diagram for org.turro.documentation.model.DocumentationContentIterator:

Public Member Functions
	DocumentationContentIterator (IConstructor constructor, Writer writer, IContact contact, boolean mail, String pubPath)
Public Member Functions inherited from org.turro.jpa.content.EntityItemContentIterator< E, ID >
	EntityItemContentIterator (List collection, IConstructor constructor, Writer writer, IContact contact, boolean mail, String contextPath)
String	getContextPath ()
IContact	getContact ()
boolean	isAllowInterest ()
void	setAllowInterest (boolean allowInterest)
boolean	isAllowComments ()
void	setAllowComments (boolean allowComments)
boolean	isAllowVotes ()
void	setAllowVotes (boolean allowVotes)
boolean	isAllowDescriptions ()
void	setAllowDescriptions (boolean allowDescriptions)
boolean	isAllowAttachments ()
void	setAllowAttachments (boolean allowAttachments)
boolean	isAllowFiles ()
void	setAllowFiles (boolean allowFiles)
boolean	isAllowPolls ()
void	setAllowPolls (boolean allowPolls)
boolean	isMail ()
Object	getVotesCtrl (E e)
Object	getInterestCtrl (E e)
Object	getCommentsCtrl (E e)
Object	getAttachmentsCtrl (E e)
Object	getFilesCtrl (E e)
Object	getDescriptionsCtrl (E e)
Object	getPollsCtrl (E e)
Public Member Functions inherited from org.turro.collections.CollectionHtmlIterator< E, ID >
	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
void	renderSummary (ElephantMarker marker, EntityDocumentation e, int page)
void	renderItem (ElephantMarker marker, EntityDocumentation e, int page)
EntityDocumentation	entity (EntityDocumentationPK value)
String	title (EntityDocumentation e)
Collection< String >	metas (EntityDocumentation e)
String	getTemplateRoot ()
Object	doVotesCtrl (EntityDocumentation e)
Object	doInterestCtrl (EntityDocumentation e)
Object	doCommentsCtrl (EntityDocumentation e)
Object	doAttachmentsCtrl (EntityDocumentation e)
Object	doFilesCtrl (EntityDocumentation e)
Object	doDescriptionsCtrl (EntityDocumentation e)
Object	doPollsCtrl (EntityDocumentation e)
String	getItemLink (EntityDocumentation e)
String	getReadAllLink ()
String	getRestrictedLink ()
Protected Member Functions inherited from org.turro.jpa.content.EntityItemContentIterator< E, ID >
void	prepareControls (E entity, int page)
abstract Object	doVotesCtrl (E e)
abstract Object	doInterestCtrl (E e)
abstract Object	doCommentsCtrl (E e)
abstract Object	doAttachmentsCtrl (E e)
abstract Object	doFilesCtrl (E e)
abstract Object	doDescriptionsCtrl (E e)
abstract Object	doPollsCtrl (E e)
abstract String	getItemLink (E e)
Protected Member Functions inherited from org.turro.collections.CollectionHtmlIterator< E, ID >
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)

Additional Inherited Members
Static Public Attributes inherited from org.turro.action.content.IContentIterator
static String	PRELOAD_TMPL = "#preload"
Protected Attributes inherited from org.turro.collections.CollectionHtmlIterator< E, ID >
HTMLHelper	html
IConstructor	constructor
ElephantMarker	marker
Protected Attributes inherited from org.turro.collections.CollectionIterator< E, ID >
List< E >	items
int	_total = -1

Detailed Description

Author

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

Definition at line 41 of file DocumentationContentIterator.java.

Constructor & Destructor Documentation

DocumentationContentIterator()

org.turro.documentation.model.DocumentationContentIterator.DocumentationContentIterator	(	IConstructor	constructor,
		Writer	writer,
		IContact	contact,
		boolean	mail,
		String	pubPath
	)

Definition at line 43 of file DocumentationContentIterator.java.

                                                                                                                               {
    super(getPending(contact), constructor, writer, contact, mail, pubPath);
  }

Member Function Documentation

doAttachmentsCtrl()

Object org.turro.documentation.model.DocumentationContentIterator.doAttachmentsCtrl ( EntityDocumentation  e )

protected

Definition at line 110 of file DocumentationContentIterator.java.

                                                            {
    return null;
  }

doCommentsCtrl()

Object org.turro.documentation.model.DocumentationContentIterator.doCommentsCtrl ( EntityDocumentation  e )

protected

Definition at line 105 of file DocumentationContentIterator.java.

                                                         {
    return null;
  }

doDescriptionsCtrl()

Object org.turro.documentation.model.DocumentationContentIterator.doDescriptionsCtrl ( EntityDocumentation  e )

protected

Definition at line 120 of file DocumentationContentIterator.java.

                                                             {
    return null;
  }

doFilesCtrl()

Object org.turro.documentation.model.DocumentationContentIterator.doFilesCtrl ( EntityDocumentation  e )

protected

Definition at line 115 of file DocumentationContentIterator.java.

                                                      {
    return null;
  }

doInterestCtrl()

Object org.turro.documentation.model.DocumentationContentIterator.doInterestCtrl ( EntityDocumentation  e )

protected

Definition at line 100 of file DocumentationContentIterator.java.

                                                         {
    return null;
  }

doPollsCtrl()

Object org.turro.documentation.model.DocumentationContentIterator.doPollsCtrl ( EntityDocumentation  e )

protected

Definition at line 125 of file DocumentationContentIterator.java.

                                                      {
    return null;
  }

doVotesCtrl()

Object org.turro.documentation.model.DocumentationContentIterator.doVotesCtrl ( EntityDocumentation  e )

protected

Definition at line 95 of file DocumentationContentIterator.java.

                                                      {
    return null;
  }

entity()

EntityDocumentation org.turro.documentation.model.DocumentationContentIterator.entity ( EntityDocumentationPK  value )

protected

Definition at line 62 of file DocumentationContentIterator.java.

                                                                    {
    for(EntityDocumentation w : collection) {
      EntityDocumentationPK pk = new EntityDocumentationPK();
      pk.setContactId(w.getContactId());
      pk.setDocumentation(w.getDocumentation());
      pk.setEntityPath(w.getEntityPath());
      if(pk.equals(value)) {
        return w;
      }
    }
    return null;
  }

Here is the call graph for this function:

getItemLink()

String org.turro.documentation.model.DocumentationContentIterator.getItemLink ( EntityDocumentation  e )

protected

Definition at line 130 of file DocumentationContentIterator.java.

                                                      {
    return e.getEntity().getEntityUrl();
  }

Here is the call graph for this function:

getReadAllLink()

String org.turro.documentation.model.DocumentationContentIterator.getReadAllLink ( )

protected

Reimplemented from org.turro.jpa.content.EntityItemContentIterator< E, ID >.

Definition at line 135 of file DocumentationContentIterator.java.

                                    {
    if(Strings.isBlank(getContextPath())) {
      return getRestrictedLink();
    }
    return getContextPath();
  }

Here is the call graph for this function:

getRestrictedLink()

String org.turro.documentation.model.DocumentationContentIterator.getRestrictedLink ( )

protected

Reimplemented from org.turro.jpa.content.EntityItemContentIterator< E, ID >.

Definition at line 143 of file DocumentationContentIterator.java.

                                       {
    return "/user/documentation";
  }

Here is the caller graph for this function:

getTemplateRoot()

String org.turro.documentation.model.DocumentationContentIterator.getTemplateRoot ( )

protected

Reimplemented from org.turro.jpa.content.EntityItemContentIterator< E, ID >.

Definition at line 90 of file DocumentationContentIterator.java.

                                     {
    return isMail() ? "content/newsletter/sections/attachments" : "attachment";
  }

Here is the call graph for this function:

Here is the caller graph for this function:

metas()

Collection<String> org.turro.documentation.model.DocumentationContentIterator.metas ( EntityDocumentation  e )

protected

Definition at line 85 of file DocumentationContentIterator.java.

                                                            {
    return Collections.EMPTY_LIST;
  }

renderItem()

void org.turro.documentation.model.DocumentationContentIterator.renderItem ( ElephantMarker  marker, EntityDocumentation  e, int  page  )

protected

Definition at line 55 of file DocumentationContentIterator.java.

                                                                                    {
    marker.put("documentation", e);
    prepareValues(e, page);
    marker.process(getTemplateRoot(), getFullTemplate(), getWriter());
  }

Here is the call graph for this function:

renderSummary()

void org.turro.documentation.model.DocumentationContentIterator.renderSummary ( ElephantMarker  marker, EntityDocumentation  e, int  page  )

protected

Definition at line 48 of file DocumentationContentIterator.java.

                                                                                       {
    marker.put("documentation", e);
    prepareValues(e, page);
    marker.process(getTemplateRoot(), getSummaryTemplate(), getWriter());
  }

Here is the call graph for this function:

title()

String org.turro.documentation.model.DocumentationContentIterator.title ( EntityDocumentation  e )

protected

Definition at line 80 of file DocumentationContentIterator.java.

                                                {
    return "/**/";
  }

---

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

• DocumentationContentIterator.java