PageLayoutComponent (Jetspeed-2 Core API 2.3.1 API)

```
public interface PageLayoutComponent
```
Page layout component interface.

Version:

$Id:$

Author:

Randy Watler

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTENT_FRAGMENT_ID_SEPARATOR`
`static String`	`GLOBAL_PROPERTY_SCOPE` global standard property scope
`static boolean`	`GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED` group and role standard property scopes enabled flag
`static String`	`GROUP_PROPERTY_SCOPE` group standard property scope
`static String`	`ROLE_PROPERTY_SCOPE` role standard property scope
`static String`	`USER_PROPERTY_SCOPE` user standard property scope

Method Summary

Methods
Modifier and Type	Method and Description
`ContentFragment`	`addFragmentAtRowColumn(ContentPage contentPage, ContentFragment contentFragment, int row, int column)` Add fragment to page at specified row column layout position returning associated content fragment.
`ContentFragment`	`addFragmentReference(ContentFragment contentFragment, String id)` Add fragment reference to fragment returning associated content fragment.
`ContentFragment`	`addFragmentReference(ContentFragment contentFragment, String id, int row, int column)` Add fragment reference to fragment with specified row and column returning associated content fragment.
`ContentFragment`	`addFragmentReference(ContentPage contentPage, String id)` Add fragment reference to page returning associated content fragment.
`ContentFragment`	`addPortlet(ContentFragment contentFragment, String type, String name)` Add portlet to fragment returning associated content fragment.
`ContentFragment`	`addPortlet(ContentFragment contentFragment, String type, String name, int row, int column)` Add portlet to fragment with specified row and column returning associated content fragment.
`ContentFragment`	`addPortlet(ContentPage contentPage, String type, String name)` Add portlet to page returning associated content fragment.
`void`	`decrementFolderInDocumentOrder(ContentPage contentPage)` Decrement position of folder in parent folder document order.
`void`	`decrementInDocumentOrder(ContentPage contentPage)` Decrement position of page in folder document order.
`void`	`incrementFolderInDocumentOrder(ContentPage contentPage)` Increment position of folder in parent folder document order.
`void`	`incrementInDocumentOrder(ContentPage contentPage)` Increment position of page in folder document order.
`void`	`moveFragment(ContentPage contentPage, String fragmentId, String toFragmentId)` Move fragment in page to another layout fragment in the same page.
`void`	`moveFragment(ContentPage contentPage, String fragmentId, String fromFragmentId, String toFragmentId)` Move fragment from current parent layout fragment to another layout fragment in the same page.
`ContentPage`	`newContentPage(BaseFragmentsElement pageOrTemplate, PageTemplate pageTemplate, Map<String,FragmentDefinition> fragmentDefinitions)` Construct a new content page hierarchy from PSML page or template, page templates, and fragment definitions.
`void`	`newSiblingDynamicPage(ContentPage contentPage, String pageName, String contentType, String layoutName, String pageTitle, String pageShortTitle)` Create new sibling dynamic page with specified configuration.
`void`	`newSiblingFolder(ContentPage contentPage, String folderName, String folderTitle, String folderShortTitle, String defaultPageLayoutName)` Create a new sibling folder with specified configuration and new default page.
`void`	`newSiblingFragmentDefinition(ContentPage contentPage, String definitionName, String defId, String portletName, String definitionTitle, String definitionShortTitle)` Create new sibling fragment definition with specified configuration.
`void`	`newSiblingPage(ContentPage contentPage, String pageName, String layoutName, String pageTitle, String pageShortTitle)` Create new sibling page with specified configuration and add new page at end of folder document order list.
`void`	`newSiblingPageTemplate(ContentPage contentPage, String templateName, String layoutName, String templateTitle, String templateShortTitle)` Create new sibling page template with specified configuration.
`void`	`remove(ContentPage contentPage)` Remove page and remove from folder document order list.
`void`	`removeFolder(ContentPage contentPage)` Remove folder and remove from parent folder document order list.
`void`	`removeFragment(ContentPage contentPage, String fragmentId)` Remove fragment from page by id.
`void`	`reorderColumns(ContentFragment targetFragment, int maxColumns)` Reorder portlet columns locations over maxColumns
`void`	`updateContent(ContentPage contentPage, String contentType, Boolean inheritable)` Update dynamic page content type and inheritable flag.
`void`	`updateDecorator(ContentFragment contentFragment, String decoratorName)` Update global fragment portlet decorator.
`void`	`updateDecorator(ContentFragment contentFragment, String decoratorName, String scope, String scopeValue)` Update fragment portlet decorator.
`void`	`updateDefaultDecorator(ContentPage contentPage, String decoratorName, String fragmentType)` Update page default decorator.
`void`	`updateFolderTitles(ContentPage contentPage, String title, String shortTitle)` Update folder titles.
`void`	`updateName(ContentFragment contentFragment, String name)` Update fragment name.
`void`	`updatePosition(ContentFragment contentFragment, float x, float y, float z, float width, float height)` Update global fragment layout position.
`void`	`updatePosition(ContentFragment contentFragment, float x, float y, float z, float width, float height, String scope, String scopeValue)` Update fragment layout position.
`void`	`updatePreferences(ContentFragment contentFragment, Map<String,?> preferences)` Update preferences with new preferences set, accepting Map of strings, string arrays, FragmentPreference or PortletPreference.
`void`	`updateProperty(ContentFragment contentFragment, String propName, String propValue)` Update global fragment property.
`void`	`updateProperty(ContentFragment contentFragment, String propName, String propValue, String scope, String scopeValue)` Update fragment property.
`void`	`updateRefId(ContentFragment contentFragment, String refId)` Update fragment reference reference id.
`void`	`updateRowColumn(ContentFragment contentFragment, int row, int column)` Update global fragment row and column layout position.
`void`	`updateRowColumn(ContentFragment contentFragment, int row, int column, String scope, String scopeValue)` Update fragment row and column layout position.
`void`	`updateSecurityConstraints(ContentFragment contentFragment, SecurityConstraints constraints)` Update fragment security constraints.
`void`	`updateStateMode(ContentFragment contentFragment, String portletState, String portletMode)` Update global fragment portlet state and/or mode.
`void`	`updateStateMode(ContentFragment contentFragment, String portletState, String portletMode, String scope, String scopeValue)` Update fragment portlet state and/or mode.
`void`	`updateTitles(ContentPage contentPage, String title, String shortTitle)` Update page titles.

- Field Detail
  - CONTENT_FRAGMENT_ID_SEPARATOR
```
static final String CONTENT_FRAGMENT_ID_SEPARATOR
```
    See Also:
    Constant Field Values
  - USER_PROPERTY_SCOPE
```
static final String USER_PROPERTY_SCOPE
```
    user standard property scope
    
    See Also:
    Constant Field Values
  - GROUP_PROPERTY_SCOPE
```
static final String GROUP_PROPERTY_SCOPE
```
    group standard property scope
    
    See Also:
    Constant Field Values
  - ROLE_PROPERTY_SCOPE
```
static final String ROLE_PROPERTY_SCOPE
```
    role standard property scope
    
    See Also:
    Constant Field Values
  - GLOBAL_PROPERTY_SCOPE
```
static final String GLOBAL_PROPERTY_SCOPE
```
    global standard property scope
  - GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED
```
static final boolean GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED
```
    group and role standard property scopes enabled flag
    
    See Also:
    Constant Field Values
- Method Detail
  - addFragmentAtRowColumn
```
ContentFragment addFragmentAtRowColumn(ContentPage contentPage,
                                     ContentFragment contentFragment,
                                     int row,
                                     int column)
