com.jalios.jcms.shortcut

Class AbstractShortcut

java.lang.Object

com.jalios.jstore.BasicStorable

com.jalios.jcms.Data

com.jalios.jcms.Publication

com.jalios.jcms.Content

com.jalios.jcms.shortcut.AbstractShortcut

All Implemented Interfaces:

EditableData, JcmsConstants, ImportConstants, MashupConstants, StrongLockable, Searchable, Storable, JaliosConstants, LangPropertyArgument, TreeNode, java.lang.Cloneable, java.lang.Comparable<BasicStorable>

public abstract class AbstractShortcut
extends Content

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractShortcut.TYPE The type of shortcut.

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.PopularityComparator<T extends Publication>, Publication.PstatusComparator<T extends Publication>, Publication.PstatusSelector, Publication.ReaderComparator<T extends Publication>, Publication.ReadRightSelector, Publication.RelatedCategoryComparator<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.VoteScoreComparator<T extends Publication>, 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>, Data.RowIdComparator<T extends Data>, Data.StrongLockSelector

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

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_IMAGE
static java.lang.String	FIELD_CLASSIFICATION
static java.lang.String	FIELD_ICON
static java.lang.String	FIELD_IMAGE
static java.lang.String	FIELD_LINK
static java.lang.String	FIELD_OPENMODE
static java.lang.String	FIELD_PARAMETERS
static java.lang.String	FIELD_PUB
static java.lang.String	FIELD_SHOW_IN_TOOLS
static java.lang.String	FIELD_TEXT
static java.lang.String	FIELD_TITLE
static java.lang.String	OPENMODE_DEFAULT
static java.lang.String	OPENMODE_MODAL
static java.lang.String	OPENMODE_NEWPAGE
static java.lang.String	OPENMODE_PORTAL
static java.lang.String	REVISION
static java.lang.String	TYPE_EXTERNAL
static java.lang.String	TYPE_PUBLICATION

Fields inherited from class com.jalios.jcms.Publication

adate, allCatIdSet, attachWorkspaceSet, attachWSIdSet, attachWSIdSetDirty, attachWSIdSetInit, authGrpIdSet, authGrpIdSetDirty, authGrpIdSetInit, authMbrIdSet, authMbrIdSetDirty, authMbrIdSetInit, authorizedGroupSet, authorizedMemberSet, authorizedMemberSetDBID, categories, categorySet, catIdSet, catIdSetDirty, catIdSetInit, CTRL_TOPIC_ADVANCED, CTRL_TOPIC_CATEGORIES, CTRL_TOPIC_WORKFLOW, CTX_PSTATUS_UPDATE, dbFriendlyURLSet, dbFriendlyURLSetDirty, dbFriendlyURLSetInit, edate, friendlyURLSet, hasAttachWS, hasNoReadRightsDBData, indexMgr, isTracked, mainInstance, mainInstanceId, mainLanguage, majorVersion, mergeDate, mergeId, minorVersion, pdate, pstatus, PUBLICATION_WFNOTE, readerCount, roleMap, sdate, templates, title, titleML, udate, updateGroupSet, updateGrpIdSet, updateGrpIdSetDirty, updateGrpIdSetInit, updateMbrIdSet, updateMbrIdSetDirty, updateMbrIdSetInit, updateMemberSet, voteCount, voteScore, weakDataImage, wfExpressAlarmEntry, wfReminderAlarmEntry, workflowId, workspace

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, 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, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, 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, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, 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

Constructors

Constructor and Description
AbstractShortcut()
AbstractShortcut(AbstractShortcut other)

Method Summary

