| org.netbeans.modules.visualweb.project.jsf.api.JsfPortletSupport
All known Subclasses: org.netbeans.modules.visualweb.project.jsf.api.JsfPortletSupportImpl,
| JsfPortletSupport | | public interface JsfPortletSupport (Code) | |
author:
dey, David Botterill |
| Method Summary | |
| public String | getInitialPage(PortletModeType inMode)
This method return the page for the given initial mode.
Parameters:
inMode - The PortletModeType to check for the initial page.
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if inMode == null returns a String representing the portlet page for the given mode. | | public File | getPortletDD()
This method returns the portlet.xml file for the current project. | | public PortletModeType | getPortletMode(FileObject inFileObject)
This method will check whether a given page is an initial page for any mode.
Parameters:
inFileObject - The FileObject of the file to set check as the initial page. | | public String | getPortletPageFolderPath(FileObject inFO)
This method returns the relative path of the folder for the given portlet page. | | public boolean | isInitialPage(PortletModeType inMode, FileObject inFileObject)
This method will check whether a given page is the initial page for a given mode. | | public void | setInitialPage(PortletModeType inMode, FileObject inFileObject)
This method will set the initial page for the portlet. | | public void | setInitialPage(PortletModeType inMode, String inFilePath)
This method will set the initial page for the portlet.
Parameters:
inMode - The PortletModeType to set the initial page for
Parameters:
inFilePath - The path of the file using the context relative path. | | public void | setPortletName(String oldName, String newName)
| | public void | unsetInitialPage(FileObject inFileObject)
This method will unset the given initial page to no initial page. |
| getInitialPage | | public String getInitialPage(PortletModeType inMode) throws JsfPortletSupportException(Code) | | This method return the page for the given initial mode.
Parameters:
inMode - The PortletModeType to check for the initial page.
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if inMode == null returns a String representing the portlet page for the given mode. For example,if "PortletPage1.jsp" is the page for a given mode, "/PortletPage1.jsp" would be returned. |
| getPortletDD | | public File getPortletDD() throws JsfPortletSupportException(Code) | | This method returns the portlet.xml file for the current project.
File representing the "portlet.xml" file for the project.
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if the portlet.xml file can not be found. |
| getPortletMode | | public PortletModeType getPortletMode(FileObject inFileObject) throws JsfPortletSupportException(Code) | | This method will check whether a given page is an initial page for any mode.
Parameters:
inFileObject - The FileObject of the file to set check as the initial page. the PortletModeType the page is the initial page for. If the page is not an initial page,null is returned.
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if inMode or inFileObject == null |
| getPortletPageFolderPath | | public String getPortletPageFolderPath(FileObject inFO)(Code) | | This method returns the relative path of the folder for the given portlet page.
Parameters:
inFO - is the FileObject of the JSP page to get the relative Folder path for. |
| isInitialPage | | public boolean isInitialPage(PortletModeType inMode, FileObject inFileObject) throws JsfPortletSupportException(Code) | | This method will check whether a given page is the initial page for a given mode.
Parameters:
inMode - The PortletModeType to check for the initial page.
Parameters:
inFileObject - The FileObject of the file to set check as the initial page.
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if inMode or inFileObject == null returns boolean true= the portlet page is the initial page for the given mode,false= the portlet page is NOT |
| setInitialPage | | public void setInitialPage(PortletModeType inMode, FileObject inFileObject) throws JsfPortletSupportException(Code) | | This method will set the initial page for the portlet.
Parameters:
inMode - The PortletModeType to set the initial page for
Parameters:
inFileObject - The FileObject of the file to set as the inital VIEW Page.
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if inMode or inFileObject == null |
| setInitialPage | | public void setInitialPage(PortletModeType inMode, String inFilePath) throws JsfPortletSupportException(Code) | | This method will set the initial page for the portlet.
Parameters:
inMode - The PortletModeType to set the initial page for
Parameters:
inFilePath - The path of the file using the context relative path. The path should include the leading "/".
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if inMode or inFilePath == null |
| setPortletName | | public void setPortletName(String oldName, String newName) throws JsfPortletSupportException(Code) | | This method will set the portlet name
Parameters:
oldName - the current name of the portlet to change.
Parameters:
newName - the new name to give to the portlet.
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if oldName or newName == null |
| unsetInitialPage | | public void unsetInitialPage(FileObject inFileObject) throws JsfPortletSupportException(Code) | | This method will unset the given initial page to no initial page.
Parameters:
inFileObject - The FileObject of the file to set as the inital VIEW Page.
throws:
org.netbeans.modules.visualweb.project.jsf.JsfPortletSupportException - thrown if inFileObject == null |
|
|