com.plumtree.uiinfrastructure.editor
Class EditorDP

java.lang.Object
  extended by com.plumtree.uiinfrastructure.form.AFormDP
      extended by com.plumtree.uiinfrastructure.editor.EditorDP
All Implemented Interfaces:
IDisplayPage, IMVCObject
Direct Known Subclasses:
ABOBlankResultsDP, ABOBlankSelectDP, ABOSubBlankResultsDP, AdaptiveLayoutsListDP, AdminFolderAdvDP, AdvancedSettingsDP, AdvSettingsDP, AMainDP, AssociatedObjectsDP, AuditManagerDP, AuditQueryCentralDP, AuditQueryResultDP, AuthSource2DP, AuthSource3DP, AuthSource4DP, AuthSourceMainDP, AutomationServerDP, AutomationServerPopUpDP, BannerFieldAliasDP, BestBetEditorDP, BestBetsListDP, CardEditorLinkSettingsDP, CardEditorMainDP, CommentDP, CommunityEditorCommGroupDP, CommunityEditorCommPortletDP, CommunityEditorPagesDP, CommunityEditorPortletPreferencesDP, CommunityEditorSubcommunityDP, CommunitySelectionDP, CommunitySelectionDP_D, CommunityTemplateCommunitiesDP, CommunityTemplateMainDP, CookieDP, CredentialVaultManagerMainDP, CustomActivityDP, DevicesDP, DirDataSourceDP_D, DirPrefsDP, DirSubmitCardDP_D, DirSubmitDoneDP_D, DocTypeDP, DocumentApprovalDP, DSMainDP, DynamicLoadsDP, EditMyPagePortletLayoutDP_D, EditMyPortalPageDP, EditPortletPrefsDP, EODPortletPrefsLocNamesDP, EODPortletPrefsMainDP, EODPortletPrefsMoveCtgDP, EODPortletPrefsNewCtgDP, EODPortletPrefsRenameCtgDP, ExternalOperationEditorMainDP, FolderEditorACLPropagateDP, FolderEditorAdvancedSettingsDP, FolderEditorMainDP, FolderEditorRelatedResourcesDP, GbDocTypeExtDP, GbDocTypeMainDP, GeneralProfileDP, GeneralSettingsDP, GroupActivityRightsDP, GroupDynamicRulesDP, GroupMainSettingsDP, GroupMapDP, HeaderAndFooterSelectorDP, HeadersDP, HistoryDP, IndexingStatusDP, IndexingStatusPopUpDP, IntrinsicPrefsEditorForPageletParametersDP, JobFoldersDP, JobHistoriesDP, LayoutSelectionDP, LinkSettingsDP, LocaleSettingsDP, LocalizedStringsDP, LockboxEditorLocNamesDP, LocNamesDP, LoginFormDP, MainActivityRightsDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MainDP, MigrationAddExistingPackageDP, MigrationDependenciesDP, MigrationExportMainDP, MigrationExportPortalResourcesDP, MigrationHistoryDP, MigrationHistoryPluginDP, MigrationImportMainDP, MigrationImportPortalResourcesDP, MultipleCardLinkSettingsMainDP, NoItemsDP, ObjectApprovalDP, ObjectApprovalStatusDP, ObjectSecurityDP, ObjPropMapDP, PageMainDP, PageTemplateDefaultPageNameDP, PageTemplateMainDP, PageTemplatePagesDP, PasswordDP, PortalURLsDP, PortletBundleMainDP, PortletInBundleSelectionDP, PortletListDP, PortletSelectionDP, PortletSelectionDP_D, PPluginDP, ProfilePageListDP_D, PropertyMapDP, PropertyMapEditorMainDP, ProxyConfigDP, RelatedServersListDP, RemoteHostsListDP, ResultFormatDP, RuleEditorMainDP, SavedSearchPortletPrefsDP, SavSrchMainDP, SavSrchResultDP, SearchServerSettingsEditorDP, SearchServerSettingsPopUpDP, SearchServerTuningEditorDP, SearchSettingsDP, SecurityMatrixDP, SetJobDP, SiteMapFolderEditLinksDP, SiteMapPortletPrefsDP, SmartSortEditorMainDP, SOAPCardSubmitAdvancedMainDP, SOAPCardSubmitAdvancedNameDP, SubPortalBannerDP, SubPortalFeaturesDP, SubPortalLayoutDP, SubPortalLoginDP, SubPortalNavDP, SubportalRulesManagerFolderDP, SubportalRulesManagerGuestDP, SubportalRulesManagerMainDP, SubscribeMatrixDP, TagLibDP, TargetSettingsDP, ThesaurusSettingsDP, UnsubscribeCommunitiesDP, UserSettingsDP, WebPageExcDP, WSPluginDP, WWWCardSubmitAdvancedMainDP, WWWCardSubmitAdvancedNameDP, XUIDP