Modifier and Type	Method and Description
boolean	canBeReadBy(Group group, RightInfo rightInfo)
ControllerStatus	checkIntegrity() Prevents the shortcut to reference itself as a Publication.
java.lang.String	getAsyncShortcutInfoUrl() Returns an url which is used to asynchronously query the shortcut badge for topbar application menu items (When the menu is opened)
java.lang.String	getDisplayLink(java.util.Locale locale, java.lang.String baseURL, java.lang.String params, java.lang.String anchor, java.lang.String title, java.lang.String accessibilityInfo, java.lang.String css, java.lang.String htmlAttributes) Retrieve an HTML a tag suitable to display this Data
abstract java.lang.String	getIcon(java.lang.String lang)
abstract java.lang.String	getImage(java.lang.String lang)
abstract java.lang.String	getLink(java.lang.String lang)
abstract java.lang.String	getOpenMode()
abstract Publication	getPub()
ShortcutInfo	getShortcutInfo(Member mbr)
abstract boolean	getShowInToolsPage()
AbstractShortcut.TYPE	getType()
java.lang.String	getUrl(java.util.Locale locale)
protected boolean	internalCanBeReadBy(Member member, boolean searchInGroups, RightInfo rightInfo) If shortcut targets a Publication, Member can read shortcut only if he can read the publication.
boolean	isExternalShortcut()
boolean	isOpenModal()
boolean	isOpenNewPage()
boolean	isPublicationShortcut()
void	printDisplayLinkStart(java.lang.StringBuilder sb, java.util.Locale locale, java.lang.String baseURL, java.lang.String params, java.lang.String anchor, java.lang.String title, java.lang.String accessibilityInfo, java.lang.String css, java.lang.String htmlAttributes, javax.servlet.http.HttpServletRequest request, boolean update, java.lang.String[] paramNames, java.lang.String[] paramValues, java.lang.String[] paramRemove) Print opening tag <a...
abstract void	setIcon(java.lang.String v)
abstract void	setImage(java.lang.String v)
abstract void	setLink(java.lang.String v)
abstract void	setOpenMode(java.lang.String v)
abstract void	setPub(Publication v)

Methods inherited from class com.jalios.jcms.Publication

