public interface PageLangSpec extends StoreElement
Modifier and Type | Method and Description |
---|---|
AltPageRef |
createAltPageRef(Page page,
Date validFrom)
Deprecated.
since 4.2.400, use
getScheduledPageRefs() and createScheduledPageRef(Page, Date) |
de.espirit.firstspirit.store.access.sitestore.AltPageRefImpl |
createScheduledPageRef(Page page,
Date validFrom)
Creates and adds a scheduled page-ref.
|
AltPageRef[] |
getAltPageRefs()
Deprecated.
since 4.2.400, use
getScheduledPageRefs() and createScheduledPageRef(Page, Date) |
String |
getKeywords()
Gets the keywords of this pagereference.
|
Language |
getLanguage()
Get the language of the pagereference
|
String |
getName()
Get the name of the pagereference
|
RemoteProjectConfiguration |
getRemoteProjectConfiguration()
Return RemoteProjectConfiguration used for related project.
|
List<AltPageRef> |
getScheduledPageRefs()
Returns a modifiable list of scheduled page-refs.
|
boolean |
getShowInPageGroup()
State if this pagereference shold be shown at the PageGroup
|
boolean |
getShowInSiteMap()
State if this pagereference shold be shown at the SiteMap
|
String |
getSiteMapLabel()
Get the sitemap label of this pageref.
|
Picture |
getSiteMapPicture()
Gets the sitemap picture of this pageref.
|
String |
getSiteMapPictureRef() |
String |
getUrl()
Get the external URL of the pagereference
|
boolean |
hasSiteMapPictureRef() |
void |
setAltPageRefs(AltPageRef[] refs)
Deprecated.
since 4.2.400, use
getScheduledPageRefs() and createScheduledPageRef(Page, Date) |
void |
setKeywords(String keywords)
Sets the keywords for this pagereference for the underlying
language of this PageLangSpec.
|
void |
setName(String name)
Set the name of the pagereference
|
void |
setRemoteProjectConfiguration(RemoteProjectConfiguration configuration)
Set RemoteProjectConfiguration used for releated project.
|
void |
setShowInPageGroup(boolean show)
Set the state if this pagereference shold be shown in the PageGroup
|
void |
setShowInSiteMap(boolean show)
Set the state if this menu shold be shown at the pagereference
|
void |
setSiteMapLabel(String label)
Set the label of the sitemap
|
void |
setSiteMapPicture(Picture picture)
Sets the sitemap picture for this pagereference.
|
void |
setSiteMapPictureRef(String ref)
Sets the sitemap picture as string reference.
|
void |
setUrl(String url)
Set the external URL of the pagereference
|
void |
setUseExternalUrl(boolean useExternal)
Set the state if this pagereference should use an external URL.
|
void |
setUseRelatedProjectUrl(boolean useRelated)
State if this pagereference should use an URL to a related project.
|
boolean |
useExternalUrl()
State if this pagereference should use an external URL
|
boolean |
useInternalUrl()
State if this pagereference use an internal URL.
|
boolean |
useRelatedProjectUrl()
State if this pagereference use an URL from a releated project.
|
appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getNextSibling, getOutgoingReferences, getParent, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, 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
@NotNull String getName()
getName
in interface StoreElement
void setName(String name)
name
- new name of the pagereferenceLanguage getLanguage()
boolean getShowInPageGroup()
false
- hidden; true
- visiblevoid setShowInPageGroup(boolean show)
show
- false
- hide; true
- showString getKeywords()
null
if no keywords setvoid setKeywords(String keywords)
keywords
- the new keywords for this PageLangSpecboolean getShowInSiteMap()
false
- hidden; true
- visiblevoid setShowInSiteMap(boolean show)
show
- false
- hide; true
- show@Nullable String getSiteMapLabel()
void setSiteMapLabel(String label)
label
- the sitemap labelboolean hasSiteMapPictureRef()
true
if a site map picture is setgetSiteMapPictureRef()
,
getSiteMapPicture()
@Nullable Picture getSiteMapPicture()
Picture
sitemappicture or null
if no picture is set or the
reference name
is invalidIOException
hasSiteMapPictureRef()
,
getSiteMapPictureRef()
,
setSiteMapPicture(Picture)
@Nullable String getSiteMapPictureRef()
null
, if no site map
picture is specifiedhasSiteMapPictureRef()
,
getSiteMapPicture()
void setSiteMapPicture(@Nullable Picture picture)
picture
- the new sitemap picturegetSiteMapPicture()
,
hasSiteMapPictureRef()
,
getSiteMapPictureRef()
void setSiteMapPictureRef(String ref)
String getUrl()
void setUrl(String url)
url
- new external URL for the pagereferenceboolean useInternalUrl()
setUseExternalUrl(boolean)
or
setUseRelatedProjectUrl(boolean)
with falsefalse
- don't use; true
- useboolean useRelatedProjectUrl()
false
- don't use; true
- usevoid setUseRelatedProjectUrl(boolean useRelated)
false
pagereference will use internal URL (default mode).useRelated
- false
-> don't use; true
-> useboolean useExternalUrl()
false
- don't use; true
- usevoid setUseExternalUrl(boolean useExternal)
false
pagereference will use internal URL (default mode).useExternal
- false
-> don't use; true
-> use@Deprecated AltPageRef createAltPageRef(@NotNull Page page, Date validFrom)
setAltPageRefs(AltPageRef[])
with created AltPageRef.page
- page from PageStore that should be taken as an alternativevalidFrom
- date from that the new page is validcreateScheduledPageRef(Page, Date)
,
getScheduledPageRefs()
@NotNull @Deprecated AltPageRef[] getAltPageRefs()
setAltPageRefs(AltPageRef[])
after modification of the returned alternative pages
to persist changes.createScheduledPageRef(Page, Date)
,
getScheduledPageRefs()
@Deprecated void setAltPageRefs(AltPageRef[] refs)
refs
- list of alternative pagescreateScheduledPageRef(Page, Date)
,
getScheduledPageRefs()
@NotNull de.espirit.firstspirit.store.access.sitestore.AltPageRefImpl createScheduledPageRef(@NotNull Page page, @NotNull Date validFrom)
page
- page from PageStore that should be taken as an scheduled alternative.validFrom
- date from that the new page will be valid.@NotNull List<AltPageRef> getScheduledPageRefs()
createScheduledPageRef(Page, Date)
@Nullable RemoteProjectConfiguration getRemoteProjectConfiguration()
void setRemoteProjectConfiguration(@Nullable RemoteProjectConfiguration configuration)
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500