Caplin Systems - JsDoc Reference

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

caplin
- chart
  - Chart
  - highchart
    - RangeUtility
    - SeriesUtility
  - Series
  - series
    - Adapter
    - SeriesListener
    - SeriesManager
    - SeriesRequest
  - service
    - ChartService
    - StreamLinkChartService
  - Study
  - study
    - Adapter
    - BollingerBand
    - ExponentialMovingAverage
    - Factory
    - MACD
    - SimpleMovingAverage
    - StudyListener
    - Volume
  - testing
    - ChartServiceStub
- component
  - comms
    - CommsChannelListener
    - InterComponentComms
    - OpenAjaxChannelSubscriptionHelper
  - Component
  - ComponentFactory
  - ComponentLifecycleEvents
  - composite
    - CompositeComponent
    - CompositeComponentController
    - CompositeComponentFactory
    - CompositeComponentFactoryProxy
  - contextmessage
    - PanelMessage
  - ErrorComponent
  - factory
    - ComponentFactory
  - frame
    - ComponentFrame
    - DialogFrame
    - FrameCreationListener
    - FrameManager
    - PanelFrame
  - InstrumentReceiver
  - menu
    - AbstractMenu
    - Menu
    - MenuChangeListener
    - MenuGroup
    - MenuItem
    - SubMenu
  - testing
    - ComponentFixture
    - ComponentModelFixture
- control
  - basic
    - BasicControl
    - ButtonControl
    - DropdownControl
    - ExpandableGridRowControl
    - ImageControl
    - ImageTextControl
    - InputControl
    - LatencyControl
    - MultiStreamTextControl
    - ProgressBarControl
    - ProgressGridCellControl
    - TextControl
  - complex
    - BaseInputControl
    - FilterInputControl
    - PipsControl
    - PriceControl
    - RangeInputControl
    - SpreadControl
  - composite
    - CompositeControl
  - Control
  - factory
    - ControlFramework
- core
  - AliasRegistry
  - ArrayUtility
  - ClassUtility
  - DelayedReadinessService
  - DelayedReadinessServiceListener
  - Error
  - event
    - EventHub
  - Formatter
  - JsonUtility
  - ListenerFactory
  - LocaleUtility
  - log
    - AbstractLogger
    - ConsoleLogger
    - Log
    - Logger
    - LogRecord
    - LogStoreService
    - StoreLogger
  - LogLevel
  - MapFactory
  - MapUtility
  - Number
  - Observable
    - FailedNotification
  - OrderedSet
  - Parser
  - scheduler
    - ThreadQueueListener
    - ThreadScheduler
    - ThreadVisualizer
  - Serializable
  - ServiceRegistry
  - SlidingWindow
  - StringUtility
  - Utility
  - ValidationResult
  - ValidationResultListener
  - Validator
  - validator
    - CommaSeparatedPropertiesValidator
    - JsonValidator
    - MapConfigKeyValidator
    - MapConfigRequiredKeysValidator
    - MapConfigUtility
    - MapConfigValueValidator
  - XmlParser
  - XmlSerializer
  - XmlUtility
- dom
  - alert
    - StandardAlertDispatcher
  - event
    - Event
      - MouseButtons
  - FileDownloader
  - FileDownloaderTarget
  - testing
    - ViewFixture
    - viewhandler
      - BackgroundImage
      - Blurred
      - BorderColor
      - BorderWidth
      - BottomMarginWidth
      - Checked
      - ChildrenCount
      - ClassName
      - Clicked
      - Color
      - DoesNotHaveClass
      - Enabled
      - Focused
      - FocusIn
      - FocusOut
      - HasClass
      - Height
      - IsVisible
      - LeftMarginWidth
      - MouseDown
      - MouseMove
      - MouseOut
      - MouseOver
      - MouseUp
      - OnKeyDown
      - OnKeyUp
      - Options
      - Readonly
      - RightClicked
      - RightMarginWidth
      - ScrolledHorizontal
      - ScrolledVertical
      - Selected
      - Text
      - Top
      - TopMarginWidth
      - TypedValue
      - Value
      - ViewFixtureHandler
      - Width
  - Utility