```
    Add fragment to page at specified row column layout position returning associated content fragment. Fragment is always added to the page root layout fragment.
    
    Parameters:
    contentPage - content page context
    contentFragment - externally constructed fragment to add
    row - fragment row position
    column - fragment column position
    
    Returns:
    content fragment added to page
  - addFragmentReference
```
ContentFragment addFragmentReference(ContentFragment contentFragment,
                                   String id,
                                   int row,
                                   int column)
```
    Add fragment reference to fragment with specified row and column returning associated content fragment.
    
    Parameters:
    contentFragment - content fragment context
    id - fragment definition id
    row - fragment row position
    column - fragment column position
    
    Returns:
    new content fragment added to fragment
  - addFragmentReference
```
ContentFragment addFragmentReference(ContentFragment contentFragment,
                                   String id)
```
    Add fragment reference to fragment returning associated content fragment.
    
    Parameters:
    contentFragment - content fragment context
    id - fragment definition id
    
    Returns:
    new content fragment added to fragment
  - addFragmentReference
```
ContentFragment addFragmentReference(ContentPage contentPage,
                                   String id)
```
    Add fragment reference to page returning associated content fragment.
    
    Parameters:
    contentPage - content page context
    id - fragment definition id
    
    Returns:
    new content fragment added to page
  - addPortlet
```
ContentFragment addPortlet(ContentFragment contentFragment,
                         String type,
                         String name,
                         int row,
                         int column)
