@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,659 +1,4 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
-
3
- /**
4
- * Updates current state.
5
- * @param aTarget the target of the link (href attribute for the a element)
6
- * @param aFontClass the class name the link should use (class attribute for the a element)
7
- * @param aText the link text
8
- * @param aTitle the title of the link (title attribute for the a element)
9
- * @see #isValidTarget(javax.jcr.Node)
10
- */
11
- export function update(
12
- aTarget: Node,
13
- aFontClass: string,
14
- aText: string,
15
- aTitle: string
16
- ): void;
17
-
18
- /**
19
- * Updates current state and removes previous title.
20
- * @param aTarget the target of the link (href attribute for the a element)
21
- * @param aFontClass the class name the link should use (class attribute for the a element)
22
- * @param aText the link text
23
- * @see #isValidTarget(javax.jcr.Node)
24
- */
25
- export function update(aTarget: Node, aFontClass: string, aText: string): void;
26
-
27
- /**
28
- * Updates current state and removes previous title.
29
- * @param aTarget the target of the link (href attribute for the a element)
30
- * @param aText the link text
31
- * @see #isValidTarget(javax.jcr.Node)
32
- */
33
- export function update(aTarget: Node, aText: string): void;
34
-
35
- /**
36
- * Updates current state and removes previous title and text.
37
- *
38
- * <p>
39
- * Note. If no text exists when rendering, the target Node will be used to determine an appropriate text
40
- * (e.g. the display name if the node is a page).
41
- * </p>
42
- * @param aTarget the target of the link (href attribute for the a element)
43
- * @see #isValidTarget(javax.jcr.Node)
44
- */
45
- export function update(aTarget: Node): void;
46
-
47
- /**
48
- * Updates current state and removes all optional attributes.
49
- * @param aTarget the target of the link (href attribute for the a element)
50
- * @param aFontClass the class name the link should use (class attribute for the a element)
51
- * @param aText the link text
52
- * @param aTitle the title of the link (title attribute for the a element)
53
- * @see #clearAllOptional()
54
- * @see #isValidTarget(javax.jcr.Node)
55
- */
56
- export function updateClean(
57
- aTarget: Node,
58
- aFontClass: string,
59
- aText: string,
60
- aTitle: string
61
- ): void;
62
-
63
- /**
64
- * Updates current state and removes all optional attributes and title.
65
- * @param aTarget the target of the link (href attribute for the a element)
66
- * @param aFontClass the class name the link should use (class attribute for the a element)
67
- * @param aText the link text
68
- * @see #clearAllOptional()
69
- * @see #isValidTarget(javax.jcr.Node)
70
- */
71
- export function updateClean(
72
- aTarget: Node,
73
- aFontClass: string,
74
- aText: string
75
- ): void;
76
-
77
- /**
78
- * Updates current state and removes all optional attributes and title.
79
- * @param aTarget the target of the link (href attribute for the a element)
80
- * @param aText the link text
81
- * @see #clearAllOptional()
82
- * @see #isValidTarget(javax.jcr.Node)
83
- */
84
- export function updateClean(aTarget: Node, aText: string): void;
85
-
86
- /**
87
- * Updates current state and removes all optional attributes, title and text.
88
- *
89
- * <p>
90
- * Note. If no text exists when rendering, the target Node will be used to determine an appropriate text
91
- * (e.g. the display name if the node is a page).
92
- * </p>
93
- * @param aTarget the target of the link (href attribute for the a element)
94
- * @see #clearAllOptional()
95
- * @see #isValidTarget(javax.jcr.Node)
96
- */
97
- export function updateClean(aTarget: Node): void;
98
-
99
- /**
100
- * Removes all optional settings.
101
- * In other words - executing this method has the same effect as executing:
102
- * <ul>
103
- * <li><code>clearStyle()</code></li>
104
- * <li><code>clearOnclick()</code></li>
105
- * <li><code>clearId()</code></li>
106
- * <li><code>clearTargetParameters()</code></li>
107
- * <li><code>clearRel()</code></li>
108
- * <li><code>clearAccessKey()</code></li>
109
- * <li><code>clearOpenNewWindow()</code></li>
110
- * <li><code>clearDataAttributes()</code></li>
111
- * <li><code>clearUseDownload()</code></li>
112
- * <li><code>clearLang()</code></li>
113
- * <li><code>clearHrefLang()</code></li>
114
- * </ul>
115
- * @see #clearStyle()
116
- * @see #clearOnclick()
117
- * @see #clearId()
118
- * @see #clearTargetParameters()
119
- * @see #clearRel()
120
- * @see #clearAccessKey()
121
- * @see #clearOpenNewWindow()
122
- * @see #clearDataAttributes()
123
- * @see #clearUseDownload()
124
- * @see #clearLang()
125
- * @see #clearHrefLang()
126
- */
127
- export function clearAllOptional(): void;
128
-
129
- /**
130
- * Builds a html link based on current state.
131
- *
132
- * <p>
133
- * <em>Note!</em> The render method is not thread safe, see <a href="#threadnote">thread note above</a>.
134
- * </p>
135
- * @return a html link, ready to print out on a page
136
- */
137
- export function render(): string;
138
-
139
- /**
140
- * Sets what the link target is, i.e "what the link links to" (href attribute on the a element).
141
- * The target attribute is mandatory when the result is rendered.
142
- * @param aTarget a Node identifying the target
143
- * @see #isValidTarget(javax.jcr.Node)
144
- */
145
- export function setTarget(aTarget: Node): void;
146
-
147
- /**
148
- * Sets what the link target is, i.e "what the link links to" (href attribute on the a element).
149
- * The target attribute is mandatory when the result is rendered.
150
- * @param aTarget a String identifying the target (i.e "http://xyz.com", "?name=a&amp;value=b", "/images/a.gif", "#anchor")
151
- */
152
- export function setStringTarget(aTarget: string): void;
153
-
154
- /**
155
- * Checks if a Node is a renderable target or not (node type accepted).
156
- *
157
- * <p>
158
- * This method can be used to avoid updating this renderer with nodes that can't be rendered. Since nodes that aren't
159
- * renderable will be ignored, updating the renderer with such nodes will result in rendering of previous target.
160
- * </p>
161
- *
162
- * <p>
163
- * <code>LinkRenderer</code> will accept nodes with the following primary node type as targets
164
- * (i.e. this method will return <code>true</code> for such nodes):
165
- * </p>
166
- * <ul>
167
- * <li><code>sv:article</code></li>
168
- * <li><code>sv:collaborationGroup</code></li>
169
- * <li><code>sv:collaborationGroupPage</code></li>
170
- * <li><code>sv:collaborationGroupTemplate</code></li>
171
- * <li><code>sv:file</code></li>
172
- * <li><code>sv:image</code></li>
173
- * <li><code>sv:link</code> <em>(the actual target of the link must also be a valid target)</em></li>
174
- * <li><code>sv:page</code></li>
175
- * <li><code>sv:sitePage</code></li>
176
- * <li><code>sv:structureLink</code> <em>(the actual target of the structure link must also be a valid target)</em></li>
177
- * <li><code>sv:structurePage</code></li>
178
- * <li><code>sv:systemUser</code> <em>(the system user must have a mail address)</em></li>
179
- * <li><code>sv:template</code></li>
180
- * <li><code>sv:user</code> <em>(the user must have a mail address)</em></li>
181
- * <li><code>sv:userIdentity</code> <em>(the site must have a profile page, or backing user must have a mail address)</em></li>
182
- * </ul>
183
- *
184
- * <p>
185
- * Always use this method if you are not sure all nodes you are rendering will be accepted as targets.
186
- * </p>
187
- *
188
- * <p>
189
- * <strong>Example:</strong><br>
190
- * Velocity code like this:
191
- * </p>
192
- * <pre><code>&lt;ul style="list-style:none"&gt;
193
- * #foreach ($node in $myNodes)
194
- * <em>## Update the renderer and render</em>
195
- * $linkRenderer.update($node)
196
- * &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
197
- *#end
198
- *&lt;/ul&gt;</code></pre>
199
- * could be replaced with Velocity code like this:<pre><code>&lt;ul style="list-style:none"&gt;
200
- * #foreach ($node in $myNodes)
201
- * <em>## Ensure node actually can be rendered</em>
202
- * #if ($linkRenderer.isRenderableTarget($node))
203
- * <em>## Update the renderer and render</em>
204
- * $linkRenderer.update($node)
205
- * &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
206
- * #end
207
- * #end
208
- * &lt;/ul&gt;</code></pre>
209
- *
210
- * <p>
211
- * <em>Performance note!</em> Calling this method prior to calling an <code>update</code> method (or the <code>setTarget</code> method)
212
- * will not have any noticeable negative performance impact. The result of this method is internally cached and the <code>update</code>
213
- * methods (and the <code>setTarget</code> method) will re-use that cached data.
214
- * </p>
215
- * @param aNode the node to check
216
- * @return <code>true</code> if <code>aNode</code> is a target that can be rendered, <code>false</code> if not
217
- * @since Sitevision 3.0
218
- * @see #isValidTarget(javax.jcr.Node)
219
- */
220
- export function isRenderableTarget(aNode: Node): boolean;
221
-
222
- /**
223
- * Checks if a Node is a valid target or not (node type accepted and target is valid).
224
- *
225
- * <p>
226
- * This method is similar to the {@link senselogic.sitevision.api.render.LinkRenderer#isRenderableTarget(javax.jcr.Node)} method,
227
- * but this method does more extensive checking to ensure rendered links will be ok. <em>Note! "External" link targets (e.g.
228
- * a link to "www.whatever.com") of a sv:link Node will NOT be checked.</em>
229
- * </p>
230
- * <p>
231
- * This method can be used to avoid updating this renderer with nodes that can't be rendered or nodes that have invalid targets.
232
- * An invalid target is typically an existing link that has an empty or trashed target (i.e. target is in trashcan).
233
- * </p>
234
- *
235
- * <p>
236
- * <strong>Example:</strong><br>
237
- * Velocity code like this:
238
- * </p>
239
- * <pre><code>&lt;ul style="list-style:none"&gt;
240
- * #foreach ($node in $myNodes)
241
- * <em>## Update the renderer and render</em>
242
- * $linkRenderer.update($node)
243
- * &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
244
- *#end
245
- *&lt;/ul&gt;</code></pre>
246
- * could be replaced with Velocity code like this:<pre><code>&lt;ul style="list-style:none"&gt;
247
- * #foreach ($node in $myNodes)
248
- * <em>## Ensure node actually can be rendered</em>
249
- * #if ($linkRenderer.isValidTarget($node))
250
- * <em>## Update the renderer and render</em>
251
- * $linkRenderer.update($node)
252
- * &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
253
- * #end
254
- * #end
255
- * &lt;/ul&gt;</code></pre>
256
- *
257
- * <p>
258
- * <em>Performance note!</em> Avoid subsequent calls to this method for same <code>Node</code>. If performance is a top
259
- * priority, consider using {@link senselogic.sitevision.api.render.LinkRenderer#isRenderableTarget(javax.jcr.Node)} instead.
260
- * </p>
261
- * @param aNode the node to check
262
- * @return <code>true</code> if <code>aNode</code> is a target that can be rendered as a functional link, <code>false</code> if not
263
- * @since Sitevision 2.6.2
264
- * @see #isRenderableTarget(javax.jcr.Node)
265
- */
266
- export function isValidTarget(aNode: Node): boolean;
267
-
268
- /**
269
- * Sets the class name the link should use (class attribute on the a element).
270
- * The fontClass attribute is mandatory when the result is rendered.
271
- * @param aFontClass the class name of the font to use
272
- */
273
- export function setFontClass(aFontClass: string): void;
274
-
275
- /**
276
- * Sets the class name the link should use (class attribute on an a element) based on a given font node.
277
- *
278
- * <p>
279
- * The actual font class is extracted from aFontNode and if aFontNode is <code>null</code> or not a valid font node the
280
- * font class will not be set.
281
- * </p>
282
- * <p>
283
- * When subsequently setting the font class, use the {@link #setFontClass(String)} method instead for best performance.
284
- * </p>
285
- * @param aFontNode the font node that has a font class that can be extracted
286
- * @see #setFontClass(String)
287
- */
288
- export function setFont(aFontNode: Node): void;
289
-
290
- /**
291
- * Sets the text that the link should display, i.e. "the text the user clicks on".
292
- * The text attribute is mandatory when the result is rendered.
293
- * @param aText a link text
294
- */
295
- export function setText(aText: string): void;
296
-
297
- /**
298
- * Sets the title the link should have (title attribute on the a element).
299
- *
300
- * <p>
301
- * If there are no title (i.e. it is <code>null</code>) when the result is rendered, it will get the same
302
- * value as text attribute if autoTitle is activated, otherwise it will be empty. Default is <code>null</code>.
303
- * </p>
304
- * @param aTitle a title describing the link
305
- */
306
- export function setTitle(aTitle: string): void;
307
-
308
- /**
309
- * Removes the title, i.e. executes <code>setTitle(null)</code>
310
- * @see #setTitle(String)
311
- */
312
- export function removeTitle(): void;
313
-
314
- /**
315
- * Sets the css style the link should have (style attribute on the a element).
316
- * The style attribute is optional when the result is rendered. Default is <code>null</code>.
317
- * @param aStyle the style of the link
318
- */
319
- export function setStyle(aStyle: string): void;
320
-
321
- /**
322
- * Removes the style, i.e executes <code>setStyle(null)</code>
323
- * @see #setStyle(String)
324
- */
325
- export function clearStyle(): void;
326
-
327
- /**
328
- * Sets the lang attribute on the a element (defines the language of the element).
329
- * @param aLang a single language code
330
- * @since Sitevision 2022.10.1
331
- */
332
- export function setLang(aLang: string): void;
333
-
334
- /**
335
- * Removes the lang, i.e executes <code>setLang(null)</code>
336
- * @see #setLang(String)
337
- * @since Sitevision 2022.10.1
338
- */
339
- export function clearLang(): void;
340
-
341
- /**
342
- * Sets the hreflang attribute on the a element (hints at the language of the linked resource).
343
- * @param aHrefLang a single language code
344
- * @since Sitevision 2022.10.1
345
- */
346
- export function setHrefLang(aHrefLang: string): void;
347
-
348
- /**
349
- * Removes the hreflang, i.e executes <code>setHrefLang(null)</code>
350
- * @see #setHrefLang(String)
351
- * @since Sitevision 2022.10.1
352
- */
353
- export function clearHrefLang(): void;
354
-
355
- /**
356
- * Adds target parameters (key=value) to the link target (href attribute on the a element).
357
- *
358
- * <p>
359
- * Target parameters is optional when the result is rendered. Default is no target parameters.
360
- * </p>
361
- * <p>
362
- * There can only be one target parameter per key (i.e. when a target parameter is added it will always replace the possibly existing
363
- * target parameter that already use that key).
364
- * </p>
365
- * @param key the key of the target parameter
366
- * @param value the value of the target parameter
367
- */
368
- export function addTargetParameter(key: string, value: string): void;
369
-
370
- /**
371
- * Removes all existing target parameters
372
-
373
- */
374
- export function clearTargetParameters(): void;
375
-
376
- /**
377
- * Should target parameters be URL encoded or not?
378
- * Default is <code>true</code>.
379
- * @param performParameterEncoding whether parameters should be URL encoded or not.
380
- * @see senselogic.sitevision.api.text.EndecUtil#encodeURL(String)
381
- * @since Sitevision 3.0
382
- */
383
- export function setUseParameterEncoding(
384
- performParameterEncoding: boolean
385
- ): void;
386
-
387
- /**
388
- * Utility method for executing <code>setUseParameterEncoding(true)</code>
389
- * @see #setUseParameterEncoding(boolean)
390
- * @since Sitevision 3.0
391
- */
392
- export function forceUseParameterEncoding(): void;
393
-
394
- /**
395
- * Utility method for executing <code>setUseParameterEncoding(false)</code>
396
- * @see #setUseParameterEncoding(boolean)
397
- * @since Sitevision 3.0
398
- */
399
- export function clearUseParameterEncoding(): void;
400
-
401
- /**
402
- * Adds an HTML5 data-* attribute to the link element.
403
- * Data attributes is optional when the result is rendered. Default is no data attributes.
404
- * <p>
405
- * There can only be one data attribute per name (i.e. when a data attribute is added it will always replace the possibly existing
406
- * data attribute that already use that name).
407
- * </p>
408
- *
409
- * <p>
410
- * Notes about names and values:
411
- * </p>
412
- * <ul>
413
- * <li>
414
- * A <strong>name</strong> that is <code>null</code> or <em>whitespace-only</em> will be completely ignored,
415
- * i.e. no data attribute will be rendered.
416
- * </li>
417
- * <li>
418
- * A <strong>name</strong> that isn't properly prefixed with <em>"data-"</em> will be prefixed when the data attribute is rendered.
419
- * </li>
420
- * <li>
421
- * A <strong>value</strong> that is <code>null</code> or <em>whitespace-only</em> will be rendered as a data attribute without value.
422
- * </li>
423
- * <li>
424
- * A <strong>value</strong> should not be escaped/encoded. The <em>useEncoding</em> attribute will determine what to do
425
- * when the data attributes are rendered.
426
- * </ul>
427
- * @param aName the name of the data attribute
428
- * @param aValue the value of the data attribute
429
- * @since Sitevision 3.0
430
- */
431
- export function addDataAttribute(aName: string, aValue: string): void;
432
-
433
- /**
434
- * Removes all existing data attributes
435
- * @since Sitevision 3.0
436
- */
437
- export function clearDataAttributes(): void;
438
-
439
- /**
440
- * Sets what access key the link should have (accesskey attribute on the a element)
441
- * The accesskey attribute is optional when the result is rendered. Default is <code>null</code>.
442
- * @param anAccessKey the access key that should be used
443
- */
444
- export function setAccessKey(anAccessKey: string): void;
445
-
446
- /**
447
- * Removes the accesskey, i.e. executes <code>setAccessKey(null)</code>
448
- * @see #setAccessKey(String)
449
- */
450
- export function clearAccessKey(): void;
451
-
452
- /**
453
- * Sets the rel that should be used (rel attribute on the a element)
454
- * The rel attribute is optional when the result is rendered. Default is <code>null</code>.
455
- * @param aRel the rel that should be used. Note! If "external" is used, the rendered link will be opened in a new window via JavaScript
456
- */
457
- export function setRel(aRel: string): void;
458
-
459
- /**
460
- * Removes the rel value, i.e executes <code>setRel(null)</code>
461
- * @see #setRel(String)
462
- */
463
- export function clearRel(): void;
464
-
465
- /**
466
- * Sets the onclick value (onclick attribute and onkeypress attribute on the a element), typically some kind of Javascript
467
- * The onclick attribute is optional when the result is rendered. Default is <code>null</code>.
468
- *
469
- * <p><em>Note!</em> The events (onclick, onkeypress) will be added with non-obtrusive javascript when render() is called.</p>
470
- * @param anOnclick the onClick value that should be used
471
- */
472
- export function setOnclick(anOnclick: string): void;
473
-
474
- /**
475
- * Removes the onclick value, i.e executes <code>setOnclick(null)</code>
476
- * @see #setOnclick(String)
477
- */
478
- export function clearOnclick(): void;
479
-
480
- /**
481
- * Sets the id value (id attribute on the a element), most likely only needed if some kind of javascript/ajax code needs to access the
482
- * rendered link via its id.
483
- *
484
- * <p>
485
- * The id attribute is optional when the result is rendered. Default is <code>null</code>.
486
- * </p>
487
- * <p>
488
- * This method does <em>not</em> perform any checks of the id. All values will be accepted.
489
- * <em>(Note! A valid id should be unique - i.e. should not appear more than once in a html/xhtml document - and not all characters are allowed.
490
- * See <a href="http://www.w3.org/TR/2006/REC-xml-20060816/#sec-attribute-types">W3C 3.3.1 Attribute types</a>.)</em>
491
- * </p>
492
- * @param anId the id value that should be used
493
- * @since Sitevision 3.0
494
- */
495
- export function setId(anId: string): void;
496
-
497
- /**
498
- * Removes the id value, i.e executes <code>setId(null)</code>
499
- * @see #setId(String)
500
- * @since Sitevision 3.0
501
- */
502
- export function clearId(): void;
503
-
504
- /**
505
- * Use icons for "external", "new window" and "new window, external" according to Site's settings or not.
506
- * Default is <code>true</code>.
507
- * @param useLinkDecorationSettings whether or not Site's settings for link type icons should be used
508
- */
509
- export function setUseLinkDecorationSettings(
510
- useLinkDecorationSettings: boolean
511
- ): void;
512
-
513
- /**
514
- * Utility method for executing <code>setUseLinkDecorationSettings(true)</code>
515
- * @see #setUseLinkDecorationSettings(boolean)
516
- */
517
- export function forceUseLinkDecorationSettings(): void;
518
-
519
- /**
520
- * Utility method for executing <code>setUseLinkDecorationSettings(false)</code>
521
- * @see #setUseLinkDecorationSettings(boolean)
522
- */
523
- export function clearUseLinkDecorationSettings(): void;
524
-
525
- /**
526
- * Use icons/descriptions for known file types according to Site's settings or not.
527
- * Default is <code>true</code>.
528
- * @param useResourceDecorationSettings whether or not Site's settings for icons/descriptions for known file types should be used
529
- */
530
- export function setUseResourceDecorationSettings(
531
- useResourceDecorationSettings: boolean
532
- ): void;
533
-
534
- /**
535
- * Utility method for executing <code>setUseResourceDecorationSettings(true)</code>
536
- * @see #setUseResourceDecorationSettings(boolean)
537
- */
538
- export function forceUseResourceDecorationSettings(): void;
539
-
540
- /**
541
- * Utility method for executing <code>setUseResourceDecorationSettings(false)</code>
542
- * @see #setUseResourceDecorationSettings(boolean)
543
- */
544
- export function clearUseResourceDecorationSettings(): void;
545
-
546
- /**
547
- * Should the link target be opened in a new window or not?
548
- * Default is <code>false</code>.
549
- * @param openNewWindow whether or not the link target should be opened in a new window
550
- */
551
- export function setOpenNewWindow(openNewWindow: boolean): void;
552
-
553
- /**
554
- * Utility method for executing <code>setOpenNewWindow(true)</code>
555
- * @see #setOpenNewWindow(boolean)
556
- */
557
- export function forceOpenNewWindow(): void;
558
-
559
- /**
560
- * Utility method for executing <code>setOpenNewWindow(false)</code>
561
- * @see #setOpenNewWindow(boolean)
562
- */
563
- export function clearOpenNewWindow(): void;
564
-
565
- /**
566
- * Should the browser download the link target instead of navigating to it?
567
- * Default is <code>false</code>.
568
- * @param useDownload whether a browser is suggested to download the link target directly
569
- * @since Sitevision 5.2
570
- */
571
- export function setUseDownload(useDownload: boolean): void;
572
-
573
- /**
574
- * Utility method for executing <code>setUseDownload(true)</code>
575
- * @see #setUseDownload(boolean)
576
- * @since Sitevision 5.2
577
- */
578
- export function forceUseDownload(): void;
579
-
580
- /**
581
- * Utility method for executing <code>setUseDownload(false)</code>
582
- * @see #setUseDownload(boolean)
583
- * @since Sitevision 5.2
584
- */
585
- export function clearUseDownload(): void;
586
-
587
- /**
588
- * Should text and attributes be properly encoded or not?
589
- * Default is <code>true</code>.
590
- * @param performEncoding whether text should be encoded or not.
591
- */
592
- export function setUseEncoding(performEncoding: boolean): void;
593
-
594
- /**
595
- * Utility method for executing <code>setUseEncoding(true)</code>
596
- * @see #setUseEncoding(boolean)
597
- */
598
- export function forceUseEncoding(): void;
599
-
600
- /**
601
- * Utility method for executing <code>setUseEncoding(false)</code>
602
- * @see #setUseEncoding(boolean)
603
- */
604
- export function clearUseEncoding(): void;
605
-
606
- /**
607
- * Ensures title always will have a value. If non-existing, the title will be set to the title of the target target (or
608
- * the same as the linked text if the target isn't a page or the title of the page is lacking)
609
- * Default is <code>false</code>.
610
- * @param useAutoTitle whether or not the link always should get the title automatically if title is missing
611
- */
612
- export function setUseAutoTitle(useAutoTitle: boolean): void;
613
-
614
- /**
615
- * Utility method for executing <code>setUseAutoTitle(true)</code>
616
- * @see #setUseAutoTitle(boolean)
617
- */
618
- export function forceUseAutoTitle(): void;
619
-
620
- /**
621
- * Utility method for executing <code>setUseAutoTitle(false)</code>
622
- * @see #setUseAutoTitle(boolean)
623
- */
624
- export function clearUseAutoTitle(): void;
625
-
626
- /**
627
- * Should cross-site internal Node links be handled or not?
628
- *
629
- * <p>
630
- * Default is <code>false</code>.
631
- * </p>
632
- * <p>
633
- * <em>Note! For best performance: enable only if your site actually contains internal links to
634
- * pages on other sites (e.g. The System user creates an internal link and selects a page
635
- * on another site in the target browse tree).</em>
636
- * </p>
637
- * @param useCrossSiteTargetChecking whether or not to check for cross-site Node targets
638
- * @since Sitevision 3.0.2
639
- */
640
- export function setUseCrossSiteTargetChecking(
641
- useCrossSiteTargetChecking: boolean
642
- ): void;
643
-
644
- /**
645
- * Utility method for executing <code>setUseCrossSiteTargetChecking(true)</code>
646
- * @see #setUseCrossSiteTargetChecking(boolean)
647
- * @since Sitevision 3.0.2
648
- */
649
- export function forceUseCrossSiteTargetChecking(): void;
650
-
651
- /**
652
- * Utility method for executing <code>seUseCrossSiteTargetChecking(false)</code>
653
- * @see #setUseCrossSiteTargetChecking(boolean)
654
- * @since Sitevision 3.0.2
655
- */
656
- export function clearUseCrossSiteTargetChecking(): void;
1
+ import type Node from "../../types/javax/jcr/Node";
657
2
 