- element
  - buffer
    - DisplayBuffer
  - factory
    - DefaultRendererType
    - RendererFactory
  - Formatter
  - formatter
    - AmountFormatter
    - BondNotationFormatter
    - BracketsFormatter
    - CountdownFormatter
    - DateFormatter
    - DecimalFormatter
    - Fractional8thsFormatter
    - InvalidPriceFormatter
    - KeyValueFormatter
    - LeadingZeroFormatter
    - LocalisedAmountFormatter
    - LowerCaseFormatter
    - NullValueFormatter
    - PercentFormatter
    - RegExpFormatter
    - RoundingFormatter
    - SignificantFiguresFormatter
    - SnapshotMaturityDateFormatter
    - TemplateFormatter
    - ThousandsFormatter
    - TimeFormatter
    - TrimFormatter
    - TruncateDecimalFormatter
    - UpperCaseFormatter
  - Handler
  - handler
    - ChangeHandler
    - ClickHandler
    - EditHandler
    - grid
      - ClearFilterHandler
      - CombinedFilterHandler
    - ImageHoverHandler
    - ImagePressHandler
  - Parser
  - parser
    - AmountParser
    - BracketsParser
    - DateParser
    - KeyValueParser
    - LocalisedAmountParser
    - RegExpParser
    - ThousandsParser
    - UpperCaseParser
  - Renderer
  - renderer
    - BlankRenderer
    - CompositeRenderer
    - MultiStreamRenderer
    - SingleStreamRenderer
    - StreamRenderer
  - RendererEventListener
  - RendererFramework
  - Styler
  - styler
    - ArrowFlashStyler
    - ButtonStyler
    - ClassFlashStyler
    - ClassStyler
    - ClearableStyler
    - EllipsisStyler
    - FlashStyler
    - grid
      - ClearButtonStyler
    - NumericSignStyler
    - ProgressCellStyler
    - RateHistoryTooltipStyler
    - RegExpStyler
    - RemoveButtonStyler
    - TooltipStyler
  - testing
    - RendererFixture
    - RendererFixtureFactory
    - RendererModelFixture
- fx
  - presenter
    - CurrencyPairAutoCompleteProvider
    - FxCalendarDateField
    - TenorProperty
  - providers
    - PermissionedCurrencyPairService
    - PermissionedTenorService
    - WebServiceBusinessDateService
  - services
    - BusinessDateService
    - CurrencyPairService
    - TenorService
  - testing
    - BusinessDateGenerator
    - BusinessDateServiceFixture
    - BusinessDateServiceStub
    - CurrencyPairServiceStub
  - trademodel
    - FxTrade
    - FxTradeLeg
- grid
  - dataprovider
    - sljs
      - SLJSContainerDataProvider
  - DataProviderRowModel
  - decorator
    - ColumnHeaderMenuDecorator
    - ColumnMenuDecorator
    - ColumnReorderingDecorator
    - ColumnResizingDecorator
    - ColumnSortDecorator
    - ContainerExportDecorator
    - DragDecorator
    - DropDecorator
    - GridDecorator
    - GroupHeaderDecorator
    - HoverDecorator
    - LoadingDataDecorator
    - NoDataFoundBubbleMessageDecorator
    - RemoveRowDecorator
    - ResetColumnsDecorator
    - RowLoadingDecorator
    - ScrollTipDecorator
    - SelectionDecorator
    - StatusDecorator
  - DummyGridDataProvider
  - expandable
    - ContainerChildRowConfig
  - filter
    - FieldFilterExpression
      - Operator
    - FilterExpression
    - FilterExpressionAccessor
    - LogicalFilterExpression
      - Operator
    - QueryFilterExpression
    - QueryStringHelper
  - FilterConstraint
  - GridColumn
  - GridColumnFilter
  - GridColumnModel
  - GridColumnModelListener
  - GridComponentFactory
  - GridDataProvider
  - GridDataProviderListener
  - GridDataProviderSnapshotListener
  - GridRowModel
  - GridRowModelListener
  - GridRowSelectionModel
  - GridRowSelectionModelListener
  - GridScrollPane
  - GridView
  - GridViewListener
  - PersonalGridDataProvider
  - RowDataUnavailable
  - rowsource
    - LogRowSource
    - RowSource
    - RowSourceListener
  - sort
    - FieldSortRule
    - SortRule
  - SyntheticGridDataProvider
  - WebServiceGridDataProvider
