com.jalios.jcms.portlet
Class PortletSkinable

java.lang.Object
  com.jalios.jstore.BasicStorable
      com.jalios.jcms.Data
          com.jalios.jcms.Publication
              com.jalios.jcms.portlet.PortalElement
                  com.jalios.jcms.portlet.Portlet
                      com.jalios.jcms.portlet.PortletSkinable

All Implemented Interfaces:

EditableData, JcmsConstants, ImportConstants, MashupConstants, Searchable, Storable, JaliosConstants, TreeNode, Cloneable, Comparable<BasicStorable>

Direct Known Subclasses:

PortletParent

public abstract class PortletSkinable
extends Portlet

An abstract Portlet représentation with fields to implements - String -> DisplayTitle (ML) - String -> SkinTemplate - String -> SkinCSS

Version:

$Revision: 25362 $

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.portlet.PortalElement

PortalElement.AbilitySelector

Nested classes/interfaces inherited from class com.jalios.jcms.Publication

Publication.AdateComparator<T extends Publication>, Publication.AdateSelector, Publication.AudienceRightComparator<T extends Publication>, Publication.AudienceRightSelector, Publication.AuthorComparator<T extends Publication>, Publication.AuthorizedSelector, Publication.CanWorkOnSelector, Publication.DdateComparator<T extends Publication>, Publication.EdateComparator<T extends Publication>, Publication.EdateSelector, Publication.PdateComparator<T extends Publication>, Publication.PdateSelector, Publication.PstatusComparator<T extends Publication>, Publication.PstatusSelector, Publication.RatingComparator<T extends Publication>, Publication.ReaderComparator<T extends Publication>, Publication.ReadRightSelector, Publication.ReviewCountComparator<T extends Publication>, Publication.RightComparator<T extends Publication>, Publication.SdateComparator<T extends Publication>, Publication.SdateSelector, Publication.TitleComparator<T extends Publication>, Publication.TrackedSelector, Publication.TypeComparator<T extends Publication>, Publication.UdateComparator<T extends Publication>, Publication.UdateSelector, Publication.UserContentSelector, Publication.VisibleStateSelector, Publication.WorkspaceAuthorSelector, Publication.WorkspaceComparator<T extends Publication>, Publication.WorkspaceSelector

Nested classes/interfaces inherited from class com.jalios.jcms.Data

Data.AuthorSelector, Data.CdateSelector, Data.DataNameComparator<T extends Data>, Data.DeletableSelector, Data.ImportSelector, Data.MdateSelector, Data.OpAuthorComparator<T extends Data>

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable

BasicStorable.CdateComparator<T extends Storable>, BasicStorable.IdComparator<T extends Storable>, BasicStorable.MdateComparator<T extends Storable>

Field Summary

static org.apache.oro.text.regex.Pattern	PATTERN_CURRENT_CATEGORY
static org.apache.oro.text.regex.Pattern	PATTERN_CURRENT_CATEGORY_DESCRIPTION
static org.apache.oro.text.regex.Pattern	PATTERN_PORTAL_CATEGORY
static org.apache.oro.text.regex.Pattern	PATTERN_PORTAL_CATEGORY_DESCRIPTION
static String	REVISION

Fields inherited from class com.jalios.jcms.portlet.PortalElement

abilities, allAbilities, allAbilityMap, cachedAbilities, ICON_PORTLET, ICON_STATS, tteDefault

Fields inherited from class com.jalios.jcms.Publication

adate, authorizedGroupSet, authorizedMemberSet, categories, categorySet, CTRL_TOPIC_ADVANCED, CTRL_TOPIC_CATEGORIES, CTRL_TOPIC_WORKFLOW, edate, friendlyURLSet, indexMgr, isTracked, mainInstance, mainLanguage, majorVersion, mergeDate, mergeId, minorVersion, pdate, pstatus, roleMap, sdate, templates, title, titleML, udate, updateGroupSet, updateMemberSet, wfExpressAlarmEntry, wfReminderAlarmEntry, workspace

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, lockDate, lockMember, opAuthor, opDelegate

Fields inherited from class com.jalios.jstore.BasicStorable

cdate, ddate, id, mdate, store

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants

IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROP

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

PortletSkinable()

PortletSkinable(PortletSkinable other)

Method Summary