```
    Add portlet to fragment with specified row and column returning associated content fragment.
    
    Parameters:
    contentFragment - content fragment context
    type - portlet type
    name - portlet name
    row - fragment row position
    column - fragment column position
    
    Returns:
    new content fragment added to fragment
  - addPortlet
```
ContentFragment addPortlet(ContentFragment contentFragment,
                         String type,
                         String name)
```
    Add portlet to fragment returning associated content fragment.
    
    Parameters:
    contentFragment - content fragment context
    type - portlet type
    name - portlet name
    
    Returns:
    new content fragment added to fragment
  - addPortlet
```
ContentFragment addPortlet(ContentPage contentPage,
                         String type,
                         String name)
```
    Add portlet to page returning associated content fragment.
    
    Parameters:
    contentPage - content page context
    type - portlet type
    name - portlet name
    
    Returns:
    new content fragment added to page
  - decrementFolderInDocumentOrder
```
void decrementFolderInDocumentOrder(ContentPage contentPage)
```
    Decrement position of folder in parent folder document order.
    
    Parameters:
    contentPage - content page context
  - decrementInDocumentOrder
```
void decrementInDocumentOrder(ContentPage contentPage)
```
    Decrement position of page in folder document order.
    
    Parameters:
    contentPage - content page context
  - incrementFolderInDocumentOrder
```
void incrementFolderInDocumentOrder(ContentPage contentPage)
```
    Increment position of folder in parent folder document order.
    
    Parameters:
    contentPage - content page context
  - incrementInDocumentOrder
```
void incrementInDocumentOrder(ContentPage contentPage)
```
    Increment position of page in folder document order.
    
    Parameters:
    contentPage - content page context
  - moveFragment
```
void moveFragment(ContentPage contentPage,
                String fragmentId,
                String toFragmentId)
```
    Move fragment in page to another layout fragment in the same page.
    
    Parameters:
    contentPage - content page context
    fragmentId - fragment id of fragment to move
    toFragmentId - fragment id of new parent layout fragment
  - moveFragment
```
void moveFragment(ContentPage contentPage,
                String fragmentId,
                String fromFragmentId,
                String toFragmentId)
```
    Move fragment from current parent layout fragment to another layout fragment in the same page.
    
    Parameters:
    contentPage - content page context
    fragmentId - fragment id of fragment to move
    fromFragmentId - fragment id of current parent layout fragment or or null if fragment to be found anywhere in page
    toFragmentId - fragment id of new parent layout fragment
  - newContentPage
```
ContentPage newContentPage(BaseFragmentsElement pageOrTemplate,
                         PageTemplate pageTemplate,
                         Map<String,FragmentDefinition> fragmentDefinitions)
```
    Construct a new content page hierarchy from PSML page or template, page templates, and fragment definitions.
    
    Parameters:
    pageOrTemplate - PSML page or template to construct content page from
    pageTemplate - PSML page template to merge into content page
    fragmentDefinitions - PSML fragment definitions referenced by page and/or page template
    
    Returns:
    new content page
  - newSiblingFolder
```
void newSiblingFolder(ContentPage contentPage,
                    String folderName,
                    String folderTitle,
                    String folderShortTitle,
                    String defaultPageLayoutName)
```
    Create a new sibling folder with specified configuration and new default page. Also, adds folder to end of page folder document order list. The default page is added to the new folder document order list. Both title and short title parameters default to page name if not specified. The layout fragment name for the default page is cloned from this content page if not specified. Default decorators are cloned from this content page.
    
    Parameters:
    contentPage - content page context
    folderName - unique new folder name, (also used as default page title)
    folderTitle - new folder title or null
    folderShortTitle - new folder short title or null
    defaultPageLayoutName - root level layout fragment name for default page
  - newSiblingPage
```
void newSiblingPage(ContentPage contentPage,
                  String pageName,
                  String layoutName,
                  String pageTitle,
                  String pageShortTitle)
```
    Create new sibling page with specified configuration and add new page at end of folder document order list. Both title and short title parameters default to page name if not specified. The layout fragment name is cloned from this content page if not specified. Default decorators are cloned from this content page.
    
    Parameters:
    contentPage - content page context
    pageName - unique new page name
    layoutName - root level layout fragment name or null
    pageTitle - new page title or null
    pageShortTitle - new page short title or null
  - newSiblingDynamicPage
```
void newSiblingDynamicPage(ContentPage contentPage,
                         String pageName,
                         String contentType,
                         String layoutName,
                         String pageTitle,
                         String pageShortTitle)