- i18n
  - Translator
- layout
  - Layout
  - LayoutService
  - LayoutTemplate
  - testing
    - LayoutServiceStub
    - LayoutStub
    - LayoutTemplateStub
  - workbench
    - LayoutManagerWorkbenchTool
- menu
  - Control
  - Generator
  - generator
    - Item
    - Menu
  - Model
  - model
    - Item
    - Menu
    - MenuFactory
  - presenter
    - Control
    - node
      - Menu
  - testing
    - MenuModelFixture
- popout
  - Popout
  - PopoutService
  - WindowService
- presenter
  - component
    - PresenterComponent
    - PresenterComponentFactory
  - control
    - ControlAdaptor
    - ControlAdaptorFactory
    - datefield
      - JQueryDatePickerControl
      - JQueryDatePickerControlAdaptor
    - InvalidControlModelError
    - selectionfield
      - CaplinToggleSwitchControl
      - ExtJsComboBoxControl
      - ExtJsComboBoxControlAdaptor
      - ExtJsSelectBoxControl
      - ExtJsSelectBoxControlAdaptor
      - JQueryAutoCompleteControl
      - JQueryAutoCompleteControlAdapter
      - ToggleSwitchControl
    - tooltip
      - TooltipControl
  - domain
    - node
      - DealtCurrencySelectionField
      - FxTenor
      - PermissionOptionsNodeList
    - property
      - MessageServicePropertyFactory
      - PermissionProperty
  - node
    - AutoCompleteProvider
    - AutoCompleteSelectionField
    - Button
    - CalendarDateField
    - ComponentNode
    - DateField
    - DisplayField
    - Field
    - MappedNodeList
    - MultiSelectionField
    - NodeList
    - NodeListListener
    - Nodes
    - Option
    - OptionsNodeList
    - PresentationNode
    - SelectionField
    - TemplateAware
    - TemplateNode
    - ToolTipField
    - ToolTipNode
  - PresentationModel
  - PresenterComponentFactory
  - property
    - Alias
    - DelayedNotificationProperty
    - EditableProperty
    - ISODateProperty
    - Properties
    - Property
    - PropertyHelper
    - PropertyListener
    - Snapshot
    - WritableProperty
  - SerializablePresentationModel
  - testing
    - PresentationModelFixture
    - PresenterComponentFixture
  - util
    - ErrorMonitor
  - validator
    - CrossPropertyValidator
    - CrossValidationPropertyBinder
- security
  - permissioning
    - AbstractPermissionService
- services
  - AppService
  - ConfigService
  - ConnectionService
  - ConnectionServiceListener
  - HtmlResourceService
  - messaging
    - MessageService
    - PublishError
    - PublishListener
    - Subscription
    - SubscriptionError
    - SubscriptionListener
    - SubscriptionStatus
  - PreferencesService
  - providers
    - BrowserUserPromptService
    - CaplinAppService
    - CaplinConfigService
    - CaplinHtmlResourceService
    - CaplinXmlResourceService
    - OpenPermissionService
  - RttpCodes
  - security
    - PermissionKey
    - PermissionService
    - PermissionServiceListener
  - ServiceRegistryLoader
  - testing
    - AppServiceStub
    - ConfigServiceStub
    - ConnectionServiceFixture
    - ConnectionServiceStub
    - MessageServiceStub
    - PermissionServiceFixture
    - PermissionServiceStub
    - PreferencesServiceStub
    - RecordStub
    - StreamlinkFixture
    - StreamlinkServiceStub
    - SubscriptionStub
    - TestCaplinHtmlResourceService
    - TestCaplinXmlResourceService
    - TestServiceRegistryLoader
    - UserPromptServiceStub
    - UserServiceStub
  - UserPromptService
  - UserService
  - XmlResourceService
- sl4badapter
  - SL4BServiceRegistryLoader
- sljsadapter
  - providers
    - StreamLinkConnectionService
    - StreamLinkMessageService
    - StreamLinkPermissionService
    - StreamLinkSubscription
    - StreamLinkUserService
  - StreamLinkServiceRegistryLoader