Map	getAvailableCssSkin()
String	getContentTitle(String lang)
String	getDataName(String language) Return the name of this Data, every sub class Data which will be displayed to user should implements this method already.
abstract String	getDisplayTitle(String lang)
abstract String	getDisplayTitle(String lang, boolean b)
abstract HashMap<String,String>	getDisplayTitleML()
abstract String	getExpandState()
abstract String	getPopupState()
String	getSkin(String usage) Returns the template skin name for the given usage
abstract String	getSkinCSS()
abstract String[]	getSkins()
TypeTemplateEntry	getSkinTemplateEntry(String usage, boolean devModeChecks) Returns the TypeTemplateEntry Skin matching the given parameters.
static TypeTemplateEntry	getSkinTemplateEntry(String usage, boolean devModeChecks, Class<? extends Publication> clazz, Workspace ws) Returns the TypeTemplateEntry matching the given parameters.
String	getSkinTitle(String userLang, Category current, Category portal)
abstract void	setDisplayTitle(String s)
abstract void	setDisplayTitleML(HashMap<String,String> s)
abstract void	setExpandState(String v)
abstract void	setPopupState(String v)
void	setSkin(String name)
abstract void	setSkinCSS(String s)
abstract void	setSkins(String[] s)

Methods inherited from class com.jalios.jcms.portlet.Portlet

getAlignH, getAlignTable, getAlignV, getAvailableCssDisplay, getBackColor, getBackImage, getBorder, getBorderColor, getCellPadding, getCondition, getDisplayCSS, getInsetBottom, getInsetLeft, getInsetRight, getInsetTop, getWidth, setAlignH, setAlignTable, setAlignV, setBackColor, setBackImage, setBorder, setBorderColor, setCellPadding, setCondition, setDisplayCSS, setInsetBottom, setInsetLeft, setInsetRight, setInsetTop, setWidth

Methods inherited from class com.jalios.jcms.portlet.PortalElement

containsTreeDescendant, duplicate, duplicate, duplicate, duplicate, duplicate, duplicateDeep, duplicateDeep, getAbilities, getAbilities, getAbilities, getAbilityLabel, getAbilitySelector, getAbstract, getAbstract, getAllAbilities, getAllAbilities, getAllAbilityMap, getAllTreeChildren, getBehaviorCopy, getCacheSensibility, getCacheType, getCacheTypeInt, getCssClasses, getCssId, getDefaultTemplateUsage, getDescription, getDescription, getDescriptionML, getIcon, getInvalidClass, getInvalidTime, getPortletImage, getPortletImage, getPortletImageML, getPreview, getResolvedInvalidClass, getSkinPath, getSkinPath, getTreeChildren, getTreeParent, getTreeParent, hasAbility, hasAbility, hasCacheGroups, hasCacheMembers, hasCacheServer, hasCacheSession, hasCacheSessionAndVisitors, hasCacheVisitorsOnly, hasCurrentCategoryCacheSensibility, hasNoCache, hasNoCacheSensibility, hasPortalCategoryCacheSensibility, isChildTreeNode, isCopy, isReference, isTreeLeaf, isTreeNode, isWorkspaceReference, performUpdate, setAbilities, setBehaviorCopy, setCacheSensibility, setCacheType, setCssClasses, setCssId, setDescription, setDescriptionML, setInvalidClass, setInvalidTime, setPortletImage, setPortletImageML

Methods inherited from class com.jalios.jcms.Publication