```
    Create new sibling dynamic page with specified configuration. Both title and short title parameters default to page name if not specified. The layout fragment name is cloned from this content page if not specified. Default decorators are cloned from this content page.
    
    Parameters:
    contentPage - content page context
    pageName - unique new dynamic page name
    contentType - dynamic page content type
    layoutName - root level layout fragment name or null
    pageTitle - new page title or null
    pageShortTitle - new page short title or null
  - newSiblingPageTemplate
```
void newSiblingPageTemplate(ContentPage contentPage,
                          String templateName,
                          String layoutName,
                          String templateTitle,
                          String templateShortTitle)
```
    Create new sibling page template with specified configuration. The layout fragment name is cloned from this content page if not specified. Default decorators are cloned from this content page.
    
    Parameters:
    contentPage - content page context
    templateName - unique new page template name
    layoutName - root level layout fragment name or null
    templateTitle - new page title or null
    templateShortTitle - new page short title or null
  - newSiblingFragmentDefinition
```
void newSiblingFragmentDefinition(ContentPage contentPage,
                                String definitionName,
                                String defId,
                                String portletName,
                                String definitionTitle,
                                String definitionShortTitle)
```
    Create new sibling fragment definition with specified configuration.
    
    Parameters:
    contentPage - content page context
    definitionName - unique new fragment definition name
    defId - unique new fragment definition id or null
    portletName - root level portlet fragment name or null
    definitionTitle - new page title or null
    definitionShortTitle - new page short title or null
  - removeFragment
```
void removeFragment(ContentPage contentPage,
                  String fragmentId)
```
    Remove fragment from page by id.
    
    Parameters:
    contentPage - content page context
    fragmentId - id of fragment to remove
  - remove
```
void remove(ContentPage contentPage)
```
    Remove page and remove from folder document order list.
    
    Parameters:
    contentPage - content page context
  - removeFolder
```
void removeFolder(ContentPage contentPage)
```
    Remove folder and remove from parent folder document order list.
    
    Parameters:
    contentPage - content page context
  - updateContent
```
void updateContent(ContentPage contentPage,
                 String contentType,
                 Boolean inheritable)
```
    Update dynamic page content type and inheritable flag.
    
    Parameters:
    contentPage - content page context
    contentType - dynamic page content type
    contentType - dynamic page content type
  - updateDecorator
```
void updateDecorator(ContentFragment contentFragment,
                   String decoratorName)
```
    Update global fragment portlet decorator.
    
    Parameters:
    contentFragment - content fragment context
    decoratorName - portlet decorator name
  - updateDecorator
```
void updateDecorator(ContentFragment contentFragment,
                   String decoratorName,
                   String scope,
                   String scopeValue)
```
    Update fragment portlet decorator.
    
    Parameters:
    contentFragment - content fragment context
    decoratorName - portlet decorator name
    scope - property scope
    scopeValue - property scope value
  - updateDefaultDecorator
```
void updateDefaultDecorator(ContentPage contentPage,
                          String decoratorName,
                          String fragmentType)
```
    Update page default decorator.
    
    Parameters:
    contentPage - content page context
    decoratorName - decorator name
    fragmentType - decorator fragment type
  - updateFolderTitles
```
void updateFolderTitles(ContentPage contentPage,
                      String title,
                      String shortTitle)
```
    Update folder titles.
    
    Parameters:
    contentPage - content page context
    title - folder title
    shortTitle - folder short title
  - updateName
```
void updateName(ContentFragment contentFragment,
              String name)
```
    Update fragment name.
    
    Parameters:
    contentFragment - content fragment context
    name - fragment name
  - updatePosition
```
void updatePosition(ContentFragment contentFragment,
                  float x,
                  float y,
                  float z,
                  float width,
                  float height)
```
    Update global fragment layout position.
    
    Parameters:
    contentFragment - content fragment context
    x - fragment X coordinate or -1
    y - fragment Y coordinate or -1
    z - fragment Z level or -1
    width - fragment portlet width or -1
    height - fragment portlet height or -1
  - updatePosition
```
void updatePosition(ContentFragment contentFragment,
                  float x,
                  float y,
                  float z,
                  float width,
                  float height,
                  String scope,
                  String scopeValue)
```
    Update fragment layout position.
    
    Parameters:
    contentFragment - content fragment context
    x - fragment X coordinate or -1
    y - fragment Y coordinate or -1
    z - fragment Z level or -1
    width - fragment portlet width or -1
    height - fragment portlet height or -1
    scope - properties scope
    scopeValue - properties scope value
  - updatePreferences
```
void updatePreferences(ContentFragment contentFragment,
                     Map<String,?> preferences)