- testing
  - AlertFixture
  - DataSubscriptionFixture
  - Fixture
  - fixture
    - TimeFixture
  - FixtureFactory
  - FixtureRegistry
  - Utils
- trading
  - derivation
    - Derivation
    - DerivationManager
    - SimpleDerivation
    - TierDerivation
  - grid
    - TradeModelRowSource
  - presenter
    - TradeModelPropertyFactory
  - restoration
    - TradeRestoredListener
    - TradeRestoreEvent
  - service
    - OnBehalfOfChangeListener
    - TOBOUserService
    - TOBOUserServiceListener
    - TOBOUserServiceProvider
    - TradePermissionService
    - TradeService
    - WorkbenchTradeService
  - statemachine
    - State
    - StateChangedListener
    - StateMachine
    - StateMachineFactory
    - StateModel
    - Transition
    - TransitionSource
    - TriggerActiveChangedListener
  - testing
    - InstrumentDataSubscriberStub
    - TOBOFixture
    - TOBOUserServiceStub
    - TradeMessageFixture
    - TradeMessageServiceStub
  - ticket
    - TicketLauncher
  - trademodel
    - AbstractTradeFactory
    - CaplinTradeRestorer
    - CaplinTradeService
    - DataChangedListener
    - DataFieldChangedListener
    - DataHolder
    - InstrumentDataSubscriber
    - InvalidServerEventListener
    - LegManager
    - StreamingInstrumentDataSubscriber
    - StreamlinkTradeRestorer
    - StructureChangedEvent
    - StructureChangedListener
    - StructureChangedType
    - SubjectMapper
    - Trade
    - TradeChannelMapper
    - TradeFactory
    - TradeFactoryListener
    - TradeFactoryRepository
    - TradeLeg
    - TradeLegFactory
    - TradeMessageService
    - TradeOnBehalfOf
    - TradeOnBehalfOfListener
    - TradingStatus
    - TradingStatusChangedListener
  - validation
    - AbstractFieldValidator
    - DateValidator
    - IntegerValidator
    - MaxTierLimitExceededValidator
    - NotEmptyValidator
    - OneOfValidator
    - PermissionValidator
    - TradingSystemAvailableValidator
    - ValidationResult
    - Validator
  - workbench
    - model
      - StateMachineMonitor
    - TradeStateVisualiser
    - ui
      - StateModelVisualiser
- webcentric
  - alert
    - WebcentricAlertDispatcher
  - frame
    - ComponentWrapper
  - layout
    - WebcentricLayout
    - WebcentricLayoutService
  - model
    - JSONAdaptor
    - XMLAdaptor
  - providers
    - WebcentricPreferencesService
- workbench
  - connectionstatuseditor
    - WorkbenchConnectionStatusEditor
  - messaging
    - MessageEditor
    - MessageEditorMainControl
    - MessageEditorPM
    - RecordNode
  - model
    - DataGenerator
    - MiniStateMachine
    - PriceGenerator
    - ToggleSlider
  - popout
    - PopoutTool
  - ui
    - QuickForm
    - Workbench
    - WorkbenchComponent
    - WorkbenchDataEditor
    - WorkbenchEventLogger
    - WorkbenchPanel
    - WorkbenchPermissionEditor

Class

caplin.services.providers

CaplinHtmlResourceService

Implements caplin.services.HtmlResourceService.

This class provides access to HTML templates loaded via the HTML bundler. This is the default Caplin HtmlResourceService

Constructor Summary

Attributes	Name and Description
	`caplin.services.providers.CaplinHtmlResourceService(String sUrl)`

Method Summary

Attributes	Name and Description
	`String getHTMLTemplate(String sTemplateId)` Access an HTML template by name.

Constructor Detail

► caplin.services.providers.CaplinHtmlResourceService(String sUrl)

Parameters

String

sUrl

A URL to load HTML from.

Method Detail

► String getHTMLTemplate(String sTemplateId)

Access an HTML template by name.

Parameters

String

sTemplateId

The identifier of the root element of the template you wish to retrieve.

Returns: The template HTML as a string.