addAuthorizedGroup, addAuthorizedMember, addCategory, addWeakReferrer, addWFExpressAlarm, addWFReminderAlarm, assignCommonPublicationFields, assignRole, assignRole, canBeArchived, canBeArchived, canBeEditedFieldByField, canBeReadBy, canBeReadBy, canBeReadBy, canCreateCopy, canCreateCopy, canCreateWorkCopy, canMergeWorkCopy, checkCreate, checkDelete, checkIntegrity, checkLang, checkMember, checkMerge, checkStateChange, checkStateChange, checkTemplateEntry, checkUpdate, checkWrite, clearTransientIndex, computeSignature, containsCategory, createCopy, createWFNote, createWFNote, createWorkCopy, exportXmlField, getAbstract, getAbstractML, getAccessCount, getAdate, getAdateComparator, getAdateSelector, getAllFilePath, getAllWikiText, getAllWysiwygText, getAudiencedRightsString, getAudienceRightComparator, getAudienceRightSelector, getAuthorizedGroupSet, getAuthorizedMemberSet, getAuthorizedSelector, getCanWorkOnSelector, getCategories, getCategories, getCategorySet, getComparator, getComparator, getComparator, getCSVHeader, getDate, getDate, getDateSelector, getDdateComparator, getDescendantCategorySet, getDescendantCategorySet, getDescendantCategorySet, getDisplayTemplateFile, getDocumentLinkSet, getEdate, getEdateComparator, getEdateSelector, getEstimatedReminderCount, getExternalLinkSet, getFieldInMainLanguage, getFieldValue, getFirstDescendantCategory, getFirstDescendantCategory, getFirstDescendantCategory, getFriendlyURLSet, getGlobalRating, getImportConflictCopy, getImportVersion, getIndexingDate, getLinkDataSet, getMainInstance, getMainLanguage, getMajorVersion, getMemberSetAssignedToRole, getMergeDate, getMergeId, getMinorVersion, getNextWFStateSet, getPdate, getPdateComparator, getPdateSelector, getPstatus, getPstatusAlarmEntry, getPstatusComparator, getPstatusSelector, getPstatusSelector, getQueryTemplateFile, getRatingComparator, getReaderComparator, getReaderCount, getReaderTrackerList, getReadRightSelector, getReadRightsString, getReview, getReviewCount, getReviewCountComparator, getReviewList, getReviewList, getRightComparator, getRoleMap, getSdate, getSdateComparator, getSdateSelector, getSearchStrings, getTemplate, getTemplateEntry, getTemplateEntry, getTemplateEntrySet, getTemplatePath, getTemplatePath, getTemplates, getTitle, getTitle, getTitle, getTitleComparator, getTitleComparator, getTitleML, getTrackedSelector, getTreeRoot, getTypeComparator, getTypeLabel, getUdate, getUdateComparator, getUdateSelector, getUpdateGroupSet, getUpdateMemberSet, getVersionString, getVisibleStateSelector, getWeakReferrerSet, getWFNoteList, getWFState, getWFStateLabel, getWorkCopySet, getWorkflow, getWorkspace, getWorkspaceAuthorSelector, getWorkspaceComparator, getWorkspaceId, getWorkspaceSelector, getWSTypeEntry, getWSTypeEntry, hasAlreadyVoted, hasAnyReadRights, hasBeenReadBy, hasCategory, hasImportConflict, hasNoReadRights, hasReview, hasWeakReferrers, importConvertToLocal, importMarkAsMerged, importOverrideAndUpdate, importXml, init, initCopy, isAudienced, isDefaultTemplate, isImportConflictCopy, isInRole, isInVisibleState, isPublic, isRoleAssigned, isTracked, isUserContent, isUserContentType, isWorkCopy, majorUpdate, performCreate, performDelete, performMerge, performMerge, prepareMergeCopy, putPstatusAlarmEntry, removeAllDescendants, removeAllReaderTracker, removeAuthorizedGroup, removeAuthorizedMember, removeCategory, removeDataSet, removeImportMetadata, removePstatusAlarmEntry, removeWeakReferrer, removeWFExpressAlarm, removeWFReminderAlarm, resolveTypeTemplateEntry, setAdate, setAuthorizedGroupSet, setAuthorizedMemberSet, setCategories, setCategorySet, setCdate, setEdate, setFriendlyURLSet, setImportConflictCopy, setImportVersion, setMainInstance, setMainLanguage, setMajorVersion, setMergeDate, setMergeId, setPdate, setPstatus, setRoleMap, setRoleMemberSetMap, setSdate, setTemplate, setTemplates, setTitle, setTitle, setTitleML, setTracked, setUdate, setUpdateGroupSet, setUpdateMemberSet, setWorkspace, setWorkspaceId, toCSV, toFullString, toString, trackReader, unassignMember, unassignRole, updatePstatus, updateTemplate

Methods inherited from class com.jalios.jcms.Data

