public interface PageRefFolder extends SiteStoreFolder, Referenceable, PackagePoolItem, StoreElementFolder
Example how to modify variables of SiteStoreFolder |
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static int |
MEDIA |
static int |
MEDIA_MOUSEOVER |
static int |
MEDIA_SELECTED |
static int |
MEDIA_SELECTED_MOUSEOVER |
UID_TYPE
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
BLOCKED, MODIFIED, UNMODIFIED
Modifier and Type | Method and Description |
---|---|
FolderLangSpec |
getFolderLangSpec(Language language)
Get the folder specification for the given language
|
Media |
getGraphicalNavigationMedia(int state)
Gets the
media for the given graphical navigation state
(on of MEDIA , MEDIA_MOUSEOVER , MEDIA_SELECTED , MEDIA_SELECTED_MOUSEOVER )
or null if no media is set for the given state. |
String |
getGraphicalNavigationMediaUid(int state)
Gets the media uid for the given graphical navigation state
(on of
MEDIA , MEDIA_MOUSEOVER , MEDIA_SELECTED , MEDIA_SELECTED_MOUSEOVER )
or null if no media uid is set for the given state. |
int |
getPosition()
Returns the position of this pagereffolder in menu order of the parent folder.
|
boolean |
isFolder()
Implementing classes must return
true |
void |
setGraphicalNavigationMedia(int state,
Media media)
Sets the
media for the graphical navigation for the
given graphical navigation state (on of MEDIA , MEDIA_MOUSEOVER , MEDIA_SELECTED , MEDIA_SELECTED_MOUSEOVER )To reset the picture for a specific state call with null for param 'media' |
void |
setPosition(int position)
Deprecated.
since 4.2.204 - use
IDProvider#moveChild(IDProvider, nextSiblingIndex) to position in menu order |
createDocumentGroup, createPageGroup, createPageRef, createPageRef, createPageRef, createPageRefFolder, createPageRefFolder, createPageRefFolder, createPageRefFolder, deletePageGroup, findStartNode, getFormData, getPageGroups, getParentFolder, getStartNode, getStoredUrl, setStartNode
isStartNode
clearCachedData, getData, setData, setFormData
contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setMeta, setMetaFormData, setUid
appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, update
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
getReferenceName
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
static final int MEDIA
static final int MEDIA_MOUSEOVER
static final int MEDIA_SELECTED
static final int MEDIA_SELECTED_MOUSEOVER
@NotNull FolderLangSpec getFolderLangSpec(Language language)
language
- language for that folder specification will be returnedboolean isFolder()
true
isFolder
in interface SiteStoreFolder
isFolder
in interface StoreElement
true
int getPosition()
pagereffolders
in the parent.
Use StoreElement.getChildIndex(de.espirit.firstspirit.access.store.StoreElement)
to get the
absolute index in child listStoreElement.getChildIndex(de.espirit.firstspirit.access.store.StoreElement)
@Deprecated void setPosition(int position)
IDProvider#moveChild(IDProvider, nextSiblingIndex)
to position in menu orderIDProvider#moveChild(IDProvider, nextSiblingIndex)
Media getGraphicalNavigationMedia(int state)
media
for the given graphical navigation state
(on of MEDIA
, MEDIA_MOUSEOVER
, MEDIA_SELECTED
, MEDIA_SELECTED_MOUSEOVER
)
or null
if no media is set for the given state.state
- graphical navigation state (on of MEDIA
, MEDIA_MOUSEOVER
, MEDIA_SELECTED
, MEDIA_SELECTED_MOUSEOVER
)null
IllegalArgumentException
- for unknown graphical statesString getGraphicalNavigationMediaUid(int state)
MEDIA
, MEDIA_MOUSEOVER
, MEDIA_SELECTED
, MEDIA_SELECTED_MOUSEOVER
)
or null
if no media uid is set for the given state.state
- graphical navigation state (on of MEDIA
, MEDIA_MOUSEOVER
, MEDIA_SELECTED
, MEDIA_SELECTED_MOUSEOVER
)null
IllegalArgumentException
- for unknown graphical statesvoid setGraphicalNavigationMedia(int state, Media media)
media
for the graphical navigation for the
given graphical navigation state (on of MEDIA
, MEDIA_MOUSEOVER
, MEDIA_SELECTED
, MEDIA_SELECTED_MOUSEOVER
)null
for param 'media'state
- graphical navigation state (on of MEDIA
, MEDIA_MOUSEOVER
, MEDIA_SELECTED
, MEDIA_SELECTED_MOUSEOVER
)media
- of type Media.PICTURE
IllegalArgumentException
- for medias which type isn't of Media.PICTURE and unknown graphical statesCopyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500