```
    Update preferences with new preferences set, accepting Map of strings, string arrays, FragmentPreference or PortletPreference. Existing preferences are removed and replaced with the specified preferences. preferences values are normally PortletPreference but can also be String, String[], or FragmentPreference
    
    Parameters:
    contentFragment - content fragment context
    preferences - map of new preferences set.
  - updateProperty
```
void updateProperty(ContentFragment contentFragment,
                  String propName,
                  String propValue)
```
    Update global fragment property.
    
    Parameters:
    contentFragment - content fragment context
    propName - fragment property name
    propValue - fragment property value
  - updateProperty
```
void updateProperty(ContentFragment contentFragment,
                  String propName,
                  String propValue,
                  String scope,
                  String scopeValue)
```
    Update fragment property.
    
    Parameters:
    contentFragment - content fragment context
    propName - fragment property name
    propValue - fragment property value
    scope - property scope
    scopeValue - property scope value
  - updateRefId
```
void updateRefId(ContentFragment contentFragment,
               String refId)
```
    Update fragment reference reference id.
    
    Parameters:
    contentFragment - content fragment context
    refId - referenced fragment definition id
  - updateRowColumn
```
void updateRowColumn(ContentFragment contentFragment,
                   int row,
                   int column)
```
    Update global fragment row and column layout position.
    
    Parameters:
    contentFragment - content fragment context
    row - fragment row position
    column - fragment column position
  - updateRowColumn
```
void updateRowColumn(ContentFragment contentFragment,
                   int row,
                   int column,
                   String scope,
                   String scopeValue)
```
    Update fragment row and column layout position.
    
    Parameters:
    contentFragment - content fragment context
    row - fragment row position
    column - fragment column position
    scope - properties scope
    scopeValue - properties scope value
  - updateSecurityConstraints
```
void updateSecurityConstraints(ContentFragment contentFragment,
                             SecurityConstraints constraints)
```
    Update fragment security constraints.
    
    Parameters:
    contentFragment - content fragment context
    constraints - security constraints
  - updateStateMode
```
void updateStateMode(ContentFragment contentFragment,
                   String portletState,
                   String portletMode)
```
    Update global fragment portlet state and/or mode.
    
    Parameters:
    contentFragment - content fragment context
    portletState - fragment portlet state or null
    portletMode - fragment portlet mode or null
  - updateStateMode
```
void updateStateMode(ContentFragment contentFragment,
                   String portletState,
                   String portletMode,
                   String scope,
                   String scopeValue)
```
    Update fragment portlet state and/or mode.
    
    Parameters:
    contentFragment - content fragment context
    portletState - fragment portlet state or null
    portletMode - fragment portlet mode or null
    scope - properties scope
    scopeValue - properties scope value
  - updateTitles
```
void updateTitles(ContentPage contentPage,
                String title,
                String shortTitle)
```
    Update page titles.
    
    Parameters:
    contentPage - content page context
    title - page title
    shortTitle - page short title
  - reorderColumns
```
void reorderColumns(ContentFragment targetFragment,
                  int maxColumns)
```
    Reorder portlet columns locations over maxColumns
    
    Parameters:
    targetFragment -
    maxColumns -

Interface PageLayoutComponent

Field Summary

Method Summary

Field Detail

CONTENT_FRAGMENT_ID_SEPARATOR

USER_PROPERTY_SCOPE

GROUP_PROPERTY_SCOPE

ROLE_PROPERTY_SCOPE

GLOBAL_PROPERTY_SCOPE

GROUP_AND_ROLE_PROPERTY_SCOPES_ENABLED

Method Detail

addFragmentAtRowColumn

addFragmentReference

addFragmentReference

addFragmentReference

addPortlet

addPortlet

addPortlet

decrementFolderInDocumentOrder

decrementInDocumentOrder

incrementFolderInDocumentOrder

incrementInDocumentOrder

moveFragment

moveFragment

newContentPage

newSiblingFolder

newSiblingPage

newSiblingDynamicPage

newSiblingPageTemplate

newSiblingFragmentDefinition

removeFragment

remove

removeFolder

updateContent

updateDecorator

updateDecorator

updateDefaultDecorator

updateFolderTitles

updateName

updatePosition

updatePosition

updatePreferences

updateProperty

updateProperty

updateRefId

updateRowColumn

updateRowColumn

updateSecurityConstraints

updateStateMode

updateStateMode

updateTitles

reorderColumns