com.plumtree.uiinfrastructure.editor
Class EditorView

java.lang.Object
  extended by com.plumtree.uiinfrastructure.editor.EditorView
All Implemented Interfaces:
IManagedObject, IMVCObject, IView
Direct Known Subclasses:
AccessibilityView, AccountLockingView, AddSettingsPluginView, AdminFolderAdvView, AdvSettingsPluginView, ApprovalView, ArchivingAgentView, AssocObjectsPluginView, AssocWebServicesView, AuditQueryResultView, AuthPartnerView, AuthSource2View, AuthSource3View, AuthSource4View, AuthSourceMainView, AuthSourceSelectAuthPartnerView, AuthSourceSelectWebServiceView, AutomationServerPopUpView, AWSSettingsPluginView, BannerFieldAliasView, BasicAuthPluginView, BestBetEditorView, BestBetsListView, CardEditorDocInfoView, CardEditorMainView, ChooseWSTypePluginView, ClearHistoryView, CommentView, CrawlerTagView, CrawlerThreadConfigView, CreateRuleView, CredentialVaultPluginView, CWSSettingsPluginView, DataSourceSelectWebServiceView, DebugConfigPluginView, DebuggingModeView, DebugPortletPluginView, DebugUserPluginView, DefaultLanguageSettingsView, DestFolderSettingsView, DevicesView, DirPrefsView, DisplayOptView, DisplayPrefsView, DocTypePlugInView, DSURLTypeView, DynamicMembersPreviewView, EditMyPagePortletLayoutView_D, EditorHeaderView, EditorLeftNavView, EODPortletPrefsNewCtgView, EODPortletPrefsRenameCtgView, ExcludedPageSettingsView, ExistingCardsView, ExpListView, ExportSettingsView, ExternalOperationEditorMainView, FeaturesView, FolderEditorACLPropagateView, FolderEditorDataSourceView, FolderEditorFilterSettingsView, FolderEditorMainView, FolderEditorSortingView, FormLoginPluginView, GatewayCachingPluginView, GatewaySettingsPluginView, GbDocTypeExtView, GeneralInfoView, GenInfoView, GenInfoView, GreetingView, GuestPasswordView, HeaderAndFooterSelectorView, HeadersView, HelpURLPluginView, HTTPSettingsPluginView, ImportingDocsView, ImportSettingsView, IndexingStatusPopUpView, IndexingStatusView, IntrinsicHelpSpacePluginView, IntrinsicPortletWSSettingsPluginView, IntrinsicPrefsEditorForPageletParametersView, IntrinsicProfilePluginView, IntrinsicUserPrefsPluginView, LayoutSelectionView, LayoutView, LinkSettingsPlugInView, LocaleSettingsView, LocalizedStringsView, LocationView, LockboxEditorPropertiesView, LockboxView, LocNamesPrimaryNameView, LoggingView, LoginFormSettingsView, LoginSettingsView, LoginView, MainView, MessageDeleteView, MessageTypesView, MigrationGeneralInfoView, MigrationHistoryView, MigrationLoadPackageView, MWSSettingsPluginView, NavigationView, NewUserCreationView, NoItemsView, NumericAuthenticationView, ObjectLockManagerView, ObjectOwnerView, OutgoingNSSelectWebServiceView, PageLayoutAlternateView, PageLayoutHeaderView, PageLayoutView, PageletParamsMapPluginView, PageNameView, PasswordRulesView, PasswordView, PChooseSelectionView, PickTableView, PortalURLsView, PortletPreferencesView, PortletSettingsView, PriorityDropDownView, ProfilePageListView_D, ProfileSourceSelectWebServiceView, PropertyMapEditorMainView, PropertyMapView, ProxyConfigView, PSelectTemplateView, PWSSettingsPluginView, RejectedDocsView, RemoteConfigPluginView, RemoteMigrationPluginView, RemotePageletPickerPluginView, RemoteServerPluginView, RemoteServerPropsView, ResultFormatView, RulesDebugModeView, SavedSearchPortletAdminPrefsView, SavSrchResultsView, ScheduleView, SearchCriteriaView, SearchServerSettingsEditorView, SearchServerSettingsPopUpView, SearchSettingsView, SelectDevicesPluginView, SelectWebServiceView, SettingsView, SettingsView, SettingsView, SettingsView, SettingsView, SiteMapCreateWebLinkView, SiteMapFolderPlugInView, SiteMapPortletPrefsView, SmartSortEditorMainView, SnapshotADConstraintsView, SnapshotKDConstraintsView, SnapshotQueryRangeView, SOAPCardSubmitAdvancedNameView, SOAPCardSubmitAdvancedURLView, SOAPEncodingPluginView, StylesheetView, SummaryURLPluginView, SWSSettingsPluginView, TargetSettingsView, TargetSiteView, ThesaurusSettingsView, TimeoutView, TimeoutView, TimesDatesView, UniqueKeyChooserView, UpdateLoginTokenKeyView, UserInfoPluginView, UserPrefsPluginView, WWWCardSubmitAdvancedNameView, WWWCardSubmitAdvancedURLView, XUIURLPluginView, XUIView

