@sitevision/api 2.0.0-alpha.1 → 2.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. package/index.d.ts +8 -0
  2. package/package.json +1 -1
  3. package/server/AliasUtil/index.d.ts +13 -11
  4. package/server/ArchiveUtil/index.d.ts +45 -43
  5. package/server/ArraysInstance/index.d.ts +1667 -1808
  6. package/server/ArticleUtil/index.d.ts +294 -226
  7. package/server/AuthenticationUtil/index.d.ts +73 -85
  8. package/server/BookmarkUtil/index.d.ts +76 -81
  9. package/server/BuddyIconRenderer/index.d.ts +124 -132
  10. package/server/BuddyIconRenderer.BuddyIconSize/index.d.ts +41 -0
  11. package/server/BuddyIconRenderer.BuddyIconSize/index.js +25 -0
  12. package/server/ClientUtil/index.d.ts +11 -9
  13. package/server/CollaborationFactory/index.d.ts +37 -40
  14. package/server/CollaborationGroupFolderUtil/index.d.ts +30 -28
  15. package/server/CollaborationGroupState/index.d.ts +27 -0
  16. package/server/CollaborationGroupState/index.js +11 -0
  17. package/server/CollaborationGroupTemplateUtil/index.d.ts +48 -50
  18. package/server/CollaborationGroupType/index.d.ts +28 -0
  19. package/server/CollaborationGroupType/index.js +12 -0
  20. package/server/CollaborationGroupUtil/index.d.ts +86 -82
  21. package/server/CollectionsInstance/index.d.ts +642 -705
  22. package/server/ColorUtil/index.d.ts +36 -37
  23. package/server/CompoundAndFilterBuilder/index.d.ts +31 -29
  24. package/server/CompoundComparatorBuilder/index.d.ts +35 -33
  25. package/server/CompoundOrFilterBuilder/index.d.ts +31 -29
  26. package/server/ContentNodeUtil/index.d.ts +36 -34
  27. package/server/CurrencyFactory/index.d.ts +72 -70
  28. package/server/DateUtil/index.d.ts +132 -142
  29. package/server/DecorationUtil/index.d.ts +13 -11
  30. package/server/DeviceUtil/index.d.ts +21 -19
  31. package/server/DimensionMode/index.d.ts +17 -0
  32. package/server/DimensionMode/index.js +12 -0
  33. package/server/DirectoryUtil/index.d.ts +90 -88
  34. package/server/DocType/index.d.ts +30 -0
  35. package/server/DocType/index.js +14 -0
  36. package/server/DocTypeUtil/index.d.ts +129 -135
  37. package/server/EndecUtil/index.d.ts +330 -347
  38. package/server/ExtendedDismaxParserBuilder/index.d.ts +156 -170
  39. package/server/FileIconRenderer/index.d.ts +153 -172
  40. package/server/FileUtil/index.d.ts +274 -300
  41. package/server/FilterBuilder/index.d.ts +42 -40
  42. package/server/FolderUtil/index.d.ts +93 -94
  43. package/server/FontUtil/index.d.ts +36 -37
  44. package/server/FormatterBuilderFactory/index.d.ts +76 -84
  45. package/server/HighlightBuilder/index.d.ts +79 -86
  46. package/server/IconUtil/index.d.ts +27 -25
  47. package/server/ImageLinkRenderer/index.d.ts +34 -32
  48. package/server/ImageRenderer/index.d.ts +343 -379
  49. package/server/ImageUtil/index.d.ts +247 -265
  50. package/server/IndexUtil/index.d.ts +40 -37
  51. package/server/IndexUtil.IndexType/index.d.ts +29 -0
  52. package/server/IndexUtil.IndexType/index.js +13 -0
  53. package/server/IndexingUtil/index.d.ts +69 -47
  54. package/server/InstanceCreatorUtil/index.d.ts +421 -457
  55. package/server/InstanceTypeUtil/index.d.ts +168 -189
  56. package/server/JwtUtil/index.d.ts +131 -129
  57. package/server/LandingPageUtil/index.d.ts +84 -87
  58. package/server/LandingPageUtil/index.js +1 -0
  59. package/server/LinkPageUtil/index.d.ts +297 -251
  60. package/server/LinkRenderer/index.d.ts +651 -715
  61. package/server/LinkTargetBuilder/index.d.ts +69 -77
  62. package/server/LinkValueBuilder/index.d.ts +70 -77
  63. package/server/ListWrapper/index.d.ts +82 -91
  64. package/server/LocaleUtil/index.d.ts +382 -394
  65. package/server/LogUtil/index.d.ts +119 -128
  66. package/server/MailBuilder/index.d.ts +109 -124
  67. package/server/MailUtil/index.d.ts +58 -63
  68. package/server/MathInstance/index.d.ts +625 -657
  69. package/server/MessageDigesterFactory/index.d.ts +30 -28
  70. package/server/MetadataDefinitionUtil/index.d.ts +79 -83
  71. package/server/MetadataUtil/index.d.ts +322 -346
  72. package/server/MimeTypeUtil/index.d.ts +209 -215
  73. package/server/MonitorBuilder/index.d.ts +20 -20
  74. package/server/NodeComparatorUtil/index.d.ts +215 -225
  75. package/server/NodeFactoryUtil/index.d.ts +18 -16
  76. package/server/NodeFilterUtil/index.d.ts +652 -739
  77. package/server/NodeIteratorUtil/index.d.ts +214 -229
  78. package/server/NodeResolverUtil/index.d.ts +400 -406
  79. package/server/NodeTreeUtil/index.d.ts +214 -229
  80. package/server/NodeTypeUtil/index.d.ts +1432 -548
  81. package/server/OfflineVersionPropertyUtil/index.d.ts +8 -6
  82. package/server/OnlineVersionPropertyUtil/index.d.ts +8 -6
  83. package/server/OutputUtil/index.d.ts +385 -380
  84. package/server/PageUtil/index.d.ts +266 -188
  85. package/server/PermissionUtil/index.d.ts +393 -430
  86. package/server/PermissionUtil.Permission/index.d.ts +54 -0
  87. package/server/PermissionUtil.Permission/index.js +38 -0
  88. package/server/PortletContextUtil/index.d.ts +112 -107
  89. package/server/PortletUtil/index.d.ts +32 -22
  90. package/server/PrincipalUtil/index.d.ts +35 -33
  91. package/server/Properties/index.d.ts +69 -76
  92. package/server/PropertyUtil/index.d.ts +1422 -1464
  93. package/server/PublishingUtil/index.d.ts +248 -249
  94. package/server/QueryStringUtil/index.d.ts +404 -415
  95. package/server/RedirectUtil/index.d.ts +64 -68
  96. package/server/RelatedValueBuilder/index.d.ts +45 -43
  97. package/server/Requester/index.d.ts +125 -125
  98. package/server/ResourceLocatorUtil/index.d.ts +436 -476
  99. package/server/RestApi/index.d.ts +158 -138
  100. package/server/RestAppInvokerFactory/index.d.ts +28 -26
  101. package/server/RoleAssignmentBuilder/index.d.ts +39 -37
  102. package/server/RoleMatcherBuilder/index.d.ts +39 -37
  103. package/server/RoleUtil/index.d.ts +35 -37
  104. package/server/ScriptUtil/index.d.ts +458 -495
  105. package/server/SearchFactory/index.d.ts +90 -105
  106. package/server/SearchUtil/index.d.ts +75 -73
  107. package/server/SearcherBuilder/index.d.ts +117 -124
  108. package/server/Session/index.d.ts +261 -1103
  109. package/server/Session/index.js +1 -20
  110. package/server/SimpleUserUtil/index.d.ts +28 -29
  111. package/server/SiteCookieUtil/index.d.ts +152 -175
  112. package/server/SortBuilder/index.d.ts +27 -25
  113. package/server/SourceSetMode/index.d.ts +12 -0
  114. package/server/SourceSetMode/index.js +12 -0
  115. package/server/SpellCheckBuilder/index.d.ts +30 -30
  116. package/server/StandardParserBuilder/index.d.ts +36 -34
  117. package/server/StructureUtil/index.d.ts +85 -83
  118. package/server/SubscriberUtil/index.d.ts +60 -67
  119. package/server/SubscriptionUtil/index.d.ts +123 -130
  120. package/server/SystemUserUtil/index.d.ts +148 -146
  121. package/server/TagUtil/index.d.ts +115 -120
  122. package/server/TemplateUtil/index.d.ts +115 -120
  123. package/server/TemporaryFileNodeBuilder/index.d.ts +32 -30
  124. package/server/TemporaryNodeBuilder/index.d.ts +139 -177
  125. package/server/TextModuleRendererBuilder/index.d.ts +22 -20
  126. package/server/TimestampUtil/index.d.ts +103 -117
  127. package/server/TranslationUtil/index.d.ts +98 -104
  128. package/server/TrashcanUtil/index.d.ts +114 -117
  129. package/server/UserDataUtil/index.d.ts +110 -111
  130. package/server/UserFactory/index.d.ts +47 -54
  131. package/server/UserFieldRenderer/index.d.ts +120 -128
  132. package/server/UserIdentityUtil/index.d.ts +38 -36
  133. package/server/UserUtil/index.d.ts +32 -30
  134. package/server/Utils/index.d.ts +634 -723
  135. package/server/VelocityRenderer/index.d.ts +96 -94
  136. package/server/VersionUtil/index.d.ts +25 -9
  137. package/server/WebContentUtil/index.d.ts +277 -284
  138. package/server/WebResourceFactory/index.d.ts +41 -46
  139. package/server/XSLTUtil/index.d.ts +34 -32
  140. package/server/XmlParserUtil/index.d.ts +50 -48
  141. package/types/javax/jcr/Binary/index.d.ts +3 -21
  142. package/types/javax/jcr/Binary/index.js +0 -1
  143. package/types/javax/jcr/Credentials/index.d.ts +3 -1
  144. package/types/javax/jcr/ImportUUIDBehavior/index.d.ts +27 -1
  145. package/types/javax/jcr/Item/index.d.ts +6 -119
  146. package/types/javax/jcr/Item/index.js +0 -6
  147. package/types/javax/jcr/ItemVisitor/index.d.ts +5 -3
  148. package/types/javax/jcr/NamespaceRegistry/index.d.ts +69 -43
  149. package/types/javax/jcr/NamespaceRegistry/index.js +0 -2
  150. package/types/javax/jcr/Node/index.d.ts +37 -1506
  151. package/types/javax/jcr/Node/index.js +1 -34
  152. package/types/javax/jcr/NodeIterator/index.d.ts +5 -3
  153. package/types/javax/jcr/Property/index.d.ts +494 -494
  154. package/types/javax/jcr/Property/index.js +0 -5
  155. package/types/javax/jcr/PropertyIterator/index.d.ts +5 -3
  156. package/types/javax/jcr/RangeIterator/index.d.ts +2 -42
  157. package/types/javax/jcr/RangeIterator/index.js +1 -5
  158. package/types/javax/jcr/Repository/index.d.ts +465 -263
  159. package/types/javax/jcr/Repository/index.js +0 -4
  160. package/types/javax/jcr/RepositoryFactory/index.d.ts +4 -2
  161. package/types/javax/jcr/Value/index.d.ts +4 -31
  162. package/types/javax/jcr/Value/index.js +0 -2
  163. package/types/javax/jcr/ValueFactory/index.d.ts +6 -74
  164. package/types/javax/jcr/ValueFactory/index.js +1 -2
  165. package/types/javax/jcr/Workspace/index.d.ts +103 -577
  166. package/types/javax/jcr/Workspace/index.js +1 -12
  167. package/types/javax/jcr/lock/Lock/index.d.ts +4 -2
  168. package/types/javax/jcr/lock/LockManager/index.d.ts +4 -2
  169. package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts +4 -105
  170. package/types/javax/jcr/nodetype/ItemDefinition/index.js +0 -5
  171. package/types/javax/jcr/nodetype/NodeDefinition/index.d.ts +5 -3
  172. package/types/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +4 -2
  173. package/types/javax/jcr/nodetype/NodeType/index.d.ts +262 -269
  174. package/types/javax/jcr/nodetype/NodeType/index.js +1 -12
  175. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +5 -107
  176. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.js +1 -7
  177. package/types/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +5 -3
  178. package/types/javax/jcr/nodetype/NodeTypeManager/index.d.ts +9 -130
  179. package/types/javax/jcr/nodetype/NodeTypeManager/index.js +1 -8
  180. package/types/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +4 -2
  181. package/types/javax/jcr/nodetype/PropertyDefinition/index.d.ts +5 -272
  182. package/types/javax/jcr/nodetype/PropertyDefinition/index.js +1 -7
  183. package/types/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +5 -3
  184. package/types/javax/jcr/observation/Event/index.d.ts +85 -42
  185. package/types/javax/jcr/observation/EventIterator/index.d.ts +5 -3
  186. package/types/javax/jcr/observation/EventJournal/index.d.ts +4 -2
  187. package/types/javax/jcr/observation/EventListener/index.d.ts +4 -2
  188. package/types/javax/jcr/observation/EventListenerIterator/index.d.ts +5 -3
  189. package/types/javax/jcr/observation/ObservationManager/index.d.ts +6 -4
  190. package/types/javax/jcr/query/Query/index.d.ts +35 -12
  191. package/types/javax/jcr/query/QueryManager/index.d.ts +6 -4
  192. package/types/javax/jcr/query/QueryResult/index.d.ts +5 -3
  193. package/types/javax/jcr/query/Row/index.d.ts +5 -3
  194. package/types/javax/jcr/query/RowIterator/index.d.ts +5 -3
  195. package/types/javax/jcr/query/qom/And/index.d.ts +4 -2
  196. package/types/javax/jcr/query/qom/BindVariableValue/index.d.ts +4 -2
  197. package/types/javax/jcr/query/qom/ChildNode/index.d.ts +4 -2
  198. package/types/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +4 -2
  199. package/types/javax/jcr/query/qom/Column/index.d.ts +3 -1
  200. package/types/javax/jcr/query/qom/Comparison/index.d.ts +6 -4
  201. package/types/javax/jcr/query/qom/Constraint/index.d.ts +3 -1
  202. package/types/javax/jcr/query/qom/DescendantNode/index.d.ts +4 -2
  203. package/types/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +4 -2
  204. package/types/javax/jcr/query/qom/DynamicOperand/index.d.ts +4 -2
  205. package/types/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +4 -2
  206. package/types/javax/jcr/query/qom/FullTextSearch/index.d.ts +5 -3
  207. package/types/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +4 -2
  208. package/types/javax/jcr/query/qom/Join/index.d.ts +5 -3
  209. package/types/javax/jcr/query/qom/JoinCondition/index.d.ts +3 -1
  210. package/types/javax/jcr/query/qom/Length/index.d.ts +5 -3
  211. package/types/javax/jcr/query/qom/Literal/index.d.ts +5 -3
  212. package/types/javax/jcr/query/qom/LowerCase/index.d.ts +4 -2
  213. package/types/javax/jcr/query/qom/NodeLocalName/index.d.ts +4 -2
  214. package/types/javax/jcr/query/qom/NodeName/index.d.ts +4 -2
  215. package/types/javax/jcr/query/qom/Not/index.d.ts +4 -2
  216. package/types/javax/jcr/query/qom/Operand/index.d.ts +3 -1
  217. package/types/javax/jcr/query/qom/Or/index.d.ts +4 -2
  218. package/types/javax/jcr/query/qom/Ordering/index.d.ts +4 -2
  219. package/types/javax/jcr/query/qom/PropertyExistence/index.d.ts +4 -2
  220. package/types/javax/jcr/query/qom/PropertyValue/index.d.ts +4 -2
  221. package/types/javax/jcr/query/qom/QueryObjectModel/index.d.ts +8 -6
  222. package/types/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +76 -2
  223. package/types/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +37 -35
  224. package/types/javax/jcr/query/qom/SameNode/index.d.ts +4 -2
  225. package/types/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +4 -2
  226. package/types/javax/jcr/query/qom/Selector/index.d.ts +4 -2
  227. package/types/javax/jcr/query/qom/Source/index.d.ts +3 -1
  228. package/types/javax/jcr/query/qom/StaticOperand/index.d.ts +4 -2
  229. package/types/javax/jcr/query/qom/UpperCase/index.d.ts +4 -2
  230. package/types/javax/jcr/retention/Hold/index.d.ts +3 -1
  231. package/types/javax/jcr/retention/RetentionManager/index.d.ts +5 -3
  232. package/types/javax/jcr/retention/RetentionPolicy/index.d.ts +3 -1
  233. package/types/javax/jcr/security/AccessControlEntry/index.d.ts +4 -2
  234. package/types/javax/jcr/security/AccessControlList/index.d.ts +6 -4
  235. package/types/javax/jcr/security/AccessControlManager/index.d.ts +6 -4
  236. package/types/javax/jcr/security/AccessControlPolicy/index.d.ts +3 -1
  237. package/types/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +5 -3
  238. package/types/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +4 -2
  239. package/types/javax/jcr/security/Privilege/index.d.ts +130 -44
  240. package/types/javax/jcr/version/Version/index.d.ts +5 -3
  241. package/types/javax/jcr/version/VersionHistory/index.d.ts +7 -5
  242. package/types/javax/jcr/version/VersionIterator/index.d.ts +5 -3
  243. package/types/javax/jcr/version/VersionManager/index.d.ts +7 -5
  244. package/types/senselogic/sitevision/api/base/Builder/index.d.ts +3 -1
  245. package/types/senselogic/sitevision/api/base/Filter/index.d.ts +3 -1
  246. package/types/senselogic/sitevision/api/base/FilterSplit/index.d.ts +4 -2
  247. package/types/senselogic/sitevision/api/base/Loadable/index.d.ts +3 -1
  248. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.d.ts +9 -0
  249. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.js +11 -0
  250. package/types/senselogic/sitevision/api/base/Resolver/index.d.ts +3 -1
  251. package/types/senselogic/sitevision/api/base/Wrapper/index.d.ts +3 -1
  252. package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +13 -7
  253. package/types/senselogic/sitevision/api/format/NumericFormatter/index.d.ts +3 -1
  254. package/types/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +5 -3
  255. package/types/senselogic/sitevision/api/i18n/Currency/index.d.ts +3 -1
  256. package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +5 -3
  257. package/types/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts +3 -1
  258. package/types/senselogic/sitevision/api/mail/Mail/index.d.ts +3 -1
  259. package/types/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts +3 -1
  260. package/types/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts +3 -1
  261. package/types/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts +3 -1
  262. package/types/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts +4 -2
  263. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.d.ts +51 -0
  264. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.js +12 -0
  265. package/types/senselogic/sitevision/api/render/ImageScaler/index.d.ts +4 -2
  266. package/types/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts +4 -2
  267. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts +3 -1
  268. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.d.ts +85 -0
  269. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.js +21 -0
  270. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.d.ts +31 -0
  271. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.js +12 -0
  272. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.d.ts +31 -0
  273. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.js +12 -0
  274. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.d.ts +67 -0
  275. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.js +18 -0
  276. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.d.ts +25 -0
  277. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.js +11 -0
  278. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.d.ts +19 -0
  279. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.js +10 -0
  280. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +1243 -0
  281. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +189 -0
  282. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.d.ts +31 -0
  283. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.js +12 -0
  284. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.d.ts +91 -0
  285. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.js +22 -0
  286. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.d.ts +27 -0
  287. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.js +11 -0
  288. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.d.ts +19 -0
  289. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.js +10 -0
  290. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.d.ts +19 -0
  291. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.js +10 -0
  292. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.d.ts +25 -0
  293. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.js +11 -0
  294. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.d.ts +37 -0
  295. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.js +13 -0
  296. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.d.ts +25 -0
  297. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.js +11 -0
  298. package/types/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts +3 -1
  299. package/types/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts +3 -1
  300. package/types/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +4 -2
  301. package/types/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts +3 -1
  302. package/types/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts +3 -1
  303. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts +3 -1
  304. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts +4 -2
  305. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +24 -2
  306. package/types/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts +3 -1
  307. package/types/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts +4 -2
  308. package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts +19 -3
  309. package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts +31 -7
  310. package/types/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts +3 -1
  311. package/types/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts +3 -1
  312. package/types/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts +4 -2
  313. package/types/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts +3 -1
  314. package/types/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts +3 -1
  315. package/types/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts +3 -1
  316. package/types/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts +3 -1
  317. package/types/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts +3 -1
  318. package/types/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts +3 -1
  319. package/types/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts +3 -1
  320. package/types/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts +3 -1
  321. package/types/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts +3 -1
  322. package/types/senselogic/sitevision/api/security/MessageDigester/index.d.ts +3 -1
  323. package/types/senselogic/sitevision/api/security/RoleAssignment/index.d.ts +4 -2
  324. package/types/senselogic/sitevision/api/security/RoleMatcher/index.d.ts +4 -2
  325. package/types/senselogic/sitevision/api/security/SecretStore/index.d.ts +3 -1
  326. package/types/senselogic/sitevision/api/security/UserUtil/index.d.ts +4 -2
  327. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +35 -3
  328. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts +3 -1
  329. package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +5 -3
  330. package/types/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts +3 -1
  331. package/types/senselogic/sitevision/api/xml/XmlElement/index.d.ts +3 -1
  332. package/types/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts +4 -2
