| org.sakaiproject.cheftool.VelocityPortletPaneledAction
 org.sakaiproject.web.tool.IFrameAction
| IFrameAction | | public class IFrameAction extends VelocityPortletPaneledAction (Code) | |
IFrameAction is the Sakai tool to place any web content in an IFrame on the page.
Three special modes are supported - these pick the URL content from special places:
- "site" - to show the services "server.info.url" configuration URL setting
- "workspace" - to show the configured "myworkspace.info.url" URL, introducing a my workspace to users
- "worksite" - to show the current site's "getInfoUrlFull()" setting
|
| Field Summary | |
| final protected static String | CUSTOM_HEIGHT
| | final protected static String | HEIGHT
The height, in state, config and context. | | final protected static String | HIDE_OPTIONS
| | final protected static String | MACRO_SESSION_ID
| | final protected static String | MACRO_SITE_ID
| | final protected static String | MACRO_USER_EID
| | final protected static String | MACRO_USER_FIRST_NAME
| | final protected static String | MACRO_USER_ID
| | final protected static String | MACRO_USER_LAST_NAME
| | final protected static String | MACRO_USER_ROLE
| | final protected static String | SAKAI_PROPERTIES_URL_KEY
Support an external url defined in sakai.properties, in state, config and context. | | final protected static String | SOURCE
The source URL, in state, config and context. | | final protected static String | SPECIAL
The special attribute, in state, config and context. | | final protected static String | SPECIAL_SITE
Special value for site. | | final protected static String | SPECIAL_WORKSITE
Special value for worksite. | | final protected static String | SPECIAL_WORKSPACE
Special value for myworkspace. | | final protected static String | TITLE
The title, in state and context. | | final protected static String | URL
The value in state and context for the source URL to actually used, as computed from special and URL. | | final protected static String | VALID_DIGITS
| | public String[] | ourPixels
| | protected static ResourceLoader | rb
|
| Method Summary | |
| public String | buildMainPanelContext(VelocityPortlet portlet, Context context, RunData rundata, SessionState state)
Setup the velocity context and choose the template for the response. | | public String | buildOptionsPanelContext(VelocityPortlet portlet, Context context, RunData data, SessionState state)
Setup the velocity context and choose the template for options. | | protected String | convertReferenceUrl(String url)
If the url is a valid reference, convert it to a URL, else return it unchanged. | | public void | doCancel(RunData data, Context context)
| | public void | doConfigure_update(RunData data, Context context)
| | protected String | getCurrentSitePageId()
Get the current site page our current tool is placed on. | | protected void | initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)
| | protected String | sourceUrl(String special, String source, String context, boolean macroExpansion, boolean passPid, String pid, String sakaiPropertiesUrlKey)
|
| CUSTOM_HEIGHT | | final protected static String CUSTOM_HEIGHT(Code) | | The custom height from user input *
|
| HEIGHT | | final protected static String HEIGHT(Code) | | The height, in state, config and context.
|
| HIDE_OPTIONS | | final protected static String HIDE_OPTIONS(Code) | | If set, always hide the OPTIONS button
|
| MACRO_SESSION_ID | | final protected static String MACRO_SESSION_ID(Code) | | Macro name: Session
|
| MACRO_SITE_ID | | final protected static String MACRO_SITE_ID(Code) | | Macro name: Site id (GUID)
|
| MACRO_USER_EID | | final protected static String MACRO_USER_EID(Code) | | Macro name: User enterprise id
|
| MACRO_USER_FIRST_NAME | | final protected static String MACRO_USER_FIRST_NAME(Code) | | Macro name: First name
|
| MACRO_USER_ID | | final protected static String MACRO_USER_ID(Code) | | Macro name: User id
|
| MACRO_USER_LAST_NAME | | final protected static String MACRO_USER_LAST_NAME(Code) | | Macro name: Last name
|
| MACRO_USER_ROLE | | final protected static String MACRO_USER_ROLE(Code) | | Macro name: Role
|
| SAKAI_PROPERTIES_URL_KEY | | final protected static String SAKAI_PROPERTIES_URL_KEY(Code) | | Support an external url defined in sakai.properties, in state, config and context.
|
| SOURCE | | final protected static String SOURCE(Code) | | The source URL, in state, config and context.
|
| SPECIAL | | final protected static String SPECIAL(Code) | | The special attribute, in state, config and context.
|
| SPECIAL_SITE | | final protected static String SPECIAL_SITE(Code) | | Special value for site.
|
| SPECIAL_WORKSITE | | final protected static String SPECIAL_WORKSITE(Code) | | Special value for worksite.
|
| SPECIAL_WORKSPACE | | final protected static String SPECIAL_WORKSPACE(Code) | | Special value for myworkspace.
|
| TITLE | | final protected static String TITLE(Code) | | The title, in state and context.
|
| URL | | final protected static String URL(Code) | | The value in state and context for the source URL to actually used, as computed from special and URL.
|
| VALID_DIGITS | | final protected static String VALID_DIGITS(Code) | | Valid digits for custom height from user input *
|
| ourPixels | | public String[] ourPixels(Code) | | Choices of pixels displayed in the customization page
|
| convertReferenceUrl | | protected String convertReferenceUrl(String url)(Code) | | If the url is a valid reference, convert it to a URL, else return it unchanged.
|
| doCancel | | public void doCancel(RunData data, Context context)(Code) | | doCancel called for form input tags type="submit" named="eventSubmit_doCancel" cancel the options process
|
| doConfigure_update | | public void doConfigure_update(RunData data, Context context)(Code) | | Handle the configure context's update button
|
| getCurrentSitePageId | | protected String getCurrentSitePageId()(Code) | | Get the current site page our current tool is placed on.
The site page id on which our tool is placed. |
| sourceUrl | | protected String sourceUrl(String special, String source, String context, boolean macroExpansion, boolean passPid, String pid, String sakaiPropertiesUrlKey)(Code) | | Compute the actual URL we will used, based on the configuration special and source URLs
|
| Methods inherited from org.sakaiproject.cheftool.VelocityPortletPaneledAction | protected void actionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
public static void addAlert(SessionState state, String message)(Code)(Java Doc)
protected void addOptionsMenu(Menu bar, JetspeedRunData data)(Code)(Java Doc)
protected boolean allowedToOptions()(Code)(Java Doc)
protected void cancelOptions()(Code)(Java Doc)
protected String clientWindowId(SessionState state, String toolId)(Code)(Java Doc)
public static void disableObservers(SessionState state)(Code)(Java Doc)
protected void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException(Code)(Java Doc)
public void doOptions(RunData runData, Context context)(Code)(Java Doc)
public void doReset(RunData runData, Context context)(Code)(Java Doc)
public static void enableObservers(SessionState state)(Code)(Java Doc)
protected Map getContext(RunData data)(Code)(Java Doc)
protected void helperActionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res, String className)(Code)(Java Doc)
protected void initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)(Code)(Java Doc)
protected void initState(SessionState state, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
public static void justDelivered(SessionState state)(Code)(Java Doc)
public static String mainPanelUpdateId(String toolId)(Code)(Java Doc)
protected String panelMethodName(String panel)(Code)(Java Doc)
public void processAction(HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void resetTool(SessionState state)(Code)(Java Doc)
protected void saveOptions()(Code)(Java Doc)
protected void scheduleFocusRefresh(String[] path)(Code)(Java Doc)
protected void schedulePeerFrameRefresh(String id)(Code)(Java Doc)
protected void scheduleTopRefresh()(Code)(Java Doc)
protected void setVmCourier(HttpServletRequest request, int refresh)(Code)(Java Doc)
protected void setVmStdRef(HttpServletRequest request, HttpServletResponse response)(Code)(Java Doc)
public static String titlePanelUpdateId(String toolId)(Code)(Java Doc)
protected void toolModeDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res) throws ToolException(Code)(Java Doc)
protected void updateState(SessionState state, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
|
|
|