658
3
  /**
659
4
  * LinkRenderer is a stateful utility interface that can be used to build valid html text links that uses link icons according to the
@@ -888,64 +233,655 @@ export function clearUseCrossSiteTargetChecking(): void;
888
233
  * </p>
889
234
  * @author Magnus Lövgren
890
235
  */
891
- declare namespace linkRenderer {
892
- export {
893
- update,
894
- updateClean,
895
- clearAllOptional,
896
- render,
897
- setTarget,
898
- setStringTarget,
899
- isRenderableTarget,
900
- isValidTarget,
901
- setFontClass,
902
- setFont,
903
- setText,
904
- setTitle,
905
- removeTitle,
906
- setStyle,
907
- clearStyle,
908
- setLang,
909
- clearLang,
910
- setHrefLang,
911
- clearHrefLang,
912
- addTargetParameter,
913
- clearTargetParameters,
914
- setUseParameterEncoding,
915
- forceUseParameterEncoding,
916
- clearUseParameterEncoding,
917
- addDataAttribute,
918
- clearDataAttributes,
919
- setAccessKey,
920
- clearAccessKey,
921
- setRel,
922
- clearRel,
923
- setOnclick,
924
- clearOnclick,
925
- setId,
926
- clearId,
927
- setUseLinkDecorationSettings,
928
- forceUseLinkDecorationSettings,
929
- clearUseLinkDecorationSettings,
930
- setUseResourceDecorationSettings,
931
- forceUseResourceDecorationSettings,
932
- clearUseResourceDecorationSettings,
933
- setOpenNewWindow,
934
- forceOpenNewWindow,
935
- clearOpenNewWindow,
936
- setUseDownload,
937
- forceUseDownload,
938
- clearUseDownload,
939
- setUseEncoding,
940
- forceUseEncoding,
941
- clearUseEncoding,
942
- setUseAutoTitle,
943
- forceUseAutoTitle,
944
- clearUseAutoTitle,
945
- setUseCrossSiteTargetChecking,
946
- forceUseCrossSiteTargetChecking,
947
- clearUseCrossSiteTargetChecking,
948
- };
236
+ export interface LinkRenderer {
237
+ /**
238
+ * Updates current state.
239
+ * @param aTarget the target of the link (href attribute for the a element)
240
+ * @param aFontClass the class name the link should use (class attribute for the a element)
241
+ * @param aText the link text
242
+ * @param aTitle the title of the link (title attribute for the a element)
243
+ * @see #isValidTarget(javax.jcr.Node)
244
+ */
245
+ update(
246
+ aTarget: Node,
247
+ aFontClass: string,
248
+ aText: string,
249
+ aTitle: string
250
+ ): void;
251
+
252
+ /**
253
+ * Updates current state and removes previous title.
254
+ * @param aTarget the target of the link (href attribute for the a element)
255
+ * @param aFontClass the class name the link should use (class attribute for the a element)
256
+ * @param aText the link text
257
+ * @see #isValidTarget(javax.jcr.Node)
258
+ */
259
+ update(aTarget: Node, aFontClass: string, aText: string): void;
260
+
261
+ /**
262
+ * Updates current state and removes previous title.
263
+ * @param aTarget the target of the link (href attribute for the a element)
264
+ * @param aText the link text
265
+ * @see #isValidTarget(javax.jcr.Node)
266
+ */
267
+ update(aTarget: Node, aText: string): void;
268
+
269
+ /**
270
+ * Updates current state and removes previous title and text.
271
+ *
272
+ * <p>
273
+ * Note. If no text exists when rendering, the target Node will be used to determine an appropriate text
274
+ * (e.g. the display name if the node is a page).
275
+ * </p>
276
+ * @param aTarget the target of the link (href attribute for the a element)
277
+ * @see #isValidTarget(javax.jcr.Node)
278
+ */
279
+ update(aTarget: Node): void;
280
+
281
+ /**
282
+ * Updates current state and removes all optional attributes.
283
+ * @param aTarget the target of the link (href attribute for the a element)
284
+ * @param aFontClass the class name the link should use (class attribute for the a element)
285
+ * @param aText the link text
286
+ * @param aTitle the title of the link (title attribute for the a element)
287
+ * @see #clearAllOptional()
288
+ * @see #isValidTarget(javax.jcr.Node)
289
+ */
290
+ updateClean(
291
+ aTarget: Node,
292
+ aFontClass: string,
293
+ aText: string,
294
+ aTitle: string
295
+ ): void;
296
+
297
+ /**
298
+ * Updates current state and removes all optional attributes and title.
299
+ * @param aTarget the target of the link (href attribute for the a element)
300
+ * @param aFontClass the class name the link should use (class attribute for the a element)
301
+ * @param aText the link text
302
+ * @see #clearAllOptional()
303
+ * @see #isValidTarget(javax.jcr.Node)
304
+ */
305
+ updateClean(aTarget: Node, aFontClass: string, aText: string): void;
306
+
307
+ /**
308
+ * Updates current state and removes all optional attributes and title.
309
+ * @param aTarget the target of the link (href attribute for the a element)
310
+ * @param aText the link text
311
+ * @see #clearAllOptional()
312
+ * @see #isValidTarget(javax.jcr.Node)
313
+ */
314
+ updateClean(aTarget: Node, aText: string): void;
315
+
316
+ /**
317
+ * Updates current state and removes all optional attributes, title and text.
318
+ *
319
+ * <p>
320
+ * Note. If no text exists when rendering, the target Node will be used to determine an appropriate text
321
+ * (e.g. the display name if the node is a page).
322
+ * </p>
323
+ * @param aTarget the target of the link (href attribute for the a element)
324
+ * @see #clearAllOptional()
325
+ * @see #isValidTarget(javax.jcr.Node)
326
+ */
327
+ updateClean(aTarget: Node): void;
328
+
329
+ /**
330
+ * Removes all optional settings.
331
+ * In other words - executing this method has the same effect as executing:
332
+ * <ul>
333
+ * <li><code>clearStyle()</code></li>
334
+ * <li><code>clearOnclick()</code></li>
335
+ * <li><code>clearId()</code></li>
336
+ * <li><code>clearTargetParameters()</code></li>
337
+ * <li><code>clearRel()</code></li>
338
+ * <li><code>clearAccessKey()</code></li>
339
+ * <li><code>clearOpenNewWindow()</code></li>
340
+ * <li><code>clearDataAttributes()</code></li>
341
+ * <li><code>clearUseDownload()</code></li>
342
+ * <li><code>clearLang()</code></li>
343
+ * <li><code>clearHrefLang()</code></li>
344
+ * </ul>
345
+ * @see #clearStyle()
346
+ * @see #clearOnclick()
347
+ * @see #clearId()
348
+ * @see #clearTargetParameters()
349
+ * @see #clearRel()
350
+ * @see #clearAccessKey()
351
+ * @see #clearOpenNewWindow()
352
+ * @see #clearDataAttributes()
353
+ * @see #clearUseDownload()
354
+ * @see #clearLang()
355
+ * @see #clearHrefLang()
356
+ */
357
+ clearAllOptional(): void;
358
+
359
+ /**
360
+ * Builds a html link based on current state.
361
+ *
362
+ * <p>
363
+ * <em>Note!</em> The render method is not thread safe, see <a href="#threadnote">thread note above</a>.
364
+ * </p>
365
+ * @return a html link, ready to print out on a page
366
+ */
367
+ render(): string;
368
+
369
+ /**
370
+ * Sets what the link target is, i.e "what the link links to" (href attribute on the a element).
371
+ * The target attribute is mandatory when the result is rendered.
372
+ * @param aTarget a Node identifying the target
373
+ * @see #isValidTarget(javax.jcr.Node)
374
+ */
375
+ setTarget(aTarget: Node): void;
376
+
377
+ /**
378
+ * Sets what the link target is, i.e "what the link links to" (href attribute on the a element).
379
+ * The target attribute is mandatory when the result is rendered.
380
+ * @param aTarget a String identifying the target (i.e "http://xyz.com", "?name=a&amp;value=b", "/images/a.gif", "#anchor")
381
+ */
382
+ setStringTarget(aTarget: string): void;
383
+
384
+ /**
385
+ * Checks if a Node is a renderable target or not (node type accepted).
386
+ *
387
+ * <p>
388
+ * This method can be used to avoid updating this renderer with nodes that can't be rendered. Since nodes that aren't
389
+ * renderable will be ignored, updating the renderer with such nodes will result in rendering of previous target.
390
+ * </p>
391
+ *
392
+ * <p>
393
+ * <code>LinkRenderer</code> will accept nodes with the following primary node type as targets
394
+ * (i.e. this method will return <code>true</code> for such nodes):
395
+ * </p>
396
+ * <ul>
397
+ * <li><code>sv:article</code></li>
398
+ * <li><code>sv:collaborationGroup</code></li>
399
+ * <li><code>sv:collaborationGroupPage</code></li>
400
+ * <li><code>sv:collaborationGroupTemplate</code></li>
401
+ * <li><code>sv:file</code></li>
402
+ * <li><code>sv:image</code></li>
403
+ * <li><code>sv:link</code> <em>(the actual target of the link must also be a valid target)</em></li>
404
+ * <li><code>sv:page</code></li>
405
+ * <li><code>sv:sitePage</code></li>
406
+ * <li><code>sv:structureLink</code> <em>(the actual target of the structure link must also be a valid target)</em></li>
407
+ * <li><code>sv:structurePage</code></li>
408
+ * <li><code>sv:systemUser</code> <em>(the system user must have a mail address)</em></li>
409
+ * <li><code>sv:template</code></li>
410
+ * <li><code>sv:user</code> <em>(the user must have a mail address)</em></li>
411
+ * <li><code>sv:userIdentity</code> <em>(the site must have a profile page, or backing user must have a mail address)</em></li>
412
+ * </ul>
413
+ *
414
+ * <p>
415
+ * Always use this method if you are not sure all nodes you are rendering will be accepted as targets.
416
+ * </p>
417
+ *
418
+ * <p>
419
+ * <strong>Example:</strong><br>
420
+ * Velocity code like this:
421
+ * </p>
422
+ * <pre><code>&lt;ul style="list-style:none"&gt;
423
+ * #foreach ($node in $myNodes)
424
+ * <em>## Update the renderer and render</em>
425
+ * $linkRenderer.update($node)
426
+ * &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
427
+ *#end
428
+ *&lt;/ul&gt;</code></pre>
429
+ * could be replaced with Velocity code like this:<pre><code>&lt;ul style="list-style:none"&gt;
430
+ * #foreach ($node in $myNodes)
431
+ * <em>## Ensure node actually can be rendered</em>
432
+ * #if ($linkRenderer.isRenderableTarget($node))
433
+ * <em>## Update the renderer and render</em>
434
+ * $linkRenderer.update($node)
435
+ * &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
436
+ * #end
437
+ * #end
438
+ * &lt;/ul&gt;</code></pre>
439
+ *
440
+ * <p>
441
+ * <em>Performance note!</em> Calling this method prior to calling an <code>update</code> method (or the <code>setTarget</code> method)
442
+ * will not have any noticeable negative performance impact. The result of this method is internally cached and the <code>update</code>
443
+ * methods (and the <code>setTarget</code> method) will re-use that cached data.
444
+ * </p>
445
+ * @param aNode the node to check
446
+ * @return <code>true</code> if <code>aNode</code> is a target that can be rendered, <code>false</code> if not
447
+ * @since Sitevision 3.0
448
+ * @see #isValidTarget(javax.jcr.Node)
449
+ */
450
+ isRenderableTarget(aNode: Node): boolean;
451
+
452
+ /**
453
+ * Checks if a Node is a valid target or not (node type accepted and target is valid).
454
+ *
455
+ * <p>
456
+ * This method is similar to the {@link senselogic.sitevision.api.render.LinkRenderer#isRenderableTarget(javax.jcr.Node)} method,
457
+ * but this method does more extensive checking to ensure rendered links will be ok. <em>Note! "External" link targets (e.g.
458
+ * a link to "www.whatever.com") of a sv:link Node will NOT be checked.</em>
459
+ * </p>
460
+ * <p>
461
+ * This method can be used to avoid updating this renderer with nodes that can't be rendered or nodes that have invalid targets.
462
+ * An invalid target is typically an existing link that has an empty or trashed target (i.e. target is in trashcan).
463
+ * </p>
464
+ *
465
+ * <p>
466
+ * <strong>Example:</strong><br>
467
+ * Velocity code like this:
468
+ * </p>
469
+ * <pre><code>&lt;ul style="list-style:none"&gt;
470
+ * #foreach ($node in $myNodes)
471
+ * <em>## Update the renderer and render</em>
472
+ * $linkRenderer.update($node)
473
+ * &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
474
+ *#end
475
+ *&lt;/ul&gt;</code></pre>
476
+ * could be replaced with Velocity code like this:<pre><code>&lt;ul style="list-style:none"&gt;
477
+ * #foreach ($node in $myNodes)
478
+ * <em>## Ensure node actually can be rendered</em>
479
+ * #if ($linkRenderer.isValidTarget($node))
480
+ * <em>## Update the renderer and render</em>
481
+ * $linkRenderer.update($node)
482
+ * &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
483
+ * #end
484
+ * #end
485
+ * &lt;/ul&gt;</code></pre>
486
+ *
487
+ * <p>
488
+ * <em>Performance note!</em> Avoid subsequent calls to this method for same <code>Node</code>. If performance is a top
489
+ * priority, consider using {@link senselogic.sitevision.api.render.LinkRenderer#isRenderableTarget(javax.jcr.Node)} instead.
490
+ * </p>
491
+ * @param aNode the node to check
492
+ * @return <code>true</code> if <code>aNode</code> is a target that can be rendered as a functional link, <code>false</code> if not
493
+ * @since Sitevision 2.6.2
494
+ * @see #isRenderableTarget(javax.jcr.Node)
495
+ */
496
+ isValidTarget(aNode: Node): boolean;
497
+
498
+ /**
499
+ * Sets the class name the link should use (class attribute on the a element).
500
+ * The fontClass attribute is mandatory when the result is rendered.
501
+ * @param aFontClass the class name of the font to use
502
+ */
503
+ setFontClass(aFontClass: string): void;
504
+
505
+ /**
506
+ * Sets the class name the link should use (class attribute on an a element) based on a given font node.
507
+ *
508
+ * <p>
509
+ * The actual font class is extracted from aFontNode and if aFontNode is <code>null</code> or not a valid font node the
510
+ * font class will not be set.
511
+ * </p>
512
+ * <p>
513
+ * When subsequently setting the font class, use the {@link #setFontClass(String)} method instead for best performance.
514
+ * </p>
515
+ * @param aFontNode the font node that has a font class that can be extracted
516
+ * @see #setFontClass(String)
517
+ */
518
+ setFont(aFontNode: Node): void;
519
+
520
+ /**
521
+ * Sets the text that the link should display, i.e. "the text the user clicks on".
522
+ * The text attribute is mandatory when the result is rendered.
523
+ * @param aText a link text
524
+ */
525
+ setText(aText: string): void;
526
+
527
+ /**
528
+ * Sets the title the link should have (title attribute on the a element).
529
+ *
530
+ * <p>
531
+ * If there are no title (i.e. it is <code>null</code>) when the result is rendered, it will get the same
532
+ * value as text attribute if autoTitle is activated, otherwise it will be empty. Default is <code>null</code>.
533
+ * </p>
534
+ * @param aTitle a title describing the link
535
+ */
536
+ setTitle(aTitle: string): void;
537
+
538
+ /**
539
+ * Removes the title, i.e. executes <code>setTitle(null)</code>
540
+ * @see #setTitle(String)
541
+ */
542
+ removeTitle(): void;
543
+
544
+ /**
545
+ * Sets the css style the link should have (style attribute on the a element).
546
+ * The style attribute is optional when the result is rendered. Default is <code>null</code>.
547
+ * @param aStyle the style of the link
548
+ */
549
+ setStyle(aStyle: string): void;
550
+
551
+ /**
552
+ * Removes the style, i.e executes <code>setStyle(null)</code>
553
+ * @see #setStyle(String)
554
+ */
555
+ clearStyle(): void;
556
+
557
+ /**
558
+ * Sets the lang attribute on the a element (defines the language of the element).
559
+ * @param aLang a single language code
560
+ * @since Sitevision 2022.10.1
561
+ */
562
+ setLang(aLang: string): void;
563
+
564
+ /**
565
+ * Removes the lang, i.e executes <code>setLang(null)</code>
566
+ * @see #setLang(String)
567
+ * @since Sitevision 2022.10.1
568
+ */
569
+ clearLang(): void;
570
+
571
+ /**
572
+ * Sets the hreflang attribute on the a element (hints at the language of the linked resource).
573
+ * @param aHrefLang a single language code
574
+ * @since Sitevision 2022.10.1
575
+ */
576
+ setHrefLang(aHrefLang: string): void;
577
+
578
+ /**
579
+ * Removes the hreflang, i.e executes <code>setHrefLang(null)</code>
580
+ * @see #setHrefLang(String)
581
+ * @since Sitevision 2022.10.1
582
+ */
583
+ clearHrefLang(): void;
584
+
585
+ /**
586
+ * Adds target parameters (key=value) to the link target (href attribute on the a element).
587
+ *
588
+ * <p>
589
+ * Target parameters is optional when the result is rendered. Default is no target parameters.
590
+ * </p>
591
+ * <p>
592
+ * There can only be one target parameter per key (i.e. when a target parameter is added it will always replace the possibly existing
593
+ * target parameter that already use that key).
594
+ * </p>
595
+ * @param key the key of the target parameter
596
+ * @param value the value of the target parameter
597
+ */
598
+ addTargetParameter(key: string, value: string): void;
599
+
600
+ /**
601
+ * Removes all existing target parameters
602
+
603
+ */
604
+ clearTargetParameters(): void;
605
+
606
+ /**
607
+ * Should target parameters be URL encoded or not?
608
+ * Default is <code>true</code>.
609
+ * @param performParameterEncoding whether parameters should be URL encoded or not.
610
+ * @see senselogic.sitevision.api.text.EndecUtil#encodeURL(String)
611
+ * @since Sitevision 3.0
612
+ */
613
+ setUseParameterEncoding(performParameterEncoding: boolean): void;
614
+
615
+ /**
616
+ * Utility method for executing <code>setUseParameterEncoding(true)</code>
617
+ * @see #setUseParameterEncoding(boolean)
618
+ * @since Sitevision 3.0
619
+ */
620
+ forceUseParameterEncoding(): void;
621
+
622
+ /**
623
+ * Utility method for executing <code>setUseParameterEncoding(false)</code>
624
+ * @see #setUseParameterEncoding(boolean)
625
+ * @since Sitevision 3.0
626
+ */
627
+ clearUseParameterEncoding(): void;
628
+
629
+ /**
630
+ * Adds an HTML5 data-* attribute to the link element.
631
+ * Data attributes is optional when the result is rendered. Default is no data attributes.
632
+ * <p>
633
+ * There can only be one data attribute per name (i.e. when a data attribute is added it will always replace the possibly existing
634
+ * data attribute that already use that name).
635
+ * </p>
636
+ *
637
+ * <p>
638
+ * Notes about names and values:
639
+ * </p>
640
+ * <ul>
641
+ * <li>
642
+ * A <strong>name</strong> that is <code>null</code> or <em>whitespace-only</em> will be completely ignored,
643
+ * i.e. no data attribute will be rendered.
644
+ * </li>
645
+ * <li>
646
+ * A <strong>name</strong> that isn't properly prefixed with <em>"data-"</em> will be prefixed when the data attribute is rendered.
647
+ * </li>
648
+ * <li>
649
+ * A <strong>value</strong> that is <code>null</code> or <em>whitespace-only</em> will be rendered as a data attribute without value.
650
+ * </li>
651
+ * <li>
652
+ * A <strong>value</strong> should not be escaped/encoded. The <em>useEncoding</em> attribute will determine what to do
653
+ * when the data attributes are rendered.
654
+ * </ul>
655
+ * @param aName the name of the data attribute
656
+ * @param aValue the value of the data attribute
657
+ * @since Sitevision 3.0
658
+ */
659
+ addDataAttribute(aName: string, aValue: string): void;
660
+
661
+ /**
662
+ * Removes all existing data attributes
663
+ * @since Sitevision 3.0
664
+ */
665
+ clearDataAttributes(): void;
666
+
667
+ /**
668
+ * Sets what access key the link should have (accesskey attribute on the a element)
669
+ * The accesskey attribute is optional when the result is rendered. Default is <code>null</code>.
670
+ * @param anAccessKey the access key that should be used
671
+ */
672
+ setAccessKey(anAccessKey: string): void;
673
+
674
+ /**
675
+ * Removes the accesskey, i.e. executes <code>setAccessKey(null)</code>
676
+ * @see #setAccessKey(String)
677
+ */
678
+ clearAccessKey(): void;
679
+
680
+ /**
681
+ * Sets the rel that should be used (rel attribute on the a element)
682
+ * The rel attribute is optional when the result is rendered. Default is <code>null</code>.
683
+ * @param aRel the rel that should be used. Note! If "external" is used, the rendered link will be opened in a new window via JavaScript
684
+ */
685
+ setRel(aRel: string): void;
686
+
687
+ /**
688
+ * Removes the rel value, i.e executes <code>setRel(null)</code>
689
+ * @see #setRel(String)
690
+ */
691
+ clearRel(): void;
692
+
693
+ /**
694
+ * Sets the onclick value (onclick attribute and onkeypress attribute on the a element), typically some kind of Javascript
695
+ * The onclick attribute is optional when the result is rendered. Default is <code>null</code>.
696
+ *
697
+ * <p><em>Note!</em> The events (onclick, onkeypress) will be added with non-obtrusive javascript when render() is called.</p>
698
+ * @param anOnclick the onClick value that should be used
699
+ */
700
+ setOnclick(anOnclick: string): void;
701
+
702
+ /**
703
+ * Removes the onclick value, i.e executes <code>setOnclick(null)</code>
704
+ * @see #setOnclick(String)
705
+ */
706
+ clearOnclick(): void;
707
+
708
+ /**
709
+ * Sets the id value (id attribute on the a element), most likely only needed if some kind of javascript/ajax code needs to access the
710
+ * rendered link via its id.
711
+ *
712
+ * <p>
713
+ * The id attribute is optional when the result is rendered. Default is <code>null</code>.
714
+ * </p>
715
+ * <p>
716
+ * This method does <em>not</em> perform any checks of the id. All values will be accepted.
717
+ * <em>(Note! A valid id should be unique - i.e. should not appear more than once in a html/xhtml document - and not all characters are allowed.
718
+ * See <a href="http://www.w3.org/TR/2006/REC-xml-20060816/#sec-attribute-types">W3C 3.3.1 Attribute types</a>.)</em>
719
+ * </p>
720
+ * @param anId the id value that should be used
721
+ * @since Sitevision 3.0
722
+ */
723
+ setId(anId: string): void;
724
+
725
+ /**
726
+ * Removes the id value, i.e executes <code>setId(null)</code>
727
+ * @see #setId(String)
728
+ * @since Sitevision 3.0
729
+ */
730
+ clearId(): void;
731
+
732
+ /**
733
+ * Use icons for "external", "new window" and "new window, external" according to Site's settings or not.
734
+ * Default is <code>true</code>.
735
+ * @param useLinkDecorationSettings whether or not Site's settings for link type icons should be used
736
+ */
737
+ setUseLinkDecorationSettings(useLinkDecorationSettings: boolean): void;
738
+
739
+ /**
740
+ * Utility method for executing <code>setUseLinkDecorationSettings(true)</code>
741
+ * @see #setUseLinkDecorationSettings(boolean)
742
+ */
743
+ forceUseLinkDecorationSettings(): void;
744
+
745
+ /**
746
+ * Utility method for executing <code>setUseLinkDecorationSettings(false)</code>
747
+ * @see #setUseLinkDecorationSettings(boolean)
748
+ */
749
+ clearUseLinkDecorationSettings(): void;
750
+
751
+ /**
752
+ * Use icons/descriptions for known file types according to Site's settings or not.
753
+ * Default is <code>true</code>.
754
+ * @param useResourceDecorationSettings whether or not Site's settings for icons/descriptions for known file types should be used
755
+ */
756
+ setUseResourceDecorationSettings(
757
+ useResourceDecorationSettings: boolean
758
+ ): void;
759
+
760
+ /**
761
+ * Utility method for executing <code>setUseResourceDecorationSettings(true)</code>
762
+ * @see #setUseResourceDecorationSettings(boolean)
763
+ */
764
+ forceUseResourceDecorationSettings(): void;
765
+
766
+ /**
767
+ * Utility method for executing <code>setUseResourceDecorationSettings(false)</code>
768
+ * @see #setUseResourceDecorationSettings(boolean)
769
+ */
770
+ clearUseResourceDecorationSettings(): void;
771
+
772
+ /**
773
+ * Should the link target be opened in a new window or not?
774
+ * Default is <code>false</code>.
775
+ * @param openNewWindow whether or not the link target should be opened in a new window
776
+ */
777
+ setOpenNewWindow(openNewWindow: boolean): void;
778
+
779
+ /**
780
+ * Utility method for executing <code>setOpenNewWindow(true)</code>
781
+ * @see #setOpenNewWindow(boolean)
782
+ */
783
+ forceOpenNewWindow(): void;
784
+
785
+ /**
786
+ * Utility method for executing <code>setOpenNewWindow(false)</code>
787
+ * @see #setOpenNewWindow(boolean)
788
+ */
789
+ clearOpenNewWindow(): void;
790
+
791
+ /**
792
+ * Should the browser download the link target instead of navigating to it?
793
+ * Default is <code>false</code>.
794
+ * @param useDownload whether a browser is suggested to download the link target directly
795
+ * @since Sitevision 5.2
796
+ */
797
+ setUseDownload(useDownload: boolean): void;
798
+
799
+ /**
800
+ * Utility method for executing <code>setUseDownload(true)</code>
801
+ * @see #setUseDownload(boolean)
802
+ * @since Sitevision 5.2
803
+ */
804
+ forceUseDownload(): void;
805
+
806
+ /**
807
+ * Utility method for executing <code>setUseDownload(false)</code>
808
+ * @see #setUseDownload(boolean)
809
+ * @since Sitevision 5.2
810
+ */
811
+ clearUseDownload(): void;
812
+
813
+ /**
814
+ * Should text and attributes be properly encoded or not?
815
+ * Default is <code>true</code>.
816
+ * @param performEncoding whether text should be encoded or not.
817
+ */
818
+ setUseEncoding(performEncoding: boolean): void;
819
+
820
+ /**
821
+ * Utility method for executing <code>setUseEncoding(true)</code>
822
+ * @see #setUseEncoding(boolean)
823
+ */
824
+ forceUseEncoding(): void;
825
+
826
+ /**
827
+ * Utility method for executing <code>setUseEncoding(false)</code>
828
+ * @see #setUseEncoding(boolean)
829
+ */
830
+ clearUseEncoding(): void;
831
+
832
+ /**
833
+ * Ensures title always will have a value. If non-existing, the title will be set to the title of the target target (or
834
+ * the same as the linked text if the target isn't a page or the title of the page is lacking)
835
+ * Default is <code>false</code>.
836
+ * @param useAutoTitle whether or not the link always should get the title automatically if title is missing
837
+ */
838
+ setUseAutoTitle(useAutoTitle: boolean): void;
839
+
840
+ /**
841
+ * Utility method for executing <code>setUseAutoTitle(true)</code>
842
+ * @see #setUseAutoTitle(boolean)
843
+ */
844
+ forceUseAutoTitle(): void;
845
+
846
+ /**
847
+ * Utility method for executing <code>setUseAutoTitle(false)</code>
848
+ * @see #setUseAutoTitle(boolean)
849
+ */
850
+ clearUseAutoTitle(): void;
851
+
852
+ /**
853
+ * Should cross-site internal Node links be handled or not?
854
+ *
855
+ * <p>
856
+ * Default is <code>false</code>.
857
+ * </p>
858
+ * <p>
859
+ * <em>Note! For best performance: enable only if your site actually contains internal links to
860
+ * pages on other sites (e.g. The System user creates an internal link and selects a page
861
+ * on another site in the target browse tree).</em>
862
+ * </p>
863
+ * @param useCrossSiteTargetChecking whether or not to check for cross-site Node targets
864
+ * @since Sitevision 3.0.2
865
+ */
866
+ setUseCrossSiteTargetChecking(useCrossSiteTargetChecking: boolean): void;
867
+
868
+ /**
869
+ * Utility method for executing <code>setUseCrossSiteTargetChecking(true)</code>
870
+ * @see #setUseCrossSiteTargetChecking(boolean)
871
+ * @since Sitevision 3.0.2
872
+ */
873
+ forceUseCrossSiteTargetChecking(): void;
874
+
875
+ /**
876
+ * Utility method for executing <code>seUseCrossSiteTargetChecking(false)</code>
877
+ * @see #setUseCrossSiteTargetChecking(boolean)
878
+ * @since Sitevision 3.0.2
879
+ */
880
+ clearUseCrossSiteTargetChecking(): void;
949
881
  }
950
882
 
951
- export default linkRenderer;
883
+ declare namespace LinkRenderer {}
884
+
885
+ declare var linkRenderer: LinkRenderer;
886
+
887
+ export = linkRenderer;