checkCreate, checkDelete, checkIntegrity, checkLock, checkUpdate, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataImage, getDataImage, getDataImage, getDataNameComparator, getDeletableSelector, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getRowId, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, hashCode, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, lock, markNewImport, mergeHybridLink, performAfterWrite, performBeforeWrite, performCreate, performDelete, performUpdate, prepareUpdateContext, prepareUpdateContext, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraInfo, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setMdate, setOpAuthor, setOpDelegate, setRowId, unlock, unlock, unmarkNewImport, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSet

Methods inherited from class com.jalios.jstore.BasicStorable

clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, isStored, resolveAtt, resolveVal, setAttributes, setDdate, setId, setStore, toXml

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jalios.util.TreeNode

getTreeRoot

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

PATTERN_CURRENT_CATEGORY

public static final org.apache.oro.text.regex.Pattern PATTERN_CURRENT_CATEGORY

PATTERN_CURRENT_CATEGORY_DESCRIPTION

public static final org.apache.oro.text.regex.Pattern PATTERN_CURRENT_CATEGORY_DESCRIPTION

PATTERN_PORTAL_CATEGORY

public static final org.apache.oro.text.regex.Pattern PATTERN_PORTAL_CATEGORY

PATTERN_PORTAL_CATEGORY_DESCRIPTION

public static final org.apache.oro.text.regex.Pattern PATTERN_PORTAL_CATEGORY_DESCRIPTION

Constructor Detail

PortletSkinable

public PortletSkinable()

PortletSkinable

public PortletSkinable(PortletSkinable other)

Method Detail

getSkinTitle

public String getSkinTitle(String userLang,
                           Category current,
                           Category portal)

getSkin

public String getSkin(String usage)

Returns the template skin name for the given usage

Parameters:

usage - the template usage

Returns:

String the name of the template used

getSkinTemplateEntry

public TypeTemplateEntry getSkinTemplateEntry(String usage,
                                              boolean devModeChecks)

Returns the TypeTemplateEntry Skin matching the given parameters. It returns a default template if the given one does work.

Overrides:

getSkinTemplateEntry in class PortalElement

Parameters:

usage - the template usage

devModeChecks - perform developement checks on template

Returns:

TypeTemplateEntry the matching templates

getSkinTemplateEntry

public static TypeTemplateEntry getSkinTemplateEntry(String usage,
                                                     boolean devModeChecks,
                                                     Class<? extends Publication> clazz,
                                                     Workspace ws)

Returns the TypeTemplateEntry matching the given parameters. It returns a default template if the given one does work.

Parameters:

usage - the template usage

devModeChecks - perform developement checks on template

clazz - the template publication class

ws - the workspace where to create the publication

Returns:

TypeTemplateEntry the matching templates

setSkin

public void setSkin(String name)

getDisplayTitleML

public abstract HashMap<String,String> getDisplayTitleML()

getDisplayTitle

public abstract String getDisplayTitle(String lang)

getDisplayTitle

public abstract String getDisplayTitle(String lang,
                                       boolean b)

setDisplayTitle

public abstract void setDisplayTitle(String s)

setDisplayTitleML

public abstract void setDisplayTitleML(HashMap<String,String> s)

getContentTitle

public String getContentTitle(String lang)

Overrides:

getContentTitle in class PortalElement

getDataName

public String getDataName(String language)

Description copied from class: Data

Return the name of this Data, every sub class Data which will be displayed to user should implements this method already.

• The Title (multi-language) for a Publication.
• The Name (multi-language) for a Category.
• The Name for a Group, a Member.
  
• The Title (multi-language) for a Workspace.

Can be seen as a smart multi-language toString(), but never returning null.
Default behaviour is to return toFullString() of Data or empty string if toFullString is null.

Overrides:

getDataName in class Publication

Parameters:

language - the language in which to return the name if multilang available for the data.

Returns:

title of Publication in given language or empty String if not specified.

See Also:

Publication.getTitle(String), Data.getDataName(String)

getSkins

public abstract String[] getSkins()

setSkins

public abstract void setSkins(String[] s)

getSkinCSS

public abstract String getSkinCSS()

setSkinCSS

public abstract void setSkinCSS(String s)

getAvailableCssSkin

public Map getAvailableCssSkin()

getPopupState

public abstract String getPopupState()

setPopupState

public abstract void setPopupState(String v)

getExpandState

public abstract String getExpandState()

setExpandState

public abstract void setExpandState(String v)