|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.jetspeed.headerresource.impl.HeaderResourceImpl
public class HeaderResourceImpl
Default implementation for HeaderResource
| Field Summary | |
|---|---|
protected static java.lang.String |
EOL
|
protected static org.apache.commons.logging.Log |
log
|
protected static java.lang.String |
UNNAMED_CONTENT_HEADER_NAME
|
| Constructor Summary | |
|---|---|
HeaderResourceImpl(RequestContext context)
Default Constructor |
|
HeaderResourceImpl(RequestContext context,
BasePortalURL baseUrlAccess,
boolean isDesktop,
java.util.Map headerConfiguration)
|
|
| Method Summary | |
|---|---|
void |
addHeaderInfo(java.lang.String text)
Add text as-is to this instance. |
void |
addHeaderInfo(java.lang.String elementName,
java.util.Map attributes,
java.lang.String text)
Add tag information to this instance. |
void |
addHeaderSectionFragment(java.lang.String addToHeaderName,
java.lang.String text)
Add text argument to the getHeaderSections() content entry with a key that matches addToHeaderName argument |
void |
addHeaderSectionFragment(java.lang.String headerFragmentName,
java.lang.String addToHeaderName,
java.lang.String text)
If no previous call using value of headerFragmentName argument has been added to any getHeaderSections() content entry, add text argument to the getHeaderSections() content entry with a key that matches addToHeaderName argument |
protected void |
addHeaderSectionFragment(java.lang.String headerFragmentName,
java.lang.String addToHeaderName,
java.lang.String text,
boolean alreadyCheckedFragName)
|
void |
addJavaScript(java.lang.String path)
Convenient method to add <script> tag. |
void |
addJavaScript(java.lang.String path,
boolean defer)
Convenient method to add <script> tag with defer option. |
void |
addStyleSheet(java.lang.String path)
Convenient method to add <link> tag. |
void |
dojoAddBodyExpandStyle(boolean omitWindowScrollbars)
Assure that header section name for dojo body expand style is included |
void |
dojoAddCoreLibraryRequire(java.lang.String dojoRequire)
If no previous call using value of dojoRequire argument has been added to any getHeaderSections() content entry, add text argument to the getHeaderSections() content entry for dojo core require statements |
void |
dojoAddCoreLibraryRequires(java.lang.String dojoRequires)
Split dojoRequires argument using ';' delimiter and for each resulting dojoRequire value, if no previous call using dojoRequire value has been added to any getHeaderSections() content entry, add text argument to the getHeaderSections() content entry for dojo core require statements |
void |
dojoAddModuleLibraryRequire(java.lang.String dojoRequire)
If no previous call using value of dojoRequire argument has been added to any getHeaderSections() content entry, add text argument to the getHeaderSections() content entry for dojo library module require statements |
void |
dojoAddModuleLibraryRequires(java.lang.String dojoRequires)
Split dojoRequires argument using ';' delimiter and for each resulting dojoRequire value, if no previous call using dojoRequire value has been added to any getHeaderSections() content entry, add text argument to the getHeaderSections() content entry for dojo library module require statements |
protected void |
dojoAddRequire(java.lang.String dojoRequire,
java.lang.String addToHeaderName)
|
protected void |
dojoAddRequires(java.lang.String dojoRequires,
java.lang.String addToHeaderName)
|
protected void |
dojoDisable()
|
void |
dojoEnable()
Enable dojo by setting appropriate modifiable header configuration setting |
protected java.lang.String |
dojoGenerateBodyExpandNoScrollStyle()
|
protected java.lang.String |
dojoGenerateBodyExpandStyle()
|
protected java.lang.String |
dojoGenerateInit()
|
protected java.lang.String |
dojoGeneratePreinit()
|
protected java.lang.String |
dojoGenerateWriteincludes()
|
protected java.lang.String |
dojoGetPath()
|
protected java.lang.String |
generateHeaderSection(java.lang.String headerName)
|
protected BasePortalURL |
getBaseUrlAccess()
|
java.lang.String |
getContent()
Output all content (that has not already been output) |
java.util.Map |
getHeaderConfiguration()
Access complete header configuration settings |
java.util.Map |
getHeaderDynamicConfiguration()
Access modifiable header configuration settings |
protected java.util.Map |
getHeaderResourceRegistry()
|
protected java.util.Map |
getHeaderSectionNames(boolean create)
|
protected java.util.List |
getHeaderSectionOrderList(boolean create)
|
java.lang.String |
getHeaderSectionRequiredFlag(java.lang.String headerName)
Get the requiredflag of the getHeaderSections() content entry with a key that matches headerName argument |
protected java.util.Map |
getHeaderSections()
|
protected java.util.Map |
getHeaderSectionsAddedFragments()
|
java.lang.String |
getHeaderSectionType(java.lang.String headerName)
Get the type of the getHeaderSections() content entry with a key that matches headerName argument |
protected java.util.Map |
getHeaderSectionTypes(boolean create)
|
java.lang.String |
getNamedContent()
Output all getHeaderSections() content (that has not already been output) |
java.lang.String |
getNamedContent(java.lang.String headerName)
Output the one getHeaderSections() content entry with a key that matches headerName (if it has not already been output) |
java.lang.String |
getNamedContentForPrefix(java.lang.String headerNamePrefix)
Output getHeaderSections() content entries with key prefixes that match headerNamePrefix (if it has not already been output) |
protected void |
getNamedResourceContent(java.lang.String headerNameMatch,
boolean headerNameMatchPrefixOnly,
java.lang.StringBuffer header)
|
protected java.util.HashMap |
getNamedResourcesAlreadyOutput()
|
java.lang.String |
getPortalBaseUrl()
Portal base url ( e.g. |
java.lang.String |
getPortalBaseUrl(boolean encode)
Portal base url ( e.g. |
java.lang.String |
getPortalResourceUrl(java.lang.String relativePath)
Portal base url with relativePath argument appended ( e.g. |
java.lang.String |
getPortalResourceUrl(java.lang.String relativePath,
boolean encode)
Portal base url with relativePath argument appended ( e.g. |
java.lang.String |
getPortalUrl()
Portal base servlet url ( e.g. |
java.lang.String |
getPortalUrl(boolean encode)
Portal base servlet url ( e.g. |
java.lang.String |
getPortalUrl(java.lang.String relativePath)
Portal base servlet url with relativePath argument appended ( e.g. |
java.lang.String |
getPortalUrl(java.lang.String relativePath,
boolean encode)
Portal base servlet url with relativePath argument appended ( e.g. |
protected RequestContext |
getRequestContext()
|
java.lang.String |
getUnnamedContent()
Output all unnamed (getHeaderInfoSet()) content (that has not already been output) |
protected void |
getUnnamedContent(java.lang.StringBuffer header)
|
boolean |
hasHeaderSectionFragment(java.lang.String headerFragmentName)
Indicate whether value of headerFragmentName argument has been used to add to any getHeaderSections() content entry |
protected boolean |
hasHeaderSectionFragment(java.lang.String headerFragmentName,
boolean setToTrue)
|
boolean |
isDesktop()
Is request for /desktop rather than /portal |
boolean |
isHeaderSectionIncluded(java.lang.String headerName)
Indicate whether value of headerName is an included header section |
protected java.lang.String |
jetspeedGenerateBasetag()
|
protected void |
orderHeaderSection(java.lang.String headerName)
|
void |
setHeaderSectionRequiredFlag(java.lang.String headerName,
java.lang.String headerReqFlag)
Set the requiredflag of the getHeaderSections() content entry with a key that matches headerName argument to the value of the headerReqFlag argument |
void |
setHeaderSectionType(java.lang.String headerName,
java.lang.String headerType)
Set the type of the getHeaderSections() content entry with a key that matches headerName argument to the value of the headerType argument |
protected void |
setNamedResourcesAlreadyOutput(java.util.HashMap newOne)
|
java.lang.String |
toString()
Output all content (that has not already been output) |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected static final org.apache.commons.logging.Log log
protected static final java.lang.String EOL
protected static final java.lang.String UNNAMED_CONTENT_HEADER_NAME
| Constructor Detail |
|---|
public HeaderResourceImpl(RequestContext context)
context -
public HeaderResourceImpl(RequestContext context,
BasePortalURL baseUrlAccess,
boolean isDesktop,
java.util.Map headerConfiguration)
| Method Detail |
|---|
public java.lang.String getContent()
getContent in interface HeaderResourcepublic java.lang.String toString()
toString in interface HeaderResourcetoString in class java.lang.Objectpublic java.lang.String getUnnamedContent()
getUnnamedContent in interface HeaderResourcepublic java.lang.String getNamedContent()
getNamedContent in interface HeaderResourcepublic java.lang.String getNamedContent(java.lang.String headerName)
getNamedContent in interface HeaderResourcepublic java.lang.String getNamedContentForPrefix(java.lang.String headerNamePrefix)
getNamedContentForPrefix in interface HeaderResourceprotected void getUnnamedContent(java.lang.StringBuffer header)
protected void getNamedResourceContent(java.lang.String headerNameMatch,
boolean headerNameMatchPrefixOnly,
java.lang.StringBuffer header)
protected java.lang.String generateHeaderSection(java.lang.String headerName)
public void addHeaderSectionFragment(java.lang.String addToHeaderName,
java.lang.String text)
addHeaderSectionFragment in interface HeaderResource
public void addHeaderSectionFragment(java.lang.String headerFragmentName,
java.lang.String addToHeaderName,
java.lang.String text)
addHeaderSectionFragment in interface HeaderResource
protected void addHeaderSectionFragment(java.lang.String headerFragmentName,
java.lang.String addToHeaderName,
java.lang.String text,
boolean alreadyCheckedFragName)
public boolean hasHeaderSectionFragment(java.lang.String headerFragmentName)
hasHeaderSectionFragment in interface HeaderResource
protected boolean hasHeaderSectionFragment(java.lang.String headerFragmentName,
boolean setToTrue)
protected void orderHeaderSection(java.lang.String headerName)
public boolean isHeaderSectionIncluded(java.lang.String headerName)
isHeaderSectionIncluded in interface HeaderResourcepublic java.lang.String getHeaderSectionType(java.lang.String headerName)
getHeaderSectionType in interface HeaderResource
public void setHeaderSectionType(java.lang.String headerName,
java.lang.String headerType)
setHeaderSectionType in interface HeaderResourcepublic java.lang.String getHeaderSectionRequiredFlag(java.lang.String headerName)
getHeaderSectionRequiredFlag in interface HeaderResource
public void setHeaderSectionRequiredFlag(java.lang.String headerName,
java.lang.String headerReqFlag)
setHeaderSectionRequiredFlag in interface HeaderResourceprotected java.util.Map getHeaderSectionTypes(boolean create)
protected java.util.Map getHeaderSectionNames(boolean create)
protected java.util.List getHeaderSectionOrderList(boolean create)
public java.util.Map getHeaderDynamicConfiguration()
getHeaderDynamicConfiguration in interface HeaderResourceprotected java.util.Map getHeaderSections()
protected java.util.Map getHeaderSectionsAddedFragments()
protected java.util.Map getHeaderResourceRegistry()
protected RequestContext getRequestContext()
protected BasePortalURL getBaseUrlAccess()
public boolean isDesktop()
isDesktop in interface HeaderResourcepublic java.util.Map getHeaderConfiguration()
getHeaderConfiguration in interface HeaderResourceprotected java.util.HashMap getNamedResourcesAlreadyOutput()
protected void setNamedResourcesAlreadyOutput(java.util.HashMap newOne)
public java.lang.String getPortalBaseUrl()
getPortalBaseUrl in interface HeaderResourcepublic java.lang.String getPortalBaseUrl(boolean encode)
getPortalBaseUrl in interface HeaderResourcepublic java.lang.String getPortalResourceUrl(java.lang.String relativePath)
getPortalResourceUrl in interface HeaderResource
public java.lang.String getPortalResourceUrl(java.lang.String relativePath,
boolean encode)
getPortalResourceUrl in interface HeaderResourcepublic java.lang.String getPortalUrl()
getPortalUrl in interface HeaderResourcepublic java.lang.String getPortalUrl(boolean encode)
getPortalUrl in interface HeaderResourcepublic java.lang.String getPortalUrl(java.lang.String relativePath)
getPortalUrl in interface HeaderResource
public java.lang.String getPortalUrl(java.lang.String relativePath,
boolean encode)
getPortalUrl in interface HeaderResourceprotected java.lang.String jetspeedGenerateBasetag()
public void dojoAddCoreLibraryRequire(java.lang.String dojoRequire)
dojoAddCoreLibraryRequire in interface HeaderResourcepublic void dojoAddCoreLibraryRequires(java.lang.String dojoRequires)
dojoAddCoreLibraryRequires in interface HeaderResourcepublic void dojoAddModuleLibraryRequire(java.lang.String dojoRequire)
dojoAddModuleLibraryRequire in interface HeaderResourcepublic void dojoAddModuleLibraryRequires(java.lang.String dojoRequires)
dojoAddModuleLibraryRequires in interface HeaderResourcepublic void dojoAddBodyExpandStyle(boolean omitWindowScrollbars)
dojoAddBodyExpandStyle in interface HeaderResourcepublic void dojoEnable()
dojoEnable in interface HeaderResourceprotected void dojoDisable()
protected java.lang.String dojoGetPath()
protected void dojoAddRequire(java.lang.String dojoRequire,
java.lang.String addToHeaderName)
protected void dojoAddRequires(java.lang.String dojoRequires,
java.lang.String addToHeaderName)
protected java.lang.String dojoGeneratePreinit()
protected java.lang.String dojoGenerateInit()
protected java.lang.String dojoGenerateWriteincludes()
protected java.lang.String dojoGenerateBodyExpandStyle()
protected java.lang.String dojoGenerateBodyExpandNoScrollStyle()
public void addHeaderInfo(java.lang.String text)
HeaderResource
addHeaderInfo in interface HeaderResourcetext - content
public void addHeaderInfo(java.lang.String elementName,
java.util.Map attributes,
java.lang.String text)
HeaderResource
addHeaderInfo in interface HeaderResourceelementName - Tag's nameattributes - Tag's attributestext - Tag's content
public void addJavaScript(java.lang.String path,
boolean defer)
HeaderResource
addJavaScript in interface HeaderResourcepath - Javascript file pathdefer - defer attributes for <script> tag.public void addJavaScript(java.lang.String path)
HeaderResource
addJavaScript in interface HeaderResourcepath - Javascript file pathpublic void addStyleSheet(java.lang.String path)
HeaderResource
addStyleSheet in interface HeaderResourcepath - CSS file path
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||