addAuthorizedGroup, addAuthorizedMember, addCategory, addFollower, addWeakReferrer, addWFExpressAlarm, addWFReminderAlarm, assignCommonPublicationFields, assignRole, assignRole, attachPublication, attachTo, canBeArchived, canBeArchived, canBeAttachedBy, canBeAttachedTo, canBeDetachedFrom, canBeEditedFieldByField, canBeFollowedBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeVotedBy, canCreateCopy, canCreateCopy, canCreateWorkCopy, canMergeWorkCopy, canRequestUnlock, checkCreate, checkDelete, checkLang, checkMember, checkMerge, checkStateChange, checkStateChange, checkTemplateEntry, checkUpdate, checkWrite, cleanHybridCollections, clearTransientIndex, cloneDBDataCollections, computeSignature, computeSignature, containsCategory, createCopy, createWFNote, createWFNote, createWorkCopy, detachFrom, discardCopy, exportXmlField, getAbstract, getAbstract, getAbstract, getAbstractAsText, getAbstractML, getAccessCount, getAdate, getAdateComparator, getAdateSelector, getAllCatIdSet, getAllFilePath, getAllWikiText, getAllWysiwygText, getAttachWorkspaceSet, getAttachWSIdSet, getAudiencedRightsString, getAudienceRightComparator, getAudienceRightSelector, getAuthGrpIdSet, getAuthMbrIdSet, getAuthorizedGroupSet, getAuthorizedMemberSet, getAuthorizedMemberSet, getAuthorizedMemberSetDBID, getAuthorizedSelector, getCanWorkOnSelector, getCategories, getCategories, getCategorySet, getCatIdSet, getComparator, getComparator, getComparator, getCSVHeader, getDataIcon, getDataIconTitle, getDataImage, getDataName, getDate, getDate, getDateSelector, getDBDataRevision, getDbFriendlyURLSet, getDdateComparator, getDefaultTemplateUsage, getDescendantCategorySet, getDescendantCategorySet, getDescendantCategorySet, getDisplayTemplateFile, getDocumentLinkSet, getEdate, getEdateComparator, getEdateSelector, getEstimatedReminderCount, getExternalLinkSet, getFieldInMainLanguage, getFieldValue, getFirstDescendantCategory, getFirstDescendantCategory, getFirstDescendantCategory, getFollowerList, getFriendlyURLSet, getHasAttachWS, getHasNoReadRights, getImportConflictCopy, getImportVersion, getIndexingDate, getInternalWorkflow, getLinkDataSet, getMainInstance, getMainInstanceId, getMainLanguage, getMajorVersion, getMemberSetAssignedToRole, getMergeDate, getMergeId, getMinorVersion, getNextWFStateSet, getPdate, getPdateComparator, getPdateSelector, getPopularity, getPopularityComparator, getPstatus, getPstatusAlarmEntry, getPstatusComparator, getPstatusSelector, getPstatusSelector, getQueryTemplateFile, getReaderComparator, getReaderCount, getReaderTrackerList, getReadRightSelector, getReadRightsString, getRightComparator, getRoleMap, getRoleMapStr, getSdate, getSdateComparator, getSdateSelector, getSearchStrings, getTemplate, getTemplateEntry, getTemplateEntry, getTemplateEntrySet, getTemplatePath, getTemplatePath, getTemplates, getTitle, getTitle, getTitle, getTitleComparator, getTitleComparator, getTitleML, getTitleMLE, getTrackedSelector, getTreeChildren, getTreeParent, getTreeRoot, getTypeComparator, getTypeFieldLabel, getTypeLabel, getUdate, getUdateComparator, getUdateSelector, getUpdateGroupSet, getUpdateGrpIdSet, getUpdateMbrIdSet, getUpdateMemberSet, getVersionString, getVisibleStateSelector, getVoteCount, getVoteScore, getVoteScoreComparator, getVoteValue, getWeakReferrerSet, getWFNoteList, getWFState, getWFStateLabel, getWFStateLabelHtml, getWorkCopySet, getWorkflow, getWorkflowId, getWorkspace, getWorkspaceAuthorSelector, getWorkspaceComparator, getWorkspaceId, getWorkspaceSelector, getWSTypeEntry, getWSTypeEntry, hasAlreadyVoted, hasAnyReadRights, hasBeenReadBy, hasCategory, hasImportConflict, hasNoReadRights, hasWeakReferrers, importConvertToLocal, importMarkAsMerged, importOverrideAndUpdate, importXml, init, initCopy, initializeDBDataCollections, invalidateWeakDataImage, isAudienced, isDefaultTemplate, isFollowedBy, isImportConflictCopy, isInRole, isInVisibleState, isPublic, isRoleAssigned, isTracked, isTreeLeaf, isTreeNode, isUserContent, isUserContentType, isVersioned, isVotable, isWorkCopy, majorUpdate, notifyFollowers, performAfterWrite, performBeforeWrite, performCreate, performDelete, performMerge, performMerge, performUpdate, prepareMergeCopy, putPstatusAlarmEntry, recomputeScore, removeAllDescendants, removeAllFollowers, removeAllReaderTracker, removeAuthorizedGroup, removeAuthorizedMember, removeCategory, removeDataSet, removeFollower, removeImportMetadata, removePstatusAlarmEntry, removeWeakReferrer, removeWFExpressAlarm, removeWFReminderAlarm, resolveTypeTemplateEntry, setAbstract, setAbstract, setAdate, setAllCatIdSet, setAttachWorkspaceSet, setAttachWSIdSet, setAuthGrpIdSet, setAuthMbrIdSet, setAuthorizedGroupSet, setAuthorizedMemberSet, setAuthorizedMemberSetDBID, setCategories, setCategorySet, setCatIdSet, setCdate, setDbFriendlyURLSet, setEdate, setFieldValue, setFriendlyURLSet, setHasAttachWS, setHasNoReadRights, setImportConflictCopy, setImportVersion, setMainInstance, setMainInstanceId, setMainLanguage, setMajorVersion, setMergeDate, setMergeId, setMinorVersion, setPdate, setPstatus, setReaderCount, setRoleMap, setRoleMapStr, setRoleMemberSetMap, setSdate, setTemplate, setTemplates, setTitle, setTitle, setTitleML, setTitleMLE, setTracked, setUdate, setUpdateGroupSet, setUpdateGrpIdSet, setUpdateMbrIdSet, setUpdateMemberSet, setVoteCount, setVoteScore, setWorkflow, setWorkflowId, setWorkspace, setWorkspaceId, splitHybridCollections, toCSV, toFullString, toString, trackReader, trackReader, unassignMember, unassignRole, updatePstatus, updateTemplate

Methods inherited from class com.jalios.jcms.Data

canBeReadBy, canBeUnlockedBy, checkAndPerformCreate, checkAndPerformCreate, checkAndPerformDelete, checkAndPerformDelete, checkAndPerformUpdate, checkAndPerformUpdate, checkCreate, checkDelete, checkIntegrity, checkLockMember, checkStrongLockMember, checkStrongLockMember, checkUpdate, cleanHybridCollection, cleanHybridCollection, cleanHybridCollection, clone, computeDBIDArray, computeDBIDList, computeDBIDSet, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataIconAlt, getDataIconCSS, getDataIconHtml, getDataIconHtml, getDataImage, getDataImage, getDataNameComparator, getDeletableSelector, getDisplayLink, getDisplayLink, 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, getLangPropertyValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockInfo, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getReadAuthorizedSelector, getReferrerSet, getRowId, getRowIdComparator, getStrongLock, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, getVirtualIDSet, hashCode, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, mergeHybridLink, performCreate, performDelete, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayUrl, printDisplayUrl, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setId, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, 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, setAttributes, setDdate, setStore, toXml

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jalios.util.TreeNode

getId

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

DEFAULT_IMAGE

public static final java.lang.String DEFAULT_IMAGE

See Also:

Constant Field Values

FIELD_TITLE

public static final java.lang.String FIELD_TITLE

See Also:

Constant Field Values

FIELD_IMAGE

public static final java.lang.String FIELD_IMAGE

See Also:

Constant Field Values

FIELD_ICON

public static final java.lang.String FIELD_ICON

See Also:

Constant Field Values

FIELD_TEXT

public static final java.lang.String FIELD_TEXT

See Also:

Constant Field Values

FIELD_LINK

public static final java.lang.String FIELD_LINK

See Also:

Constant Field Values

FIELD_CLASSIFICATION

public static final java.lang.String FIELD_CLASSIFICATION

See Also:

Constant Field Values

FIELD_PUB

public static final java.lang.String FIELD_PUB

See Also:

Constant Field Values

FIELD_PARAMETERS

public static final java.lang.String FIELD_PARAMETERS

See Also:

Constant Field Values

FIELD_OPENMODE

public static final java.lang.String FIELD_OPENMODE

See Also:

Constant Field Values

FIELD_SHOW_IN_TOOLS

public static final java.lang.String FIELD_SHOW_IN_TOOLS

See Also:

Constant Field Values

TYPE_PUBLICATION

public static final java.lang.String TYPE_PUBLICATION

See Also:

Constant Field Values

TYPE_EXTERNAL

public static final java.lang.String TYPE_EXTERNAL

See Also:

Constant Field Values

OPENMODE_DEFAULT

public static final java.lang.String OPENMODE_DEFAULT

Since:

jcms-10.0.1

See Also:

Constant Field Values

OPENMODE_PORTAL

public static final java.lang.String OPENMODE_PORTAL

Since:

jcms-10.0.1

See Also:

Constant Field Values

OPENMODE_MODAL

public static final java.lang.String OPENMODE_MODAL

Since:

jcms-10.0.1

See Also:

Constant Field Values

OPENMODE_NEWPAGE

public static final java.lang.String OPENMODE_NEWPAGE

Since:

jcms-10.0.1

See Also:

Constant Field Values

Constructor Detail

AbstractShortcut

public AbstractShortcut()

AbstractShortcut

public AbstractShortcut(AbstractShortcut other)

Method Detail

getShowInToolsPage

public abstract boolean getShowInToolsPage()

getPub

public abstract Publication getPub()

setPub

public abstract void setPub(Publication v)

getLink

public abstract java.lang.String getLink(java.lang.String lang)

setLink

public abstract void setLink(java.lang.String v)

getIcon

public abstract java.lang.String getIcon(java.lang.String lang)

setIcon

public abstract void setIcon(java.lang.String v)

getImage

public abstract java.lang.String getImage(java.lang.String lang)

setImage

public abstract void setImage(java.lang.String v)

getOpenMode

public abstract java.lang.String getOpenMode()

setOpenMode

public abstract void setOpenMode(java.lang.String v)

checkIntegrity

public ControllerStatus checkIntegrity()

Prevents the shortcut to reference itself as a Publication.

Overrides:

checkIntegrity in class Publication

Returns:

a ControllerStatus

See Also:

Publication.checkIntegrity()

internalCanBeReadBy

protected boolean internalCanBeReadBy(Member member,
                                      boolean searchInGroups,
                                      RightInfo rightInfo)

If shortcut targets a Publication, Member can read shortcut only if he can read the publication.

Overrides:

internalCanBeReadBy in class Publication

See Also:

Publication.internalCanBeReadBy(com.jalios.jcms.Member, boolean, com.jalios.jcms.RightInfo)

canBeReadBy

public boolean canBeReadBy(Group group,
                           RightInfo rightInfo)

Overrides:

canBeReadBy in class Publication

See Also:

Publication.canBeReadBy(com.jalios.jcms.Group, com.jalios.jcms.RightInfo)