@@ -1,401 +1,406 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
1
+ import type Node from "../../types/javax/jcr/Node";
2
2
 
3
3
  import LinkRenderer from "../LinkRenderer";
4
+ import type OutputUtilConstants from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants";
4
5
 
5
6
  /**
6
- * Gets a text embedded in a html element with a class attribute.
7
- *
8
- * The html element used depends on the element type settings of the <code>aFontNode</code>. The html element in the returned result
9
- * will always be a paragraph (<code>&lt;p&gt;</code>) with no class attribute if <code>aFontNode</code> is <code>null</code>
10
- * or not of primary type <code>sv:font</code>.
11
- *
12
- * <p><strong>Some examples:</strong></p>
13
- * <p>
14
- * Method call: <code>getHtmlText("Hello world! one &lt; two", myFontNode)</code><br>
15
- * will return any of the following:
16
- * </p>
17
- * <ul>
18
- * <li><code>&lt;h1 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h1&gt;</code></li>
19
- * <li><code>&lt;h2 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h2&gt;</code></li>
20
- * <li><code>&lt;h3 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h3&gt;</code></li>
21
- * <li><code>&lt;h4 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h4&gt;</code></li>
22
- * <li><code>&lt;h5 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h5&gt;</code></li>
23
- * <li><code>&lt;h6 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h6&gt;</code></li>
24
- * <li><code>&lt;p class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
25
- * <li><code>&lt;span class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/span&gt;</code></li>
26
- * <li><code>&lt;code class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/code&gt;</code></li>
27
- * <li><code>&lt;sub class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/sub&gt;</code></li>
28
- * <li><code>&lt;sup class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/sup&gt;</code></li>
29
- * </ul>
7
+ * Output utility interface with methods that return complete content snippets.
30
8
  *
31
9
  * <p>
32
- * Method call: <code>getHtmlText("Hello world! one &lt; two", null)</code><br>
33
- * will return this:
10
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getOutputUtil()}.
11
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
34
12
  * </p>
35
- * <ul>
36
- * <li><code>&lt;p&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
37
- * </ul>
38
- * @param aText the text to be embedded in a html element
39
- * @param aFontNode a <code>Node</code> of primary type <code>sv:font</code> that determines the type of html element to use and the class attribute value of the element
40
- * @return <code>aText</code> embedded in a html element, or empty <code>String</code> if <code>aText</code> is <code>null</code>
41
- * @see #getEscapedHtmlText(String, javax.jcr.Node)
42
- * @since Sitevision 2.6.1_02
13
+ * @author Magnus Lövgren
43
14
  */