public abstract class EditorView
extends java.lang.Object
implements IView

This is the View class for the Editor Framework. It implements the Init method and should be extended by any View.

Author:
Julie Fournier

Field Summary
protected  AActivitySpace m_asOwner
          JF- Associated Activity Space
protected  IModelRO m_model
          JF- Associated read-only Model
static java.lang.String SPACE
          Constant for the HTML sign " ".
 
Constructor Summary
EditorView()
           
 
Method Summary
 void AddEmptyCellToRow(HTMLTableRow _myRow)
          Adds an empty Cell to the Row passed in argument.
 void AddEmptyCellToRow(HTMLTableRow _myRow, java.lang.String _sWidth)
          Adds an empty Cell of the specified width to the Row passed in argument.
 void AddEmptyRowToTable(HTMLTable _myTable)
          Adds an empty Row to the Table passed in argument.
 void AddEmptyRowToTable(HTMLTable _myTable, java.lang.String _sHeight)
          Adds an empty Row of the specified height to the Table passed in argument.
abstract  java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
abstract  HTMLElement Display()
          This method returns the HTMLElement that encompasses the output of the View.
 HTMLScript DisplayJavascript()
          This method returns the HTMLScript that encompasses the Javascript on the page.
 HTMLElement GetHeaderView(java.lang.String _sHeaderTitle)
          Returns the header for the view.
protected  HTMLElement GetHeaderViewHelper(AActivitySpace _asOwner, java.lang.String _sHeaderTitle)
          Returns the header for the View.
abstract  java.lang.String GetName()
          Returns the Class name.
static HTMLTable GetShortSpacerTable()
          Returns a short empty table.
static HTMLTable GetSpacerTable()
          Returns an empty table.
 void Init(IModelRO model, AActivitySpace parent)
          Inits the View with the read-only Model and the Activity Space.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SPACE

public static final java.lang.String SPACE
Constant for the HTML sign " ".

See Also:
Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner
JF- Associated Activity Space


m_model

protected IModelRO m_model
JF- Associated read-only Model

Constructor Detail

EditorView

public EditorView()
Method Detail

Create

public abstract java.lang.Object Create()
This method is used by the ASManager to return new instances of managed objects.

Specified by:
Create in interface IManagedObject
Returns:
A new instance of the managed class (i.e. return new Foo();)

GetName

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

Specified by:
GetName in interface IMVCObject
Returns:
String

GetShortSpacerTable

public static HTMLTable GetShortSpacerTable()
Returns a short empty table. This is the one you should use in your View, just below the View header (the one returned by GetHeaderView).

Returns:
HTMLTable

GetSpacerTable

public static HTMLTable GetSpacerTable()
Returns an empty table. This is the one used to separate each section in any Editor page. Note that this is a static method so you can also call it from any DP.

Returns:
HTMLTable

AddEmptyCellToRow

public void AddEmptyCellToRow(HTMLTableRow _myRow)
Adds an empty Cell to the Row passed in argument.

Parameters:
_myRow -

AddEmptyCellToRow

public void AddEmptyCellToRow(HTMLTableRow _myRow,
                              java.lang.String _sWidth)
Adds an empty Cell of the specified width to the Row passed in argument.

Parameters:
_myRow - _myRow
_sWidth - strWidth

AddEmptyRowToTable

public void AddEmptyRowToTable(HTMLTable _myTable)
Adds an empty Row to the Table passed in argument.

Parameters:
_myTable -

AddEmptyRowToTable

public void AddEmptyRowToTable(HTMLTable _myTable,
                               java.lang.String _sHeight)
Adds an empty Row of the specified height to the Table passed in argument.

Parameters:
_myTable - _myTable
_sHeight - strHeight

Display

public abstract HTMLElement Display()
This method returns the HTMLElement that encompasses the output of the View.

Specified by:
Display in interface IView
Returns:
HTMLElement

DisplayJavascript

public HTMLScript DisplayJavascript()
This method returns the HTMLScript that encompasses the Javascript on the page.

Specified by:
DisplayJavascript in interface IView
Returns:
HTMLScript
See Also:
IView.DisplayJavascript()

GetHeaderViewHelper

protected HTMLElement GetHeaderViewHelper(AActivitySpace _asOwner,
                                          java.lang.String _sHeaderTitle)
Returns the header for the View.

Parameters:
_asOwner - The Activity Space this view is using.
_sHeaderTitle - Title you want to display in the header.
Returns:
HTMLTable

GetHeaderView

public HTMLElement GetHeaderView(java.lang.String _sHeaderTitle)
Returns the header for the view. In the case that your Activity Space is not extended from EditorAS, but your view is, you will need to overwrite GetHeaderView with this same code, with the exception that you will be passing your m_asOwner. In here, the m_asOwner is expected to be of type EditorAS.

Parameters:
_sHeaderTitle - Title you want to display in the header.
Returns:
HTMLTable

Init

public void Init(IModelRO model,
                 AActivitySpace parent)
Inits the View with the read-only Model and the Activity Space.

Specified by:
Init in interface IView
Parameters:
model -
parent -



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