public abstract class EditorDP
extends AFormDP

This is class is used to print out the form tag, some hidden input and the postToSelf Javascript function. Editor display pages should extend this class.

Author:
Julie Fournier

Field Summary
protected  EditorAS m_asOwner
          JF- Associated AS class.
 
Fields inherited from class com.plumtree.uiinfrastructure.form.AFormDP
GET, HTMLFORM_NAME, JAVASCRIPT_SETUP_FOR_SUBMIT_TO_CONTROL, JAVASCRIPT_SUBMIT_FORM, JAVASCRIPT_SUBMIT_TO_CONTROL, MULTIPART_ENCODING, POST
 
Constructor Summary
EditorDP()
           
 
Method Summary
 void AddScriptToHead(HTMLScript _script)
          Add some JavaScript dynamically to this DP.
 HTMLTable CreateContentTable(HTMLElement _Views, java.lang.String _sSubHeaderTitle)
          Creates the content table without the left nav bar.
 HTMLTable CreateLeftNavBar(HTMLElement _Views)
          Creates a table with the left nav bar and puts innerElement next to the left nav bar.
 HTMLElementCollection DisplayHTMLBeforeForm()
          This is a method that classes extending this one can over write.
protected  HTMLScriptCollection DisplayJavaScriptFromChild()
          Display the Javascripts for the Views.
protected  java.lang.String GetEditorHeaderViewName()
          This is a hook to allow editors to supply a different header view if necessary.
 java.lang.String GetFormTitle()
          Returns the Browser title.
protected  HTMLElement GetHTMLBelowSubHeader()
          Implement this method to add HTML below the sub header.
abstract  java.lang.String GetLeftNavString()
          Returns the String to display on the left navigation menu, linking to that page.
abstract  java.lang.String GetName()
          Returns the Class name.
 AActivitySpace GetOwner()
          Returns the associated activity space class.
 java.lang.String GetPageTitle()
          Returns the page title.
 void Init(AActivitySpace parent)
          Inits the class with the associated activity space passed in argument.
 HTMLElement PageDisplay()
          Returns the HTML for that Page.
 void SetContentTableCellSpacing(java.lang.String _sContentTableCellSpacing)
          This method lets you set the cellspacing value for the content table.
 
Methods inherited from class com.plumtree.uiinfrastructure.form.AFormDP
AddToValidationFunction, Display, DisplayForm, DisplayHTMLAfterForm, DisplayHTMLinHEAD, DisplayJavascript, Get508RepostURL, GetCloseOnCancel, GetFormPageType, GetOnLoad, GetRepostControlName, GetRepostTypeIsPost, GetStatusViewEnabled, GetStatusViewRepostValues, GetUseJavascript, GetWindowFocusEnabled, InsertJavascriptBeforeFormSubmit, PartialContentDisplay, RemoveFromValidationFunction, SetMultiPartEncoding, SetShow508FormFooter, SetStatusViewEnabled, SetStatusViewRepostValues
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_asOwner

protected EditorAS m_asOwner
JF- Associated AS class.

Constructor Detail

EditorDP

public EditorDP()
Method Detail

GetLeftNavString

public abstract java.lang.String GetLeftNavString()
Returns the String to display on the left navigation menu, linking to that page.

Returns:
String

GetName

public abstract java.lang.String GetName()
Returns the Class name.

Specified by:
GetName in interface IMVCObject
Specified by:
GetName in class AFormDP
Returns:
String
See Also:
IMVCObject.GetName()

AddScriptToHead

public void AddScriptToHead(HTMLScript _script)
Add some JavaScript dynamically to this DP. This is a "one time" JavaScript. It will be deleted after it's printed out. For example, can be used to open another window.

Parameters:
_script - the script to add to the page

CreateContentTable

public HTMLTable CreateContentTable(HTMLElement _Views,
                                    java.lang.String _sSubHeaderTitle)
Creates the content table without the left nav bar.

Parameters:
_Views -
_sSubHeaderTitle - Title for the sub header. Pass in null if you don't want the sub header. Warning: if you pass in null, any code from GetHTMLBelowSubHeader will not be displayed either.
Returns:
HTMLTable

CreateLeftNavBar

public HTMLTable CreateLeftNavBar(HTMLElement _Views)
Creates a table with the left nav bar and puts innerElement next to the left nav bar.

Parameters:
_Views -
Returns:
HTMLTable

DisplayHTMLBeforeForm

public HTMLElementCollection DisplayHTMLBeforeForm()
Description copied from class: AFormDP
This is a method that classes extending this one can over write. The HTML returned by that method will get printed out before the FORM tag and AFTER the BODY tag. E.g.: DIV tags should go in that method. Override this method to display HTML after the body and before the form.

Overrides:
DisplayHTMLBeforeForm in class AFormDP
Returns:
HTMLElement
See Also:
AFormDP.DisplayHTMLBeforeForm()

GetFormTitle

public java.lang.String GetFormTitle()
Returns the Browser title. For the Editor Framework, the browser title is the same as the left navigation String of the current page.

Specified by:
GetFormTitle in class AFormDP
Returns:
String

GetPageTitle

public java.lang.String GetPageTitle()
Returns the page title. By default it is the same as the left navigation string.

Returns:
String

GetOwner

public AActivitySpace GetOwner()
Returns the associated activity space class.

Specified by:
GetOwner in interface IDisplayPage
Overrides:
GetOwner in class AFormDP
Returns:
AActivitySpace
See Also:
IDisplayPage.GetOwner()

Init

public void Init(AActivitySpace parent)
Inits the class with the associated activity space passed in argument.

Specified by:
Init in interface IDisplayPage
Overrides:
Init in class AFormDP
Parameters:
parent -
See Also:
IDisplayPage.Init(AActivitySpace)

PageDisplay

public HTMLElement PageDisplay()
Returns the HTML for that Page.

Specified by:
PageDisplay in class AFormDP
Returns:
HTMLElement
See Also:
com.plumtree.uiinfrastructure.activityspace.AFormDP#PageDisplay(HTMLTableRow)

GetEditorHeaderViewName

protected java.lang.String GetEditorHeaderViewName()
This is a hook to allow editors to supply a different header view if necessary. The editor returned here must be a subclass EditorHeaderView.

Returns:
String

SetContentTableCellSpacing

public void SetContentTableCellSpacing(java.lang.String _sContentTableCellSpacing)
This method lets you set the cellspacing value for the content table. This is optional. The default is 15 and will work for most of Editors. However, if you want to get rid of the empty space on the left and right sides of the table, you might want to set it to 0.

Parameters:
_sContentTableCellSpacing -

DisplayJavaScriptFromChild

protected HTMLScriptCollection DisplayJavaScriptFromChild()
Display the Javascripts for the Views.

Overrides:
DisplayJavaScriptFromChild in class AFormDP
Returns:
HTMLScriptCollection

GetHTMLBelowSubHeader

protected HTMLElement GetHTMLBelowSubHeader()
Implement this method to add HTML below the sub header.

Returns:
HTMLElement



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.