|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.layout.alm.AggregatedLayout
org.jasig.portal.layout.alm.ALFragment
public class ALFragment
The implementation of the user layout fragment. Prior to uPortal 2.5, this class existed in the package org.jasig.portal.layout. It was moved to its present package to reflect that it is part of Aggregated Layouts.
Field Summary | |
---|---|
protected java.lang.String |
description
|
protected java.lang.String |
functionalName
|
protected boolean |
pushedFragment
|
Fields inherited from interface org.jasig.portal.layout.IUserLayout |
---|
ROOT_NODE_NAME |
Fields inherited from interface org.jasig.portal.layout.alm.IAggregatedLayout |
---|
ADD_TARGET, CHANNEL, FOLDER, FRAGMENT, LAYOUT, MOVE_TARGET, PARAMETER, RESTRICTION |
Constructor Summary | |
---|---|
ALFragment(java.lang.String fragmentId)
|
|
ALFragment(java.lang.String fragmentId,
IAggregatedUserLayoutManager layoutManager)
|
Method Summary | |
---|---|
java.lang.String |
getDescription()
Returns a fragment description |
java.lang.String |
getFragmentId(java.lang.String nodeId)
Returns an fragment Id for a given node. |
java.util.Set |
getFragmentIds()
Returns a list of fragment Ids existing in the layout. |
java.lang.String |
getFragmentRootId()
Returns the fragment root Id. |
java.lang.String |
getFunctionalName()
Returns a fragment functional name |
java.lang.String |
getName()
Returns a fragment name |
boolean |
isPushedFragment()
Answers whether the fragment is pushed or pulled |
void |
setDescription(java.lang.String description)
Sets a fragment description |
void |
setFunctionalName(java.lang.String functionalName)
Sets a fragment functional name |
void |
setName(java.lang.String name)
Sets a fragment name |
void |
setPulledFragment()
Marks the fragment as pulled |
void |
setPushedFragment()
Marks the fragment as pushed |
Methods inherited from class org.jasig.portal.layout.alm.AggregatedLayout |
---|
addLayoutEventListener, getCacheKey, getChildIds, getDepth, getFirstSiblingNode, getFragmentRootId, getId, getLastSiblingNode, getLayoutData, getLayoutFolder, getLayoutNode, getNextSiblingId, getNode, getNodeDescription, getNodeId, getNodeIds, getParentId, getPreviousSiblingId, getRootId, removeLayoutEventListener, setLayoutData, setLayoutManager, writeTo, writeTo, writeTo, writeTo |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jasig.portal.layout.IUserLayout |
---|
addLayoutEventListener, getCacheKey, getChildIds, getId, getNextSiblingId, getNodeDescription, getNodeId, getNodeIds, getParentId, getPreviousSiblingId, getRootId, removeLayoutEventListener, writeTo, writeTo, writeTo, writeTo |
Field Detail |
---|
protected java.lang.String functionalName
protected java.lang.String description
protected boolean pushedFragment
Constructor Detail |
---|
public ALFragment(java.lang.String fragmentId, IAggregatedUserLayoutManager layoutManager) throws PortalException
PortalException
public ALFragment(java.lang.String fragmentId) throws PortalException
PortalException
Method Detail |
---|
public boolean isPushedFragment()
public void setPushedFragment()
public void setPulledFragment()
public java.lang.String getFunctionalName()
getFunctionalName
in interface ILayoutFragment
String
fragment namepublic void setFunctionalName(java.lang.String functionalName)
functionalName
- a String
valuepublic java.lang.String getName()
getName
in interface ILayoutFragment
String
fragment namepublic java.lang.String getDescription()
getDescription
in interface ILayoutFragment
String
fragment descriptionpublic void setName(java.lang.String name)
name
- a String
valuepublic void setDescription(java.lang.String description)
description
- a String
valuepublic java.util.Set getFragmentIds() throws PortalException
getFragmentIds
in interface IAggregatedLayout
getFragmentIds
in class AggregatedLayout
Set
of String
fragment Ids.
PortalException
- if an error occurspublic java.lang.String getFragmentId(java.lang.String nodeId) throws PortalException
getFragmentId
in interface IAggregatedLayout
getFragmentId
in class AggregatedLayout
nodeId
- a String
value
String
fragment Id
PortalException
- if an error occurspublic java.lang.String getFragmentRootId() throws PortalException
getFragmentRootId
in interface ILayoutFragment
String
fragment root Id
PortalException
- if an error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |