|
| |
|
| org.apache.jetspeed.om.folder.Folder
All known Subclasses: org.apache.jetspeed.om.folder.psml.FolderImpl, org.apache.jetspeed.om.folder.impl.FolderImpl,
| RESERVED_COUNTRY_FOLDER_NAME | | String RESERVED_COUNTRY_FOLDER_NAME(Code) | | |
| RESERVED_FOLDER_COUNTRY | | int RESERVED_FOLDER_COUNTRY(Code) | | |
| RESERVED_FOLDER_GROUPS | | int RESERVED_FOLDER_GROUPS(Code) | | |
| RESERVED_FOLDER_LANGUAGE | | int RESERVED_FOLDER_LANGUAGE(Code) | | |
| RESERVED_FOLDER_MEDIATYPE | | int RESERVED_FOLDER_MEDIATYPE(Code) | | |
| RESERVED_FOLDER_NONE | | int RESERVED_FOLDER_NONE(Code) | | |
| RESERVED_FOLDER_OTHER | | int RESERVED_FOLDER_OTHER(Code) | | |
| RESERVED_FOLDER_ROLES | | int RESERVED_FOLDER_ROLES(Code) | | |
| RESERVED_FOLDER_SUBSITES | | int RESERVED_FOLDER_SUBSITES(Code) | | |
| RESERVED_FOLDER_USERS | | int RESERVED_FOLDER_USERS(Code) | | |
| RESERVED_GROUP_FOLDER_NAME | | String RESERVED_GROUP_FOLDER_NAME(Code) | | |
| RESERVED_LANGUAGE_FOLDER_NAME | | String RESERVED_LANGUAGE_FOLDER_NAME(Code) | | |
| RESERVED_MEDIATYPE_FOLDER_NAME | | String RESERVED_MEDIATYPE_FOLDER_NAME(Code) | | |
| RESERVED_ROLE_FOLDER_NAME | | String RESERVED_ROLE_FOLDER_NAME(Code) | | |
| RESERVED_SUBSITE_FOLDER_PREFIX | | String RESERVED_SUBSITE_FOLDER_PREFIX(Code) | | |
| RESERVED_USER_FOLDER_NAME | | String RESERVED_USER_FOLDER_NAME(Code) | | |
| getDefaultDecorator | | String getDefaultDecorator(String fragmentType)(Code) | | Returns the name of the default decorator that applies to page
fragments in this folder or subfolders.
Parameters:
fragmentType - the type of fragment considered the decorator name for the selected type |
| getDefaultPage | | String getDefaultPage()(Code) | |
getDefaultPage
A String representing the default psml page for this folder |
| getDocumentOrder | | List getDocumentOrder()(Code) | | getDocumentOrder
list of ordered document names in folder |
| getEffectiveDefaultDecorator | | String getEffectiveDefaultDecorator(String fragmentType)(Code) | | Returns the name of the default decorator as set here or
in parent folders that applies to page fragments
in this folder or subfolders.
Parameters:
fragmentType - the type of fragment considered the decorator name for the selected type |
| getMenuDefinitions | | List getMenuDefinitions()(Code) | | getMenuDefinitions - get list of menu definitions
definition list |
| getReservedType | | int getReservedType()(Code) | | Returns a valid reserved folder type:
RESERVED_FOLDER_SUBSITES
RESERVED_FOLDER_USERS
RESERVED_FOLDER_ROLES
RESERVED_FOLDER_GROUPS
RESERVED_FOLDER_MEDIATYPE
RESERVED_FOLDER_LANGUAGE
RESERVED_FOLDER_COUNTRY
one of the valid reserved folder types |
| getSkin | | String getSkin()(Code) | | Returns the name of the skin that applies to this
folder.
the page default skin name |
| isReserved | | boolean isReserved()(Code) | | Determines if a folder is a reserved folder.
Reserved folders are special folders that can
hold subsites, the root of user folders, and the
root of role folders.
|
| newMenuDefinition | | MenuDefinition newMenuDefinition()(Code) | | newMenuDefinition - creates a new empty menu definition
a newly created MenuDefinition object for use in Folder |
| newMenuExcludeDefinition | | MenuExcludeDefinition newMenuExcludeDefinition()(Code) | | newMenuExcludeDefinition - creates a new empty menu exclude definition
a newly created MenuExcludeDefinition object for use in Folder |
| newMenuIncludeDefinition | | MenuIncludeDefinition newMenuIncludeDefinition()(Code) | | newMenuIncludeDefinition - creates a new empty menu include definition
a newly created MenuIncludeDefinition object for use in Folder |
| newMenuOptionsDefinition | | MenuOptionsDefinition newMenuOptionsDefinition()(Code) | | newMenuOptionsDefinition - creates a new empty menu options definition
a newly created MenuOptionsDefinition object for use in Folder |
| newMenuSeparatorDefinition | | MenuSeparatorDefinition newMenuSeparatorDefinition()(Code) | | newMenuSeparatorDefinition - creates a new empty menu separator definition
a newly created MenuSeparatorDefinition object for use in Folder |
| setDefaultDecorator | | void setDefaultDecorator(String decoratorName, String fragmentType)(Code) | | Modifies the default decorator for the specified fragment type.
Parameters:
decoratorName - the name of the new decorator for the type
Parameters:
fragmentType - the type of fragment considered |
| setDefaultPage | | void setDefaultPage(String defaultPage)(Code) | |
setDefaultPage
Parameters:
defaultPage - |
| setDocumentOrder | | void setDocumentOrder(List docIndexes)(Code) | | setDocumentOrder
Parameters:
docIndexes - list of ordered document names in folder |
| setMenuDefinitions | | void setMenuDefinitions(List definitions)(Code) | | setMenuDefinitions - set list of menu definitions
Parameters:
definitions - definition list |
| setSkin | | void setSkin(String skinName)(Code) | | Modifies the skin for this folder.
Parameters:
skinName - the name of the new skin for the folder |
|
|
|