44
- export function getHtmlText(aText: string, aFontNode: Node): string;
15
+ export interface OutputUtil extends OutputUtilConstants {
16
+ /**
17
+ * The "text/plain" content-type marker
18
+
19
+ */
20
+ CONTENT_TYPE_TEXT_PLAIN: 0;
45
21
 
46
- /**
47
- * Gets a text embedded in a html element with a class attribute and a style attribute.
48
- *
49
- * The html element used depends on the element type settings of the <code>aFontNode</code>. The html element in the returned result
50
- * will always be a paragraph (<code>&lt;p&gt;</code>) with no class attribute if <code>aFontNode</code> is <code>null</code>
51
- * or not of primary type <code>sv:font</code>.
52
- *
53
- * <code>aStyle</code> will be ignored if it is <code>null</code>.
54
- *
55
- * <p><strong>Some examples:</strong></p>
56
- * <p>
57
- * Method call: <code>getHtmlText("Hello world! one &lt; two", myFontNode, "padding-left:0.7em")</code><br>
58
- * will return any of the following:
59
- * </p>
60
- * <ul>
61
- * <li><code>&lt;h1 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h1&gt;</code></li>
62
- * <li><code>&lt;h2 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h2&gt;</code></li>
63
- * <li><code>&lt;h3 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h3&gt;</code></li>
64
- * <li><code>&lt;h4 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h4&gt;</code></li>
65
- * <li><code>&lt;h5 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h5&gt;</code></li>
66
- * <li><code>&lt;h6 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h6&gt;</code></li>
67
- * <li><code>&lt;p class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
68
- * <li><code>&lt;span class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/span&gt;</code></li>
69
- * <li><code>&lt;code class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/code&gt;</code></li>
70
- * <li><code>&lt;sub class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/sub&gt;</code></li>
71
- * <li><code>&lt;sup class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/sup&gt;</code></li>
72
- * </ul>
73
- *
74
- * <p>Method call: <code>getHtmlText("Hello world! one &lt; two", null, "padding-left:0.7em")</code><br>
75
- * will return this:
76
- * </p>
77
- * <ul>
78
- * <li><code>&lt;p style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
79
- * </ul>
80
- *
81
- * <p>Method call: <code>getHtmlText("Hello world! one &lt; two", null, null)</code><br>
82
- * will return this:
83
- * </p>
84
- * <ul>
85
- * <li><code>&lt;p&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
86
- * </ul>
87
- *
88
- * <p>Method call: <code>getHtmlText("Hello world! one &lt; two", myFontNode, null)</code><br>
89
- * will return the same result as if the {@link #getHtmlText(String, javax.jcr.Node) getHtmlText(String, Node)} method had been invoked.
90
- * </p>
91
- * @param aText the text to be embedded in a html element
92
- * @param aFontNode a <code>Node</code> of primary type <code>sv:font</code> that determines the type of html element to use and the class attribute value of the element
93
- * @param aStyle the style that should be inserted in the style attribute of the element
94
- * @return <code>aText</code> embedded in a html element, or empty <code>String</code> if <code>aText</code> is <code>null</code>
95
- * @see #getEscapedHtmlText(String, javax.jcr.Node, String)
96
- * @since Sitevision 2.6.1_02
97
- */
98
- export function getHtmlText(
99
- aText: string,
100
- aFontNode: Node,
101
- aStyle: string
102
- ): string;
22
+ /**
23
+ * The "text/html" content-type marker
24
+
25
+ */
26
+ CONTENT_TYPE_TEXT_HTML: 1;
103
27
 
104
- /**
105
- * Gets a text escaped and embedded in a html element with a class attribute.
106
- *
107
- * The html element used depends on the element type settings of the <code>aFontNode</code>. The html element in the returned result
108
- * will always be a paragraph (<code>&lt;p&gt;</code>) with no class attribute if <code>aFontNode</code> is <code>null</code>
109
- * or not of primary type <code>sv:font</code>.
110
- *
111
- * <p><strong>Some examples:</strong></p>
112
- * <p>
113
- * Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", myFontNode)</code><br>
114
- * will return any of the following:
115
- * </p>
116
- * <ul>
117
- * <li><code>&lt;h1 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h1&gt;</code></li>
118
- * <li><code>&lt;h2 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h2&gt;</code></li>
119
- * <li><code>&lt;h3 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h3&gt;</code></li>
120
- * <li><code>&lt;h4 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h4&gt;</code></li>
121
- * <li><code>&lt;h5 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h5&gt;</code></li>
122
- * <li><code>&lt;h6 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h6&gt;</code></li>
123
- * <li><code>&lt;p class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
124
- * <li><code>&lt;span class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/span&gt;</code></li>
125
- * <li><code>&lt;code class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/code&gt;</code></li>
126
- * <li><code>&lt;sub class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/sub&gt;</code></li>
127
- * <li><code>&lt;sup class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/sup&gt;</code></li>
128
- * </ul>
129
- *
130
- * <p>
131
- * Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", null)</code><br>
132
- * will return this:
133
- * </p>
134
- * <ul>
135
- * <li><code>&lt;p&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
136
- * </ul>
137
- * @param aPlainText the text to be escaped and embedded in a html element
138
- * @param aFontNode a <code>Node</code> of primary type <code>sv:font</code> that determines the type of html element to use and the class attribute value of the element
139
- * @return <code>aPlainText</code> escaped and embedded in a html element, or empty String if <code>aPlainText</code> is null
140
- * @see #getHtmlText(String, javax.jcr.Node)
141
- * @since Sitevision 2.6.1_02
142
- */
143
- export function getEscapedHtmlText(aPlainText: string, aFontNode: Node): string;
28
+ /**
29
+ * The "text/xml" content-type marker
30
+
31
+ */
32
+ CONTENT_TYPE_TEXT_XML: 2;
144
33
 
145
- /**
146
- * Gets a text escaped and embedded in a html element with a class attribute and a style attribute.
147
- *
148
- * The html element used depends on the element type settings of the <code>aFontNode</code>. The html element in the returned result
149
- * will always be a paragraph (<code>&lt;p&gt;</code>) with no class attribute if <code>aFontNode</code> is <code>null</code>
150
- * or not of primary type <code>sv:font</code>.
151
- *
152
- * <code>aStyle</code> will be ignored if it is <code>null</code>.
153
- *
154
- * <p><strong>Some examples:</strong></p>
155
- * <p>
156
- * Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", myFontNode, "padding-left:0.7em")</code><br>
157
- * will return any of the following:
158
- * </p>
159
- * <ul>
160
- * <li><code>&lt;h1 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h1&gt;</code></li>
161
- * <li><code>&lt;h2 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h2&gt;</code></li>
162
- * <li><code>&lt;h3 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h3&gt;</code></li>
163
- * <li><code>&lt;h4 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h4&gt;</code></li>
164
- * <li><code>&lt;h5 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h5&gt;</code></li>
165
- * <li><code>&lt;h6 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h6&gt;</code></li>
166
- * <li><code>&lt;p class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
167
- * <li><code>&lt;span class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/span&gt;</code></li>
168
- * <li><code>&lt;code class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/code&gt;</code></li>
169
- * <li><code>&lt;sub class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/sub&gt;</code></li>
170
- * <li><code>&lt;sup class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/sup&gt;</code></li>
171
- * </ul>
172
- *
173
- * <p>Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", null, "padding-left:0.7em")</code><br>
174
- * will return this:
175
- * </p>
176
- * <ul>
177
- * <li><code>&lt;p style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
178
- * </ul>
179
- *
180
- * <p>Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", null, null)</code><br>
181
- * will return this:
182
- * </p>
183
- * <ul>
184
- * <li><code>&lt;p&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
185
- * </ul>
186
- *
187
- * <p>Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", myFontNode, null)</code><br>
188
- * will return the same result as if the {@link #getEscapedHtmlText(String, javax.jcr.Node) getEscapedHtmlText(String, Node)}
189
- * method had been invoked.
190
- * </p>
191
- * @param aPlainText the text to be escaped and embedded in a html element
192
- * @param aFontNode a <code>Node</code> of primary type <code>sv:font</code> that determines the type of html element to use and the class attribute value of the element
193
- * @param aStyle the style that should be inserted in the style attribute of the element
194
- * @return <code>aPlainText</code> embedded in a html element, or empty <code>String</code> if <code>aPlainText</code> is <code>null</code>
195
- * @see #getHtmlText(String, javax.jcr.Node, String)
196
- * @since Sitevision 2.6.1_02
197
- */
198
- export function getEscapedHtmlText(
199
- aPlainText: string,
200
- aFontNode: Node,
201
- aStyle: string
202
- ): string;
34
+ /**
35
+ * Gets a text embedded in a html element with a class attribute.
36
+ *
37
+ * The html element used depends on the element type settings of the <code>aFontNode</code>. The html element in the returned result
38
+ * will always be a paragraph (<code>&lt;p&gt;</code>) with no class attribute if <code>aFontNode</code> is <code>null</code>
39
+ * or not of primary type <code>sv:font</code>.
40
+ *
41
+ * <p><strong>Some examples:</strong></p>
42
+ * <p>
43
+ * Method call: <code>getHtmlText("Hello world! one &lt; two", myFontNode)</code><br>
44
+ * will return any of the following:
45
+ * </p>
46
+ * <ul>
47
+ * <li><code>&lt;h1 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h1&gt;</code></li>
48
+ * <li><code>&lt;h2 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h2&gt;</code></li>
49
+ * <li><code>&lt;h3 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h3&gt;</code></li>
50
+ * <li><code>&lt;h4 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h4&gt;</code></li>
51
+ * <li><code>&lt;h5 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h5&gt;</code></li>
52
+ * <li><code>&lt;h6 class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/h6&gt;</code></li>
53
+ * <li><code>&lt;p class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
54
+ * <li><code>&lt;span class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/span&gt;</code></li>
55
+ * <li><code>&lt;code class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/code&gt;</code></li>
56
+ * <li><code>&lt;sub class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/sub&gt;</code></li>
57
+ * <li><code>&lt;sup class="selectorTextOfMyFontNode"&gt;Hello world! one &lt; two&lt;/sup&gt;</code></li>
58
+ * </ul>
59
+ *
60
+ * <p>
61
+ * Method call: <code>getHtmlText("Hello world! one &lt; two", null)</code><br>
62
+ * will return this:
63
+ * </p>
64
+ * <ul>
65
+ * <li><code>&lt;p&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
66
+ * </ul>
67
+ * @param aText the text to be embedded in a html element
68
+ * @param aFontNode a <code>Node</code> of primary type <code>sv:font</code> that determines the type of html element to use and the class attribute value of the element
69
+ * @return <code>aText</code> embedded in a html element, or empty <code>String</code> if <code>aText</code> is <code>null</code>
70
+ * @see #getEscapedHtmlText(String, javax.jcr.Node)
71
+ * @since Sitevision 2.6.1_02
72
+ */
73
+ getHtmlText(aText: string, aFontNode: Node): string;
203
74
 
204
- /**
205
- * Hyperlinks text and uses a specified css class for created anchors.
206
- *
207
- * <p>
208
- * Inserts an hyperlink/anchor (<code>&lt;a href="..."&gt;...&lt;/a&gt;</code>) with a title and optional class and style where the text seems
209
- * to indicate a hyperlink. Text blocks that starts with <em>http://</em>, <em>https://</em>, <em>www.</em> or contains an <em>@</em> will be
210
- * considered for hyperlinking.
211
- * </p>
212
- * @param aText a text that might contain hyperlinkable parts
213
- * @param aClass the class of the hyperlinks (the <code>class</code> attribute of the <code>a</code> element). if <code>aClass</code> is <code>null</code> or empty, it will not be used in any hyperlinks.
214
- * @param aStyle the style of the hyperlinks (the <code>style</code> attribute of the <code>a</code> element) if <code>aStyle</code> is <code>null</code> or empty, it will not be used in any hyperlinks.
215
- * @return <code>aText</code> hyperlinked
216
- * @since Sitevision 2.6.1_06
217
- * @see OutputUtil#getHyperlinkedText(String)
218
- */
219
- export function getHyperlinkedText(
220
- aText: string,
221
- aClass: string,
222
- aStyle: string
223
- ): string;
75
+ /**
76
+ * Gets a text embedded in a html element with a class attribute and a style attribute.
77
+ *
78
+ * The html element used depends on the element type settings of the <code>aFontNode</code>. The html element in the returned result
79
+ * will always be a paragraph (<code>&lt;p&gt;</code>) with no class attribute if <code>aFontNode</code> is <code>null</code>
80
+ * or not of primary type <code>sv:font</code>.
81
+ *
82
+ * <code>aStyle</code> will be ignored if it is <code>null</code>.
83
+ *
84
+ * <p><strong>Some examples:</strong></p>
85
+ * <p>
86
+ * Method call: <code>getHtmlText("Hello world! one &lt; two", myFontNode, "padding-left:0.7em")</code><br>
87
+ * will return any of the following:
88
+ * </p>
89
+ * <ul>
90
+ * <li><code>&lt;h1 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h1&gt;</code></li>
91
+ * <li><code>&lt;h2 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h2&gt;</code></li>
92
+ * <li><code>&lt;h3 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h3&gt;</code></li>
93
+ * <li><code>&lt;h4 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h4&gt;</code></li>
94
+ * <li><code>&lt;h5 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h5&gt;</code></li>
95
+ * <li><code>&lt;h6 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/h6&gt;</code></li>
96
+ * <li><code>&lt;p class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
97
+ * <li><code>&lt;span class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/span&gt;</code></li>
98
+ * <li><code>&lt;code class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/code&gt;</code></li>
99
+ * <li><code>&lt;sub class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/sub&gt;</code></li>
100
+ * <li><code>&lt;sup class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/sup&gt;</code></li>
101
+ * </ul>
102
+ *
103
+ * <p>Method call: <code>getHtmlText("Hello world! one &lt; two", null, "padding-left:0.7em")</code><br>
104
+ * will return this:
105
+ * </p>
106
+ * <ul>
107
+ * <li><code>&lt;p style="padding-left:0.7em"&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
108
+ * </ul>
109
+ *
110
+ * <p>Method call: <code>getHtmlText("Hello world! one &lt; two", null, null)</code><br>
111
+ * will return this:
112
+ * </p>
113
+ * <ul>
114
+ * <li><code>&lt;p&gt;Hello world! one &lt; two&lt;/p&gt;</code></li>
115
+ * </ul>
116
+ *
117
+ * <p>Method call: <code>getHtmlText("Hello world! one &lt; two", myFontNode, null)</code><br>
118
+ * will return the same result as if the {@link #getHtmlText(String, javax.jcr.Node) getHtmlText(String, Node)} method had been invoked.
119
+ * </p>
120
+ * @param aText the text to be embedded in a html element
121
+ * @param aFontNode a <code>Node</code> of primary type <code>sv:font</code> that determines the type of html element to use and the class attribute value of the element
122
+ * @param aStyle the style that should be inserted in the style attribute of the element
123
+ * @return <code>aText</code> embedded in a html element, or empty <code>String</code> if <code>aText</code> is <code>null</code>
124
+ * @see #getEscapedHtmlText(String, javax.jcr.Node, String)
125
+ * @since Sitevision 2.6.1_02
126
+ */
127
+ getHtmlText(aText: string, aFontNode: Node, aStyle: string): string;
224
128
 
225
- /**
226
- * Hyperlinks text.
227
- *
228
- * <p>
229
- * Inserts an hyperlink/anchor (<code>&lt;a href="..."&gt;...&lt;/a&gt;</code>) where the text seems to indicate a hyperlink.
230
- * Text blocks that starts with <em>http://</em>, <em>https://</em>, <em>www.</em> or contains an <em>@</em> will be considered for hyperlinking.
231
- * </p>
232
- * @param aText a text that might contain hyperlinkable parts
233
- * @return <code>aText</code> hyperlinked
234
- * @since Sitevision 3.1
235
- * @see OutputUtil#getHyperlinkedText(String, String, String)
236
- */
237
- export function getHyperlinkedText(aText: string): string;
129
+ /**
130
+ * Gets a text escaped and embedded in a html element with a class attribute.
131
+ *
132
+ * The html element used depends on the element type settings of the <code>aFontNode</code>. The html element in the returned result
133
+ * will always be a paragraph (<code>&lt;p&gt;</code>) with no class attribute if <code>aFontNode</code> is <code>null</code>
134
+ * or not of primary type <code>sv:font</code>.
135
+ *
136
+ * <p><strong>Some examples:</strong></p>
137
+ * <p>
138
+ * Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", myFontNode)</code><br>
139
+ * will return any of the following:
140
+ * </p>
141
+ * <ul>
142
+ * <li><code>&lt;h1 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h1&gt;</code></li>
143
+ * <li><code>&lt;h2 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h2&gt;</code></li>
144
+ * <li><code>&lt;h3 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h3&gt;</code></li>
145
+ * <li><code>&lt;h4 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h4&gt;</code></li>
146
+ * <li><code>&lt;h5 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h5&gt;</code></li>
147
+ * <li><code>&lt;h6 class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/h6&gt;</code></li>
148
+ * <li><code>&lt;p class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
149
+ * <li><code>&lt;span class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/span&gt;</code></li>
150
+ * <li><code>&lt;code class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/code&gt;</code></li>
151
+ * <li><code>&lt;sub class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/sub&gt;</code></li>
152
+ * <li><code>&lt;sup class="selectorTextOfMyFontNode"&gt;Hello world! one &amp;lt; two&lt;/sup&gt;</code></li>
153
+ * </ul>
154
+ *
155
+ * <p>
156
+ * Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", null)</code><br>
157
+ * will return this:
158
+ * </p>
159
+ * <ul>
160
+ * <li><code>&lt;p&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
161
+ * </ul>
162
+ * @param aPlainText the text to be escaped and embedded in a html element
163
+ * @param aFontNode a <code>Node</code> of primary type <code>sv:font</code> that determines the type of html element to use and the class attribute value of the element
164
+ * @return <code>aPlainText</code> escaped and embedded in a html element, or empty String if <code>aPlainText</code> is null
165
+ * @see #getHtmlText(String, javax.jcr.Node)
166
+ * @since Sitevision 2.6.1_02
167
+ */
168
+ getEscapedHtmlText(aPlainText: string, aFontNode: Node): string;
238
169
 
239
- /**
240
- * Gets a simplistic plain text output from a text portlet.
241
- * Handles plain text, line breaks and dot lists.
242
- * @param aNode a text portlet node
243
- * @return the output from the text portlet as plain text, or an empty <code>String</code> if aNode is <code>null</code> or not a text portlet
244
- * @deprecated Use {@link #getNodeOutput(javax.jcr.Node, javax.jcr.Node, int)}
245
- * @see #getNodeOutput(Node,Node,int)
246
- */
247
- export function getNodeAsText(aNode: Node): string;
170
+ /**
171
+ * Gets a text escaped and embedded in a html element with a class attribute and a style attribute.
172
+ *
173
+ * The html element used depends on the element type settings of the <code>aFontNode</code>. The html element in the returned result
174
+ * will always be a paragraph (<code>&lt;p&gt;</code>) with no class attribute if <code>aFontNode</code> is <code>null</code>
175
+ * or not of primary type <code>sv:font</code>.
176
+ *
177
+ * <code>aStyle</code> will be ignored if it is <code>null</code>.
178
+ *
179
+ * <p><strong>Some examples:</strong></p>
180
+ * <p>
181
+ * Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", myFontNode, "padding-left:0.7em")</code><br>
182
+ * will return any of the following:
183
+ * </p>
184
+ * <ul>
185
+ * <li><code>&lt;h1 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h1&gt;</code></li>
186
+ * <li><code>&lt;h2 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h2&gt;</code></li>
187
+ * <li><code>&lt;h3 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h3&gt;</code></li>
188
+ * <li><code>&lt;h4 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h4&gt;</code></li>
189
+ * <li><code>&lt;h5 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h5&gt;</code></li>
190
+ * <li><code>&lt;h6 class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/h6&gt;</code></li>
191
+ * <li><code>&lt;p class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
192
+ * <li><code>&lt;span class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/span&gt;</code></li>
193
+ * <li><code>&lt;code class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/code&gt;</code></li>
194
+ * <li><code>&lt;sub class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/sub&gt;</code></li>
195
+ * <li><code>&lt;sup class="selectorTextOfMyFontNode" style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/sup&gt;</code></li>
196
+ * </ul>
197
+ *
198
+ * <p>Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", null, "padding-left:0.7em")</code><br>
199
+ * will return this:
200
+ * </p>
201
+ * <ul>
202
+ * <li><code>&lt;p style="padding-left:0.7em"&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
203
+ * </ul>
204
+ *
205
+ * <p>Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", null, null)</code><br>
206
+ * will return this:
207
+ * </p>
208
+ * <ul>
209
+ * <li><code>&lt;p&gt;Hello world! one &amp;lt; two&lt;/p&gt;</code></li>
210
+ * </ul>
211
+ *
212
+ * <p>Method call: <code>getEscapedHtmlText("Hello world! one &lt; two", myFontNode, null)</code><br>
213
+ * will return the same result as if the {@link #getEscapedHtmlText(String, javax.jcr.Node) getEscapedHtmlText(String, Node)}
214
+ * method had been invoked.
215
+ * </p>
216
+ * @param aPlainText the text to be escaped and embedded in a html element
217
+ * @param aFontNode a <code>Node</code> of primary type <code>sv:font</code> that determines the type of html element to use and the class attribute value of the element
218
+ * @param aStyle the style that should be inserted in the style attribute of the element
219
+ * @return <code>aPlainText</code> embedded in a html element, or empty <code>String</code> if <code>aPlainText</code> is <code>null</code>
220
+ * @see #getHtmlText(String, javax.jcr.Node, String)
221
+ * @since Sitevision 2.6.1_02
222
+ */
223
+ getEscapedHtmlText(
224
+ aPlainText: string,
225
+ aFontNode: Node,
226
+ aStyle: string
227
+ ): string;
248
228
 
249
- /**
250
- * Gets the output as a specific content-type from a page node or a page content node.
251
- *
252
- * <p>
253
- * <em>Tip! Consider using {@link TextModuleRenderer} instead if you want the output of a single Text module.</em>
254
- * </p>
255
- *
256
- * <p>
257
- * <strong>Note! Due to security reasons (potential never-ending loops) it is prohibited to get the output of anything from
258
- * the currently executing page (i.e. {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage()})!</strong>
259
- * </p>
260
- * @param aPageNode a page node (sv:page, sv:article, sv:sitePage) where current user has READ permission, must not be null or "current page".
261
- * @param aPagePartNode a page part node that exist as content on aPageNode (or null if you want the complete output from aPageNode).
262
- * @param aContentType a content-type marker, i.e. <a href="#CONTENT_TYPE_TEXT_PLAIN">CONTENT_TYPE_TEXT_PLAIN</a>, <a href="#CONTENT_TYPE_TEXT_HTML">CONTENT_TYPE_TEXT_HTML</a> or <a href="#CONTENT_TYPE_TEXT_XML">CONTENT_TYPE_TEXT_XML</a>.
263
- * @return the output result for specified aContentType. If aPageNode is null or "current page", an empty String is returned. If current user doesn't have READ permission on aPageNode, an empty String is returned. If aPagePartNode is null, the output result of aPageNode is returned. If aPagePartNode doesn't exist as content on aPageNode, an empty String is returned.
264
- * @since Sitevision 2.6
265
- */
266
- export function getNodeOutput(
267
- aPageNode: Node,
268
- aPagePartNode: Node,
269
- aContentType: number
270
- ): string;
229
+ /**
230
+ * Hyperlinks text and uses a specified css class for created anchors.
231
+ *
232
+ * <p>
233
+ * Inserts an hyperlink/anchor (<code>&lt;a href="..."&gt;...&lt;/a&gt;</code>) with a title and optional class and style where the text seems
234
+ * to indicate a hyperlink. Text blocks that starts with <em>http://</em>, <em>https://</em>, <em>www.</em> or contains an <em>@</em> will be
235
+ * considered for hyperlinking.
236
+ * </p>
237
+ * @param aText a text that might contain hyperlinkable parts
238
+ * @param aClass the class of the hyperlinks (the <code>class</code> attribute of the <code>a</code> element). if <code>aClass</code> is <code>null</code> or empty, it will not be used in any hyperlinks.
239
+ * @param aStyle the style of the hyperlinks (the <code>style</code> attribute of the <code>a</code> element) if <code>aStyle</code> is <code>null</code> or empty, it will not be used in any hyperlinks.
240
+ * @return <code>aText</code> hyperlinked
241
+ * @since Sitevision 2.6.1_06
242
+ * @see OutputUtil#getHyperlinkedText(String)
243
+ */
244
+ getHyperlinkedText(aText: string, aClass: string, aStyle: string): string;
271
245
 
272
- /**
273
- * Debug method that returns info about the properties of a node and all its sub nodes.
274
- *
275
- * <p>
276
- * <em>
277
- * <strong>Note!</strong> This method is intended for debugging purposes during development ONLY!
278
- * Important: Only the types and properties that are officially specified on the
279
- * <a href="http://help.sitevision.se/nodetypes">Sitevision developer web</a>
280
- * can be relied upon and used in production. All other types and properties should
281
- * be considered volatile. Output produced by this method is not indexed by the Sitevision indexer.
282
- * </em>
283
- * </p>
284
- * @param aNode the start node from where all properties should be retrieved
285
- * @return the node as a {@code String} in HTML or an empty String if it does not contain any properties and sub nodes.
286
- * @throws IllegalArgumentException if the given node {@code aNode} is null.
287
- * @throws javax.jcr.RepositoryException if something else goes wrong.
288
- * @see #getNodeInfoAsHTML(javax.jcr.Node, int)
289
- * @since Sitevision 3.0
290
- */
291
- export function getNodeInfoAsHTML(aNode: Node): string;
246
+ /**
247
+ * Hyperlinks text.
248
+ *
249
+ * <p>
250
+ * Inserts an hyperlink/anchor (<code>&lt;a href="..."&gt;...&lt;/a&gt;</code>) where the text seems to indicate a hyperlink.
251
+ * Text blocks that starts with <em>http://</em>, <em>https://</em>, <em>www.</em> or contains an <em>@</em> will be considered for hyperlinking.
252
+ * </p>
253
+ * @param aText a text that might contain hyperlinkable parts
254
+ * @return <code>aText</code> hyperlinked
255
+ * @since Sitevision 3.1
256
+ * @see OutputUtil#getHyperlinkedText(String, String, String)
257
+ */
258
+ getHyperlinkedText(aText: string): string;
292
259
 
293
- /**
294
- * Debug method that returns info about the properties of a node and all its sub nodes recursively until a given sub level
295
- * {@code aDepth} is reached.
296
- *
297
- * <p>
298
- * <em>
299
- * <strong>Note!</strong> This method is intended for debugging purposes during development ONLY!
300
- * Important: Only the types and properties that are officially specified on the
301
- * <a href="http://help.sitevision.se/nodetypes">Sitevision developer web</a>
302
- * can be relied upon and used in production. All other types and properties should
303
- * be considered volatile. Output produced by this method is not indexed by the Sitevision indexer.
304
- * </em>
305
- * </p>
306
- * @param aNode the start node from where all properties should be retrieved
307
- * @param aDepth the number of sub levels from the start node to be retrieved
308
- * @return the node as a {@code String} in HTML or an empty String if it does not contain any properties and sub nodes.
309
- * @throws IllegalArgumentException if the given node {@code aNode} is null or the given depth {@code aDepth} is negative.
310
- * @throws RepositoryException if something else goes wrong.
311
- * @since Sitevision 3.0
312
- */
313
- export function getNodeInfoAsHTML(aNode: Node, aDepth: number): string;
260
+ /**
261
+ * Gets a simplistic plain text output from a text portlet.
262
+ * Handles plain text, line breaks and dot lists.
263
+ * @param aNode a text portlet node
264
+ * @return the output from the text portlet as plain text, or an empty <code>String</code> if aNode is <code>null</code> or not a text portlet
265
+ * @deprecated Use {@link #getNodeOutput(javax.jcr.Node, javax.jcr.Node, int)}
266
+ * @see #getNodeOutput(Node,Node,int)
267
+ */
268
+ getNodeAsText(aNode: Node): string;
314
269
 
315
- /**
316
- * Convenience method for rendering a linked web path to a specified node.
317
- *
318
- * <p>
319
- * --------------------------------------------------------- <br>
320
- * <strong>Example:</strong> You use Velocity and want to do a simple "path to this page" menu
321
- * with a pretty "double arrow" between the links<br>
322
- * ---------------------------------------------------------
323
- * </p>
324
- *
325
- * <p><strong>A) The explicit way:</strong></p>
326
- * <p>Use the <code>getWebPathNodes</code> method of {@link senselogic.sitevision.api.node.NodeTreeUtil} to get all nodes in the
327
- * path to the site page and render a link to each node using a {@link senselogic.sitevision.api.render.LinkRenderer}.
328
- * Current page can be found via a {@link senselogic.sitevision.api.context.PortletContextUtil} instance.</p><pre><code>
329
- * <em>## Get all nodes from here to the site page</em>
330
- * #set ($currentPage = $sitevisionUtils.portletContextUtil.currentPage)
331
- * #set ($nodeTreeUtil = $sitevisionUtils.nodeTreeUtil)
332
- * #set ($pathList = $nodeTreeUtil.getWebPathNodes($currentPage))
333
- *
334
- * <em>## Iterate the nodes in the list with a LinkRenderer</em>
335
- * #if (!$pathList.isEmpty())
336
- * <em>## Set up the link renderer</em>
337
- * #set ($linkRenderer = $sitevisionUtils.getLinkRenderer())
338
- *
339
- * <em>## Render links to all nodes</em>
340
- * &lt;p class="normal"&gt;
341
- * #foreach ($node in $pathList)
342
- * $linkRenderer.update($node)
343
- * #if ($velocityCount &gt; 0)
344
- * &amp;raquo;
345
- * #end
346
- * $linkRenderer.render()
347
- * #end
348
- * &lt;/p&gt;
349
- * #end</code></pre>
350
- *
351
- * <p><strong>B) The convenient way:</strong></p>
352
- * <p>Use the <code>getWebPathNodes</code> method!</p><pre><code>
353
- * <em>## Init</em>
354
- * #set ($currentPage = $sitevisionUtils.portletContextUtil.currentPage)
355
- * #set ($outputUtil = $sitevisionUtils.outputUtil)
356
- * #set ($linkRenderer = $sitevisionUtils.getLinkRenderer())
357
- *
358
- * <em>## Render</em>
359
- * #set ($result = $outputUtil.renderWebPathNodes($currentPage, $linkRenderer, ' &amp;raquo; '))
360
- * #if ($result != '')
361
- * &lt;p class="normal"&gt;$result&lt;/p&gt;
362
- * #end</code></pre>
363
- *
364
- * <p>
365
- * <em>For a description of "web path", see {@link senselogic.sitevision.api.node.NodeTreeUtil#getWebPathNodes(javax.jcr.Node)}</em>
366
- * </p>
367
- * @param aDescendantNode the node the web path should be rendered for
368
- * @param aLinkRenderer the link renderer that determines how links are rendered
369
- * @param aSeparator the separator that should be put between the links. <em>Note! This is not encoded by this method.</em>
370
- * @return a linked web path, or empty string if aDescendantNode is <code>null</code>, <code>aLinkRenderer</code> is <code>null</code>, <code>aSeparator</code> is <code>null</code> or no web path could be created.
371
- * @see senselogic.sitevision.api.node.NodeTreeUtil#getWebPathNodes(javax.jcr.Node)
372
- * @since Sitevision 3.0.2
373
- */
374
- export function renderWebPathNodes(
375
- aDescendantNode: Node,
376
- aLinkRenderer: LinkRenderer,
377
- aSeparator: string
378
- ): string;
270
+ /**
271
+ * Gets the output as a specific content-type from a page node or a page content node.
272
+ *
273
+ * <p>
274
+ * <em>Tip! Consider using {@link TextModuleRenderer} instead if you want the output of a single Text module.</em>
275
+ * </p>
276
+ *
277
+ * <p>
278
+ * <strong>Note! Due to security reasons (potential never-ending loops) it is prohibited to get the output of anything from
279
+ * the currently executing page (i.e. {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage()})!</strong>
280
+ * </p>
281
+ * @param aPageNode a page node (sv:page, sv:article, sv:sitePage) where current user has READ permission, must not be null or "current page".
282
+ * @param aPagePartNode a page part node that exist as content on aPageNode (or null if you want the complete output from aPageNode).
283
+ * @param aContentType a content-type marker, i.e. <a href="#CONTENT_TYPE_TEXT_PLAIN">CONTENT_TYPE_TEXT_PLAIN</a>, <a href="#CONTENT_TYPE_TEXT_HTML">CONTENT_TYPE_TEXT_HTML</a> or <a href="#CONTENT_TYPE_TEXT_XML">CONTENT_TYPE_TEXT_XML</a>.
284
+ * @return the output result for specified aContentType. If aPageNode is null or "current page", an empty String is returned. If current user doesn't have READ permission on aPageNode, an empty String is returned. If aPagePartNode is null, the output result of aPageNode is returned. If aPagePartNode doesn't exist as content on aPageNode, an empty String is returned.
285
+ * @since Sitevision 2.6
286
+ */
287
+ getNodeOutput(
288
+ aPageNode: Node,
289
+ aPagePartNode: Node,
290
+ aContentType: number
291
+ ): string;
379
292
 
380
- /**
381
- * Output utility interface with methods that return complete content snippets.
382
- *
383
- * <p>
384
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getOutputUtil()}.
385
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
386
- * </p>The "text/plain" content-type markerThe "text/html" content-type markerThe "text/xml" content-type marker
387
- * @author Magnus Lövgren
388
- */
389
- declare namespace outputUtil {
390
- export {
391
- getHtmlText,
392
- getEscapedHtmlText,
393
- getHyperlinkedText,
394
- getNodeAsText,
395
- getNodeOutput,
396
- getNodeInfoAsHTML,
397
- renderWebPathNodes,
398
- };
293
+ /**
294
+ * Debug method that returns info about the properties of a node and all its sub nodes.
295
+ *
296
+ * <p>
297
+ * <em>
298
+ * <strong>Note!</strong> This method is intended for debugging purposes during development ONLY!
299
+ * Important: Only the types and properties that are officially specified on the
300
+ * <a href="http://help.sitevision.se/nodetypes">Sitevision developer web</a>
301
+ * can be relied upon and used in production. All other types and properties should
302
+ * be considered volatile. Output produced by this method is not indexed by the Sitevision indexer.
303
+ * </em>
304
+ * </p>
305
+ * @param aNode the start node from where all properties should be retrieved
306
+ * @return the node as a {@code String} in HTML or an empty String if it does not contain any properties and sub nodes.
307
+ * @throws IllegalArgumentException if the given node {@code aNode} is null.
308
+ * @throws javax.jcr.RepositoryException if something else goes wrong.
309
+ * @see #getNodeInfoAsHTML(javax.jcr.Node, int)
310
+ * @since Sitevision 3.0
311
+ */
312
+ getNodeInfoAsHTML(aNode: Node): string;
313
+
314
+ /**
315
+ * Debug method that returns info about the properties of a node and all its sub nodes recursively until a given sub level
316
+ * {@code aDepth} is reached.
317
+ *
318
+ * <p>
319
+ * <em>
320
+ * <strong>Note!</strong> This method is intended for debugging purposes during development ONLY!
321
+ * Important: Only the types and properties that are officially specified on the
322
+ * <a href="http://help.sitevision.se/nodetypes">Sitevision developer web</a>
323
+ * can be relied upon and used in production. All other types and properties should
324
+ * be considered volatile. Output produced by this method is not indexed by the Sitevision indexer.
325
+ * </em>
326
+ * </p>
327
+ * @param aNode the start node from where all properties should be retrieved
328
+ * @param aDepth the number of sub levels from the start node to be retrieved
329
+ * @return the node as a {@code String} in HTML or an empty String if it does not contain any properties and sub nodes.
330
+ * @throws IllegalArgumentException if the given node {@code aNode} is null or the given depth {@code aDepth} is negative.
331
+ * @throws RepositoryException if something else goes wrong.
332
+ * @since Sitevision 3.0
333
+ */
334
+ getNodeInfoAsHTML(aNode: Node, aDepth: number): string;
335
+
336
+ /**
337
+ * Convenience method for rendering a linked web path to a specified node.
338
+ *
339
+ * <p>
340
+ * --------------------------------------------------------- <br>
341
+ * <strong>Example:</strong> You use Velocity and want to do a simple "path to this page" menu
342
+ * with a pretty "double arrow" between the links<br>
343
+ * ---------------------------------------------------------
344
+ * </p>
345
+ *
346
+ * <p><strong>A) The explicit way:</strong></p>
347
+ * <p>Use the <code>getWebPathNodes</code> method of {@link senselogic.sitevision.api.node.NodeTreeUtil} to get all nodes in the
348
+ * path to the site page and render a link to each node using a {@link senselogic.sitevision.api.render.LinkRenderer}.
349
+ * Current page can be found via a {@link senselogic.sitevision.api.context.PortletContextUtil} instance.</p><pre><code>
350
+ * <em>## Get all nodes from here to the site page</em>
351
+ * #set ($currentPage = $sitevisionUtils.portletContextUtil.currentPage)
352
+ * #set ($nodeTreeUtil = $sitevisionUtils.nodeTreeUtil)
353
+ * #set ($pathList = $nodeTreeUtil.getWebPathNodes($currentPage))
354
+ *
355
+ * <em>## Iterate the nodes in the list with a LinkRenderer</em>
356
+ * #if (!$pathList.isEmpty())
357
+ * <em>## Set up the link renderer</em>
358
+ * #set ($linkRenderer = $sitevisionUtils.getLinkRenderer())
359
+ *
360
+ * <em>## Render links to all nodes</em>
361
+ * &lt;p class="normal"&gt;
362
+ * #foreach ($node in $pathList)
363
+ * $linkRenderer.update($node)
364
+ * #if ($velocityCount &gt; 0)
365
+ * &amp;raquo;
366
+ * #end
367
+ * $linkRenderer.render()
368
+ * #end
369
+ * &lt;/p&gt;
370
+ * #end</code></pre>
371
+ *
372
+ * <p><strong>B) The convenient way:</strong></p>
373
+ * <p>Use the <code>getWebPathNodes</code> method!</p><pre><code>
374
+ * <em>## Init</em>
375
+ * #set ($currentPage = $sitevisionUtils.portletContextUtil.currentPage)
376
+ * #set ($outputUtil = $sitevisionUtils.outputUtil)
377
+ * #set ($linkRenderer = $sitevisionUtils.getLinkRenderer())
378
+ *
379
+ * <em>## Render</em>
380
+ * #set ($result = $outputUtil.renderWebPathNodes($currentPage, $linkRenderer, ' &amp;raquo; '))
381
+ * #if ($result != '')
382
+ * &lt;p class="normal"&gt;$result&lt;/p&gt;
383
+ * #end</code></pre>
384
+ *
385
+ * <p>
386
+ * <em>For a description of "web path", see {@link senselogic.sitevision.api.node.NodeTreeUtil#getWebPathNodes(javax.jcr.Node)}</em>
387
+ * </p>
388
+ * @param aDescendantNode the node the web path should be rendered for
389
+ * @param aLinkRenderer the link renderer that determines how links are rendered
390
+ * @param aSeparator the separator that should be put between the links. <em>Note! This is not encoded by this method.</em>
391
+ * @return a linked web path, or empty string if aDescendantNode is <code>null</code>, <code>aLinkRenderer</code> is <code>null</code>, <code>aSeparator</code> is <code>null</code> or no web path could be created.
392
+ * @see senselogic.sitevision.api.node.NodeTreeUtil#getWebPathNodes(javax.jcr.Node)
393
+ * @since Sitevision 3.0.2
394
+ */
395
+ renderWebPathNodes(
396
+ aDescendantNode: Node,
397
+ aLinkRenderer: LinkRenderer,
398
+ aSeparator: string
399
+ ): string;
399
400
  }
400
401
 
401
- export default outputUtil;
402
+ declare namespace OutputUtil {}
403
+
404
+ declare var outputUtil: OutputUtil;
405
+
406
+ export = outputUtil;