getType

public AbstractShortcut.TYPE getType()

isExternalShortcut

public boolean isExternalShortcut()

isPublicationShortcut

public boolean isPublicationShortcut()

getUrl

public java.lang.String getUrl(java.util.Locale locale)

Parameters:

locale - the user locale

Returns:

the URL to use for this tool weither it is an external link or a publication link.

getShortcutInfo

public ShortcutInfo getShortcutInfo(Member mbr)

Parameters:

mbr - the Member

Returns:

a ShortcutInfo for current Shortcut and given Member

getAsyncShortcutInfoUrl

public java.lang.String getAsyncShortcutInfoUrl()

Returns an url which is used to asynchronously query the shortcut badge for topbar application menu items (When the menu is opened)

Returns:

an url

getDisplayLink

public java.lang.String getDisplayLink(java.util.Locale locale,
                                       java.lang.String baseURL,
                                       java.lang.String params,
                                       java.lang.String anchor,
                                       java.lang.String title,
                                       java.lang.String accessibilityInfo,
                                       java.lang.String css,
                                       java.lang.String htmlAttributes)

Description copied from class: Data

Retrieve an HTML a tag suitable to display this Data

Overrides:

getDisplayLink in class Data

Parameters:

locale - the current Locale to use for I18N of the URL and other title information

baseURL - optionnal baseURL to use in the URL

params - optionnal additionnal params to in the URL (eg foo=bar&zig=42)

anchor - optionnal anchor to print in the URL (eg #foobar

title - the value to use in the title attribute (highly recommended, do not encode)

accessibilityInfo - a string indicating where to print accessibility information of FileDocument : "title" to print them in title attribute, "content" to print them in the body of the a tag, anything else will not print additionnal accessibility information

css - optionnal classname to use in the tag

htmlAttributes - optionnal additionnal html attributes to use in the tag (must no be href, title and class)

Returns:

an HTML fragment

Since:

jcms-10.0.1

See Also:

Data.getDisplayLink(java.util.Locale, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

printDisplayLinkStart

public void printDisplayLinkStart(java.lang.StringBuilder sb,
                                  java.util.Locale locale,
                                  java.lang.String baseURL,
                                  java.lang.String params,
                                  java.lang.String anchor,
                                  java.lang.String title,
                                  java.lang.String accessibilityInfo,
                                  java.lang.String css,
                                  java.lang.String htmlAttributes,
                                  javax.servlet.http.HttpServletRequest request,
                                  boolean update,
                                  java.lang.String[] paramNames,
                                  java.lang.String[] paramValues,
                                  java.lang.String[] paramRemove)

Description copied from class: Data

Print opening tag <a... href attribute with URL and other attributes.

Overrides:

printDisplayLinkStart in class Data

Parameters:

sb - the StringBuilder in which start of a tag will be appended

locale - the user Locale

baseURL - optionnal baseURL to use in the URL

params - optionnal additionnal params to in the URL (eg foo=bar&zig=42)

anchor - optionnal anchor to print in the URL (eg #foobar

title - the value to use in the title attribute (highly recommended, do not encode)

accessibilityInfo - a string indicating where to print accessibility information of FileDocument : "title" to print them in title attribute, anything else will not print additionnal accessibility information

css - optionnal classname to use in the tag

htmlAttributes - optionnal additionnal html attributes to use in the tag (must no be href, title and class)

request - the HttpRequest. Requested if update or paramNames is provided.

update - specify this parameter to true to generate a display URL for the given data while keeping all the current others parameters.

paramNames - Optionnal request parameters names to be updated from the current request parameters. You must specify the 'values' attributes with an array of the same dimension. Trigger the same url generation behavior as when specifying the 'update' attribute to true.

paramValues - Request parameters values to be updated from the current request parameters. This array must match the correponding names array specified in the 'names' attribute. Trigger the same url generation behavior as when specifying the 'update' attribute to true.

paramRemove - Request parameters names to be removed from the current request parameters. Trigger the same url generation behavior as when specifying the 'update' attribute to true.

Since:

jcms-10.0.1

See Also:

Data.printDisplayLinkStart(java.lang.StringBuilder, java.util.Locale, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest, boolean, java.lang.String[], java.lang.String[], java.lang.String[])

isOpenNewPage

public boolean isOpenNewPage()

isOpenModal

public boolean isOpenModal()