@sitevision/api 1.0.20 → 1.1.0-alpha.1
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.
- package/hidden/javax/jcr/Binary/index.d.ts +86 -0
- package/hidden/javax/jcr/Credentials/index.d.ts +11 -0
- package/hidden/javax/jcr/ImportUUIDBehavior/index.d.ts +11 -0
- package/hidden/javax/jcr/Item/index.d.ts +353 -0
- package/hidden/javax/jcr/ItemVisitor/index.d.ts +41 -0
- package/hidden/javax/jcr/NamespaceRegistry/index.d.ts +100 -0
- package/hidden/javax/jcr/Node/index.d.ts +2808 -0
- package/hidden/javax/jcr/NodeIterator/index.d.ts +18 -0
- package/hidden/javax/jcr/Property/index.d.ts +801 -0
- package/hidden/javax/jcr/PropertyIterator/index.d.ts +17 -0
- package/hidden/javax/jcr/RangeIterator/index.d.ts +75 -0
- package/hidden/javax/jcr/Repository/index.d.ts +318 -0
- package/hidden/javax/jcr/RepositoryFactory/index.d.ts +90 -0
- package/hidden/javax/jcr/Value/index.d.ts +190 -0
- package/hidden/javax/jcr/ValueFactory/index.d.ts +179 -0
- package/hidden/javax/jcr/Workspace/index.d.ts +1061 -0
- package/hidden/javax/jcr/lock/Lock/index.d.ts +142 -0
- package/hidden/javax/jcr/lock/LockManager/index.d.ts +217 -0
- package/hidden/javax/jcr/nodetype/ItemDefinition/index.d.ts +219 -0
- package/hidden/javax/jcr/nodetype/NodeDefinition/index.d.ts +158 -0
- package/hidden/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +74 -0
- package/hidden/javax/jcr/nodetype/NodeType/index.d.ts +349 -0
- package/hidden/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +248 -0
- package/hidden/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +16 -0
- package/hidden/javax/jcr/nodetype/NodeTypeManager/index.d.ts +218 -0
- package/hidden/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +98 -0
- package/hidden/javax/jcr/nodetype/PropertyDefinition/index.d.ts +536 -0
- package/hidden/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +97 -0
- package/hidden/javax/jcr/observation/Event/index.d.ts +133 -0
- package/hidden/javax/jcr/observation/EventIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/observation/EventJournal/index.d.ts +22 -0
- package/hidden/javax/jcr/observation/EventListener/index.d.ts +23 -0
- package/hidden/javax/jcr/observation/EventListenerIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/observation/ObservationManager/index.d.ts +227 -0
- package/hidden/javax/jcr/query/Query/index.d.ts +201 -0
- package/hidden/javax/jcr/query/QueryManager/index.d.ts +73 -0
- package/hidden/javax/jcr/query/QueryResult/index.d.ts +51 -0
- package/hidden/javax/jcr/query/Row/index.d.ts +159 -0
- package/hidden/javax/jcr/query/RowIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/query/qom/And/index.d.ts +26 -0
- package/hidden/javax/jcr/query/qom/BindVariableValue/index.d.ts +15 -0
- package/hidden/javax/jcr/query/qom/ChildNode/index.d.ts +27 -0
- package/hidden/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +27 -0
- package/hidden/javax/jcr/query/qom/Column/index.d.ts +39 -0
- package/hidden/javax/jcr/query/qom/Comparison/index.d.ts +82 -0
- package/hidden/javax/jcr/query/qom/Constraint/index.d.ts +13 -0
- package/hidden/javax/jcr/query/qom/DescendantNode/index.d.ts +31 -0
- package/hidden/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +29 -0
- package/hidden/javax/jcr/query/qom/DynamicOperand/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +41 -0
- package/hidden/javax/jcr/query/qom/FullTextSearch/index.d.ts +89 -0
- package/hidden/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +24 -0
- package/hidden/javax/jcr/query/qom/Join/index.d.ts +36 -0
- package/hidden/javax/jcr/query/qom/JoinCondition/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/Length/index.d.ts +24 -0
- package/hidden/javax/jcr/query/qom/Literal/index.d.ts +18 -0
- package/hidden/javax/jcr/query/qom/LowerCase/index.d.ts +26 -0
- package/hidden/javax/jcr/query/qom/NodeLocalName/index.d.ts +16 -0
- package/hidden/javax/jcr/query/qom/NodeName/index.d.ts +16 -0
- package/hidden/javax/jcr/query/qom/Not/index.d.ts +20 -0
- package/hidden/javax/jcr/query/qom/Operand/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/Or/index.d.ts +30 -0
- package/hidden/javax/jcr/query/qom/Ordering/index.d.ts +53 -0
- package/hidden/javax/jcr/query/qom/PropertyExistence/index.d.ts +24 -0
- package/hidden/javax/jcr/query/qom/PropertyValue/index.d.ts +25 -0
- package/hidden/javax/jcr/query/qom/QueryObjectModel/index.d.ts +64 -0
- package/hidden/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +638 -0
- package/hidden/javax/jcr/query/qom/SameNode/index.d.ts +27 -0
- package/hidden/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +36 -0
- package/hidden/javax/jcr/query/qom/Selector/index.d.ts +35 -0
- package/hidden/javax/jcr/query/qom/Source/index.d.ts +9 -0
- package/hidden/javax/jcr/query/qom/StaticOperand/index.d.ts +10 -0
- package/hidden/javax/jcr/query/qom/UpperCase/index.d.ts +26 -0
- package/hidden/javax/jcr/retention/Hold/index.d.ts +34 -0
- package/hidden/javax/jcr/retention/RetentionManager/index.d.ts +189 -0
- package/hidden/javax/jcr/retention/RetentionPolicy/index.d.ts +21 -0
- package/hidden/javax/jcr/security/AccessControlEntry/index.d.ts +24 -0
- package/hidden/javax/jcr/security/AccessControlList/index.d.ts +91 -0
- package/hidden/javax/jcr/security/AccessControlManager/index.d.ts +297 -0
- package/hidden/javax/jcr/security/AccessControlPolicy/index.d.ts +11 -0
- package/hidden/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +22 -0
- package/hidden/javax/jcr/security/Privilege/index.d.ts +117 -0
- package/hidden/javax/jcr/version/Version/index.d.ts +121 -0
- package/hidden/javax/jcr/version/VersionHistory/index.d.ts +307 -0
- package/hidden/javax/jcr/version/VersionIterator/index.d.ts +20 -0
- package/hidden/javax/jcr/version/VersionManager/index.d.ts +1082 -0
- package/hidden/senselogic/sitevision/api/base/Builder/index.d.ts +102 -0
- package/hidden/senselogic/sitevision/api/base/Filter/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/base/FilterSplit/index.d.ts +50 -0
- package/hidden/senselogic/sitevision/api/base/Loadable/index.d.ts +15 -0
- package/hidden/senselogic/sitevision/api/base/Resolver/index.d.ts +31 -0
- package/hidden/senselogic/sitevision/api/base/Wrapper/index.d.ts +24 -0
- package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +417 -0
- package/hidden/senselogic/sitevision/api/format/NumericFormatter/index.d.ts +80 -0
- package/hidden/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +100 -0
- package/hidden/senselogic/sitevision/api/i18n/Currency/index.d.ts +120 -0
- package/hidden/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +45 -0
- package/hidden/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts +65 -0
- package/hidden/senselogic/sitevision/api/mail/Mail/index.d.ts +32 -0
- package/hidden/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts +15 -0
- package/hidden/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts +23 -0
- package/hidden/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts +23 -0
- package/hidden/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts +642 -0
- package/hidden/senselogic/sitevision/api/render/BuddyIconRenderer/BuddyIconInfo/index.d.ts +51 -0
- package/hidden/senselogic/sitevision/api/render/ImageScaler/index.d.ts +58 -0
- package/hidden/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts +301 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/ArticleUtilConstants/index.d.ts +85 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/ExceptionSuppressingProxyConstants/index.d.ts +31 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/IndexingUtilConstants/index.d.ts +31 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/LinkPageUtilConstants/index.d.ts +67 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/MathInstanceConstants/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/MimeTypeUtilConstants/index.d.ts +19 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/NodeTypeUtilConstants/index.d.ts +1243 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/OutputUtilConstants/index.d.ts +31 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PageUtilConstants/index.d.ts +91 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PortletContextUtilConstants/index.d.ts +27 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PortletUtilConstants/index.d.ts +19 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/QueryStringUtilConstants/index.d.ts +19 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/SearchHitConstants/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/SearchResultConstants/index.d.ts +37 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/VersionUtilConstants/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts +8 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts +50 -0
- package/hidden/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts +89 -0
- package/hidden/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +119 -0
- package/hidden/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts +272 -0
- package/hidden/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts +43 -0
- package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts +94 -0
- package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts +117 -0
- package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +90 -0
- package/hidden/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts +89 -0
- package/hidden/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts +45 -0
- package/hidden/senselogic/sitevision/api/search/SearchHit/index.d.ts +1176 -0
- package/hidden/senselogic/sitevision/api/search/SearchResult/index.d.ts +414 -0
- package/hidden/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts +27 -0
- package/hidden/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts +61 -0
- package/hidden/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts +277 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts +29 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts +35 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts +25 -0
- package/hidden/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts +29 -0
- package/hidden/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts +82 -0
- package/hidden/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts +21 -0
- package/hidden/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts +70 -0
- package/hidden/senselogic/sitevision/api/security/MessageDigester/index.d.ts +50 -0
- package/hidden/senselogic/sitevision/api/security/RoleAssignment/index.d.ts +72 -0
- package/hidden/senselogic/sitevision/api/security/RoleMatcher/index.d.ts +29 -0
- package/hidden/senselogic/sitevision/api/security/SecretStore/index.d.ts +55 -0
- package/hidden/senselogic/sitevision/api/security/UserUtil/index.d.ts +80 -0
- package/hidden/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +36 -0
- package/hidden/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts +32 -0
- package/hidden/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +599 -0
- package/hidden/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts +20 -0
- package/hidden/senselogic/sitevision/api/xml/XmlElement/index.d.ts +55 -0
- package/hidden/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts +17 -0
- package/package.json +2 -4
- package/server/AliasUtil/index.d.ts +25 -0
- package/server/AliasUtil/index.js +10 -0
- package/server/ArchiveUtil/index.d.ts +65 -11
- package/server/ArraysInstance/index.d.ts +1846 -0
- package/server/ArticleUtil/index.d.ts +381 -69
- package/server/AuthenticationUtil/index.d.ts +106 -0
- package/server/BookmarkUtil/index.d.ts +36 -28
- package/server/BuddyIconRenderer/index.d.ts +240 -0
- package/server/ClientUtil/index.d.ts +18 -4
- package/server/CollaborationFactory/index.d.ts +42 -25
- package/server/CollaborationGroupFolderUtil/index.d.ts +40 -29
- package/server/CollaborationGroupTemplateUtil/index.d.ts +71 -39
- package/server/CollaborationGroupUtil/index.d.ts +128 -55
- package/server/CollectionsInstance/index.d.ts +738 -0
- package/server/ColorUtil/index.d.ts +22 -17
- package/server/CompoundAndFilterBuilder/index.d.ts +60 -0
- package/server/CompoundComparatorBuilder/index.d.ts +63 -0
- package/server/CompoundOrFilterBuilder/index.d.ts +59 -0
- package/server/ContentNodeUtil/index.d.ts +76 -0
- package/server/CurrencyFactory/index.d.ts +135 -0
- package/server/DateUtil/index.d.ts +154 -77
- package/server/DecorationUtil/index.d.ts +23 -0
- package/server/DeviceUtil/index.d.ts +36 -0
- package/server/DirectoryUtil/index.d.ts +107 -47
- package/server/DocTypeUtil/index.d.ts +149 -0
- package/server/EndecUtil/index.d.ts +537 -91
- package/server/ExtendedDismaxParserBuilder/index.d.ts +311 -0
- package/server/FileIconRenderer/index.d.ts +346 -0
- package/server/FileUtil/index.d.ts +462 -0
- package/server/FilterBuilder/index.d.ts +120 -0
- package/server/FolderUtil/index.d.ts +161 -0
- package/server/FontUtil/index.d.ts +49 -0
- package/server/FormatterBuilderFactory/index.d.ts +129 -0
- package/server/HighlightBuilder/index.d.ts +194 -0
- package/server/IconUtil/index.d.ts +37 -0
- package/server/ImageLinkRenderer/index.d.ts +134 -0
- package/server/ImageRenderer/index.d.ts +613 -231
- package/server/ImageUtil/index.d.ts +430 -0
- package/server/IndexUtil/index.d.ts +71 -0
- package/server/IndexingUtil/index.d.ts +92 -0
- package/server/InstanceCreatorUtil/index.d.ts +661 -0
- package/server/InstanceTypeUtil/index.d.ts +202 -0
- package/server/JwtUtil/index.d.ts +217 -0
- package/server/LandingPageUtil/index.d.ts +67 -50
- package/server/LinkPageUtil/index.d.ts +468 -0
- package/server/LinkRenderer/index.d.ts +1157 -0
- package/server/LinkTargetBuilder/index.d.ts +146 -0
- package/server/LinkValueBuilder/index.d.ts +129 -52
- package/server/ListWrapper/index.d.ts +172 -0
- package/server/LocaleUtil/index.d.ts +695 -61
- package/server/LogUtil/index.d.ts +118 -77
- package/server/MailBuilder/index.d.ts +238 -0
- package/server/MailUtil/index.d.ts +98 -0
- package/server/MathInstance/index.d.ts +681 -0
- package/server/MessageDigesterFactory/index.d.ts +49 -0
- package/server/MetadataDefinitionUtil/index.d.ts +118 -0
- package/server/MetadataUtil/index.d.ts +524 -79
- package/server/MimeTypeUtil/index.d.ts +316 -0
- package/server/MonitorBuilder/index.d.ts +51 -0
- package/server/NodeComparatorUtil/index.d.ts +397 -0
- package/server/NodeFactoryUtil/index.d.ts +32 -0
- package/server/NodeFilterUtil/index.d.ts +924 -0
- package/server/NodeIteratorUtil/index.d.ts +322 -72
- package/server/NodeResolverUtil/index.d.ts +767 -0
- package/server/NodeTreeUtil/index.d.ts +339 -63
- package/server/NodeTypeUtil/index.d.ts +391 -197
- package/server/OfflineVersionPropertyUtil/index.d.ts +30 -0
- package/server/OnlineVersionPropertyUtil/index.d.ts +30 -0
- package/server/OutputUtil/index.d.ts +641 -0
- package/server/PageUtil/index.d.ts +330 -0
- package/server/PermissionUtil/index.d.ts +650 -0
- package/server/PortletContextUtil/index.d.ts +118 -37
- package/server/PortletContextUtil/index.js +1 -0
- package/server/PortletUtil/index.d.ts +40 -0
- package/server/PrincipalUtil/index.d.ts +51 -0
- package/server/Properties/index.d.ts +185 -38
- package/server/PropertyUtil/index.d.ts +2330 -406
- package/server/PublishingUtil/index.d.ts +385 -49
- package/server/QueryStringUtil/index.d.ts +737 -0
- package/server/RedirectUtil/index.d.ts +98 -0
- package/server/RelatedValueBuilder/index.d.ts +81 -39
- package/server/Requester/index.d.ts +441 -65
- package/server/ResourceLocatorUtil/index.d.ts +483 -227
- package/server/RestApi/index.d.ts +208 -23
- package/server/RestAppInvokerFactory/index.d.ts +73 -0
- package/server/RoleAssignmentBuilder/index.d.ts +60 -0
- package/server/RoleMatcherBuilder/index.d.ts +59 -0
- package/server/RoleUtil/index.d.ts +57 -0
- package/server/ScriptUtil/index.d.ts +625 -143
- package/server/SearchFactory/index.d.ts +133 -0
- package/server/SearchUtil/index.d.ts +164 -0
- package/server/SearcherBuilder/index.d.ts +260 -0
- package/server/Session/index.d.ts +1758 -0
- package/server/SimpleUserUtil/index.d.ts +39 -30
- package/server/SiteCookieUtil/index.d.ts +78 -53
- package/server/SortBuilder/index.d.ts +111 -0
- package/server/SpellCheckBuilder/index.d.ts +68 -0
- package/server/StandardParserBuilder/index.d.ts +112 -0
- package/server/StructureUtil/index.d.ts +167 -0
- package/server/SubscriberUtil/index.d.ts +122 -0
- package/server/SubscriptionUtil/index.d.ts +197 -0
- package/server/SystemUserUtil/index.d.ts +201 -98
- package/server/TagUtil/index.d.ts +193 -0
- package/server/TemplateUtil/index.d.ts +217 -0
- package/server/TemporaryFileNodeBuilder/index.d.ts +63 -0
- package/server/TemporaryNodeBuilder/index.d.ts +241 -0
- package/server/TextModuleRendererBuilder/index.d.ts +68 -0
- package/server/TimestampUtil/index.d.ts +98 -82
- package/server/TranslationUtil/index.d.ts +175 -0
- package/server/TrashcanUtil/index.d.ts +193 -24
- package/server/UserDataUtil/index.d.ts +167 -85
- package/server/UserFactory/index.d.ts +45 -30
- package/server/UserFieldRenderer/index.d.ts +258 -0
- package/server/UserIdentityUtil/index.d.ts +61 -29
- package/server/UserUtil/index.d.ts +69 -28
- package/server/Utils/index.d.ts +870 -12
- package/server/VelocityRenderer/index.d.ts +248 -0
- package/server/VersionUtil/index.d.ts +15 -12
- package/server/WebContentUtil/index.d.ts +644 -0
- package/server/WebResourceFactory/index.d.ts +66 -0
- package/server/XSLTUtil/index.d.ts +49 -10
- package/server/XmlParserUtil/index.d.ts +82 -81
- package/builtins/Binary/index.d.ts +0 -3
- package/builtins/Calendar/index.d.ts +0 -3
- package/builtins/Collection/index.d.ts +0 -3
- package/builtins/Date/index.d.ts +0 -3
- package/builtins/InputStream/index.d.ts +0 -3
- package/builtins/Instant/index.d.ts +0 -3
- package/builtins/List/index.d.ts +0 -3
- package/builtins/LocalDateTime/index.d.ts +0 -3
- package/builtins/Locale/index.d.ts +0 -3
- package/builtins/Node/index.d.ts +0 -3
- package/builtins/NodeIterator/index.d.ts +0 -27
- package/builtins/Property/index.d.ts +0 -3
- package/builtins/Serializable/index.d.ts +0 -3
- package/builtins/Set/index.d.ts +0 -3
- package/builtins/Throwable/index.d.ts +0 -3
- package/builtins/byte/index.d.ts +0 -3
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
import Node from "../../hidden/javax/jcr/Node";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* <p>
|
|
5
|
+
* Creates a folder as sub node of the specified parent.
|
|
6
|
+
* </p>
|
|
7
|
+
* <p>
|
|
8
|
+
* The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}, {@code sv:collaborationGroupPage},
|
|
9
|
+
* {@code sv:imageRepository}, {@code sv:localImageRepository}, {@code sv:personalImageRepository},
|
|
10
|
+
* {@code sv:fileRepository}, {@code sv:localFileRepository}, {@code sv:personalFileRepository}
|
|
11
|
+
* or {@code sv:templateRepository}.
|
|
12
|
+
* If an other parent is specified an <code>ConstraintViolationException</code> is thrown.
|
|
13
|
+
* </p>
|
|
14
|
+
*
|
|
15
|
+
* <p>Any name can be given the folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
|
|
16
|
+
*
|
|
17
|
+
* <p>The current user must be authorized to create folders and to do write operations on the parent node or
|
|
18
|
+
* a <code>ConstraintViolationException</code> will be thrown.</p>
|
|
19
|
+
*
|
|
20
|
+
* <p>Note that a new folder inherits metadata and permissions from its parent.</p>
|
|
21
|
+
* @param aParent the parent node of the sv:folder. May not be <code>null</code>
|
|
22
|
+
* @param aName the name of the folder. May not be <code>null</code>
|
|
23
|
+
* @return the newly created sv:folder node.
|
|
24
|
+
* @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create a folder
|
|
25
|
+
* @throws RepositoryException if something else goes wrong
|
|
26
|
+
*/
|
|
27
|
+
export function createFolder(aParent: Node, aName: string): Node;
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* <p>Alters the name of a folder. If no folder is specified a <code>NullPointerException</code>
|
|
31
|
+
* is thrown. If the node is not a sv:folder an <code>IllegalArgumentException</code> is thrown.</p>
|
|
32
|
+
*
|
|
33
|
+
* <p>Any name can be given a folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
|
|
34
|
+
*
|
|
35
|
+
* <p>The current user must be authorized to do write operations on the folder or
|
|
36
|
+
* a <code>ConstraintViolationException</code> will be thrown.</p>
|
|
37
|
+
* @param aFolder the sv:folder that should be renamed. May not be <code>null</code>
|
|
38
|
+
* @param aName the new name of the folder. May not be <code>null</code>
|
|
39
|
+
* @throws ConstraintViolationException if the current user is not authorized to alter the name of the folder
|
|
40
|
+
* @throws RepositoryException if something else goes wrong
|
|
41
|
+
*/
|
|
42
|
+
export function renameFolder(aFolder: Node, aName: string): void;
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Modifies versioning for a file folder (versioning only applies to new files created in the file folder).
|
|
46
|
+
*
|
|
47
|
+
* <p>
|
|
48
|
+
* If no folder is specified a <code>NullPointerException</code> is thrown.
|
|
49
|
+
* If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
|
|
50
|
+
* </p>
|
|
51
|
+
*
|
|
52
|
+
* <p>
|
|
53
|
+
* Current user must be authorized to do write operations on the folder or
|
|
54
|
+
* a <code>ConstraintViolationException</code> will be thrown.
|
|
55
|
+
* </p>
|
|
56
|
+
* @param aFolder the sv:folder. May not be null
|
|
57
|
+
* @param aVersioned the new state of versioning for aFolder
|
|
58
|
+
* @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
|
|
59
|
+
* @throws RepositoryException if something else goes wrong
|
|
60
|
+
* @since Sitevision 9.1
|
|
61
|
+
*/
|
|
62
|
+
export function setVersioned(aFolder: Node, aVersioned: boolean): void;
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Modifies download protection for a file folder (download protection only applies to new files created in the file folder).
|
|
66
|
+
*
|
|
67
|
+
* <p>
|
|
68
|
+
* Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION permission on the folder node that
|
|
69
|
+
* should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
|
|
70
|
+
* and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_DOWNLOAD_PROTECTION}).
|
|
71
|
+
* </p>
|
|
72
|
+
*
|
|
73
|
+
* <p>
|
|
74
|
+
* If no folder is specified a <code>NullPointerException</code> is thrown.
|
|
75
|
+
* If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
|
|
76
|
+
* </p>
|
|
77
|
+
*
|
|
78
|
+
* <p>
|
|
79
|
+
* <em>Tip! Use {@link senselogic.sitevision.api.property.PropertyUtil} or {@link senselogic.sitevision.api.property.Properties}
|
|
80
|
+
* to check current state, i.e. the "downloadProtected" boolean property.</em>
|
|
81
|
+
* </p>
|
|
82
|
+
* @param aFolder the sv:folder. May not be null
|
|
83
|
+
* @param aDownloadProtected the new state of download protection for aFolder
|
|
84
|
+
* @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
|
|
85
|
+
* @throws RepositoryException if something else goes wrong
|
|
86
|
+
* @since Sitevision 2022.08.1
|
|
87
|
+
*/
|
|
88
|
+
export function setDownloadProtected(
|
|
89
|
+
aFolder: Node,
|
|
90
|
+
aDownloadProtected: boolean
|
|
91
|
+
): void;
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* Folder utility interface that handles nodes with primary node type <code>sv:folder</code>.
|
|
95
|
+
*
|
|
96
|
+
* <p>
|
|
97
|
+
* <em>Note!</em> This interface is used to <em>create</em> folders. You would typically use
|
|
98
|
+
* {@link senselogic.sitevision.api.webresource.structure.StructureUtil} to <em>move</em> a folder
|
|
99
|
+
* and {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to <em>delete</em> a folder.
|
|
100
|
+
* </p>
|
|
101
|
+
*
|
|
102
|
+
* <p>
|
|
103
|
+
* An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFolderUtil()}.
|
|
104
|
+
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
105
|
+
* </p><p>
|
|
106
|
+
* Creates a folder as sub node of the specified parent.
|
|
107
|
+
* </p>
|
|
108
|
+
* <p>
|
|
109
|
+
* The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}, {@code sv:collaborationGroupPage},
|
|
110
|
+
* {@code sv:imageRepository}, {@code sv:localImageRepository}, {@code sv:personalImageRepository},
|
|
111
|
+
* {@code sv:fileRepository}, {@code sv:localFileRepository}, {@code sv:personalFileRepository}
|
|
112
|
+
* or {@code sv:templateRepository}.
|
|
113
|
+
* If an other parent is specified an <code>ConstraintViolationException</code> is thrown.
|
|
114
|
+
* </p>
|
|
115
|
+
*
|
|
116
|
+
* <p>Any name can be given the folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
|
|
117
|
+
*
|
|
118
|
+
* <p>The current user must be authorized to create folders and to do write operations on the parent node or
|
|
119
|
+
* a <code>ConstraintViolationException</code> will be thrown.</p>
|
|
120
|
+
*
|
|
121
|
+
* <p>Note that a new folder inherits metadata and permissions from its parent.</p><p>Alters the name of a folder. If no folder is specified a <code>NullPointerException</code>
|
|
122
|
+
* is thrown. If the node is not a sv:folder an <code>IllegalArgumentException</code> is thrown.</p>
|
|
123
|
+
*
|
|
124
|
+
* <p>Any name can be given a folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
|
|
125
|
+
*
|
|
126
|
+
* <p>The current user must be authorized to do write operations on the folder or
|
|
127
|
+
* a <code>ConstraintViolationException</code> will be thrown.</p>Modifies versioning for a file folder (versioning only applies to new files created in the file folder).
|
|
128
|
+
*
|
|
129
|
+
* <p>
|
|
130
|
+
* If no folder is specified a <code>NullPointerException</code> is thrown.
|
|
131
|
+
* If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
|
|
132
|
+
* </p>
|
|
133
|
+
*
|
|
134
|
+
* <p>
|
|
135
|
+
* Current user must be authorized to do write operations on the folder or
|
|
136
|
+
* a <code>ConstraintViolationException</code> will be thrown.
|
|
137
|
+
* </p>Modifies download protection for a file folder (download protection only applies to new files created in the file folder).
|
|
138
|
+
*
|
|
139
|
+
* <p>
|
|
140
|
+
* Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION permission on the folder node that
|
|
141
|
+
* should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
|
|
142
|
+
* and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_DOWNLOAD_PROTECTION}).
|
|
143
|
+
* </p>
|
|
144
|
+
*
|
|
145
|
+
* <p>
|
|
146
|
+
* If no folder is specified a <code>NullPointerException</code> is thrown.
|
|
147
|
+
* If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
|
|
148
|
+
* </p>
|
|
149
|
+
*
|
|
150
|
+
* <p>
|
|
151
|
+
* <em>Tip! Use {@link senselogic.sitevision.api.property.PropertyUtil} or {@link senselogic.sitevision.api.property.Properties}
|
|
152
|
+
* to check current state, i.e. the "downloadProtected" boolean property.</em>
|
|
153
|
+
* </p>
|
|
154
|
+
* @author Mikael Wikblom
|
|
155
|
+
* @since Sitevision 2.6.2
|
|
156
|
+
*/
|
|
157
|
+
declare namespace FolderUtil {
|
|
158
|
+
export { createFolder, renameFolder, setVersioned, setDownloadProtected };
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
export default FolderUtil;
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import Node from "../../hidden/javax/jcr/Node";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Gets the font with a given font name
|
|
5
|
+
* @param aFontName the name of the font
|
|
6
|
+
* @return the first font with name aFontName, or <code>null</code> if no font matches
|
|
7
|
+
*/
|
|
8
|
+
export function getFontByName(aFontName: string): Node;
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Gets the font with a given font name with a fallback value if no font matches
|
|
12
|
+
* @param aFontName the name of the font
|
|
13
|
+
* @param aDefaultValue fallback value
|
|
14
|
+
* @return the first font with name aFontName, or aDefaultValue if no font matches
|
|
15
|
+
*/
|
|
16
|
+
export function getFontByName(aFontName: string, aDefaultValue: Node): Node;
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Gets the font with a given class name
|
|
20
|
+
* @param aClassName the class name of the font
|
|
21
|
+
* @return the first font with class name aClassName, or <code>null</code> if no font matches
|
|
22
|
+
*/
|
|
23
|
+
export function getFontByClassName(aClassName: string): Node;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Gets the font with a given class name with a fallback value if no font matches
|
|
27
|
+
* @param aClassName the class name of the font
|
|
28
|
+
* @param aDefaultValue fallback value
|
|
29
|
+
* @return the first font with class name aClassName, or aDefaultValue if no font matches
|
|
30
|
+
*/
|
|
31
|
+
export function getFontByClassName(
|
|
32
|
+
aClassName: string,
|
|
33
|
+
aDefaultValue: Node
|
|
34
|
+
): Node;
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Utility interface for Fonts.
|
|
38
|
+
*
|
|
39
|
+
* <p>
|
|
40
|
+
* An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFontUtil()}.
|
|
41
|
+
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
42
|
+
* </p>Gets the font with a given font nameGets the font with a given font name with a fallback value if no font matchesGets the font with a given class nameGets the font with a given class name with a fallback value if no font matches
|
|
43
|
+
* @author Magnus Lövgren
|
|
44
|
+
*/
|
|
45
|
+
declare namespace FontUtil {
|
|
46
|
+
export { getFontByName, getFontByClassName };
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export default FontUtil;
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import NumericFormatterBuilder from "../../hidden/senselogic/sitevision/api/format/NumericFormatterBuilder";
|
|
2
|
+
import Currency from "../../hidden/senselogic/sitevision/api/i18n/Currency";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Returns a builder for creating number formatters with a given Locale.
|
|
6
|
+
*
|
|
7
|
+
* <p>
|
|
8
|
+
* <em>The builder returned by this method will create instances that are conceptually equivalent with
|
|
9
|
+
* <code>java.text.NumberFormat.getNumberInstance(aLocale)</code>.</em>
|
|
10
|
+
* </p>
|
|
11
|
+
* @param aLocale the Locale
|
|
12
|
+
* @return a NumericFormatterBuilder that creates number formatters
|
|
13
|
+
* @throws NullPointerException if aLocale is null
|
|
14
|
+
*/
|
|
15
|
+
export function getNumberFormatterBuilder(
|
|
16
|
+
aLocale: unknown
|
|
17
|
+
): NumericFormatterBuilder;
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Returns a builder for creating percent formatters with a given Locale.
|
|
21
|
+
*
|
|
22
|
+
* <p>
|
|
23
|
+
* <em>The builder returned by this method will create instances that are conceptually equivalent with
|
|
24
|
+
* <code>java.text.NumberFormat.getPercentInstance(aLocale)</code>.</em>
|
|
25
|
+
* </p>
|
|
26
|
+
* @param aLocale the Locale
|
|
27
|
+
* @return a NumericFormatterBuilder that creates percent formatters
|
|
28
|
+
* @throws NullPointerException if aLocale is null
|
|
29
|
+
*/
|
|
30
|
+
export function getPercentFormatterBuilder(
|
|
31
|
+
aLocale: unknown
|
|
32
|
+
): NumericFormatterBuilder;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Returns a builder for creating currency formatters with a given Locale.
|
|
36
|
+
*
|
|
37
|
+
* <p>
|
|
38
|
+
* <strong>Currency note!</strong> Currency typically depends on a <em>country</em>. A language-only Locale
|
|
39
|
+
* will typically be formatted without any specific currency. Use {@link #getCurrencyFormatterBuilder(Locale, Currency)}
|
|
40
|
+
* to actively specify what currency to use when using such locale.
|
|
41
|
+
* </p>
|
|
42
|
+
*
|
|
43
|
+
* <p>
|
|
44
|
+
* <em>The builder returned by this method will create instances that are conceptually equivalent with
|
|
45
|
+
* <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code>.</em>
|
|
46
|
+
* </p>
|
|
47
|
+
* @param aLocale the Locale
|
|
48
|
+
* @return a NumericFormatterBuilder that creates currency formatters
|
|
49
|
+
* @throws NullPointerException if aLocale is null
|
|
50
|
+
* @see #getCurrencyFormatterBuilder(Locale, Currency)
|
|
51
|
+
*/
|
|
52
|
+
export function getCurrencyFormatterBuilder(
|
|
53
|
+
aLocale: unknown
|
|
54
|
+
): NumericFormatterBuilder;
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Returns a builder for creating currency formatters with a given Locale and Currency.
|
|
58
|
+
*
|
|
59
|
+
* <p>
|
|
60
|
+
* Currency instances are created via methods in {@link senselogic.sitevision.api.i18n.CurrencyFactory}.
|
|
61
|
+
* </p>
|
|
62
|
+
*
|
|
63
|
+
* <p>
|
|
64
|
+
* <em>The builder returned by this method will create instances that are conceptually equivalent with
|
|
65
|
+
* <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code> with a
|
|
66
|
+
* <code>java.util.Currency.getInstance(aCurrencyCode)</code> set.</em>
|
|
67
|
+
* </p>
|
|
68
|
+
* @param aLocale the Locale
|
|
69
|
+
* @param aCurrency the currency
|
|
70
|
+
* @return a NumericFormatterBuilder that creates currency formatters
|
|
71
|
+
* @throws NullPointerException if aLocale or aCurrency is null
|
|
72
|
+
* @see senselogic.sitevision.api.i18n.CurrencyFactory
|
|
73
|
+
*/
|
|
74
|
+
export function getCurrencyFormatterBuilder(
|
|
75
|
+
aLocale: unknown,
|
|
76
|
+
aCurrency: Currency
|
|
77
|
+
): NumericFormatterBuilder;
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* Factory for creating formatter builders.
|
|
81
|
+
*
|
|
82
|
+
* <p>
|
|
83
|
+
* An instance of the Sitevision class implementing this interface can be obtained via
|
|
84
|
+
* {@link senselogic.sitevision.api.Utils#getFormatterBuilderFactory()}.
|
|
85
|
+
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
86
|
+
* </p>Returns a builder for creating number formatters with a given Locale.
|
|
87
|
+
*
|
|
88
|
+
* <p>
|
|
89
|
+
* <em>The builder returned by this method will create instances that are conceptually equivalent with
|
|
90
|
+
* <code>java.text.NumberFormat.getNumberInstance(aLocale)</code>.</em>
|
|
91
|
+
* </p>Returns a builder for creating percent formatters with a given Locale.
|
|
92
|
+
*
|
|
93
|
+
* <p>
|
|
94
|
+
* <em>The builder returned by this method will create instances that are conceptually equivalent with
|
|
95
|
+
* <code>java.text.NumberFormat.getPercentInstance(aLocale)</code>.</em>
|
|
96
|
+
* </p>Returns a builder for creating currency formatters with a given Locale.
|
|
97
|
+
*
|
|
98
|
+
* <p>
|
|
99
|
+
* <strong>Currency note!</strong> Currency typically depends on a <em>country</em>. A language-only Locale
|
|
100
|
+
* will typically be formatted without any specific currency. Use {@link #getCurrencyFormatterBuilder(Locale, Currency)}
|
|
101
|
+
* to actively specify what currency to use when using such locale.
|
|
102
|
+
* </p>
|
|
103
|
+
*
|
|
104
|
+
* <p>
|
|
105
|
+
* <em>The builder returned by this method will create instances that are conceptually equivalent with
|
|
106
|
+
* <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code>.</em>
|
|
107
|
+
* </p>Returns a builder for creating currency formatters with a given Locale and Currency.
|
|
108
|
+
*
|
|
109
|
+
* <p>
|
|
110
|
+
* Currency instances are created via methods in {@link senselogic.sitevision.api.i18n.CurrencyFactory}.
|
|
111
|
+
* </p>
|
|
112
|
+
*
|
|
113
|
+
* <p>
|
|
114
|
+
* <em>The builder returned by this method will create instances that are conceptually equivalent with
|
|
115
|
+
* <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code> with a
|
|
116
|
+
* <code>java.util.Currency.getInstance(aCurrencyCode)</code> set.</em>
|
|
117
|
+
* </p>
|
|
118
|
+
* @author Magnus Lövgren
|
|
119
|
+
* @since Sitevision 6.1
|
|
120
|
+
*/
|
|
121
|
+
declare namespace FormatterBuilderFactory {
|
|
122
|
+
export {
|
|
123
|
+
getNumberFormatterBuilder,
|
|
124
|
+
getPercentFormatterBuilder,
|
|
125
|
+
getCurrencyFormatterBuilder,
|
|
126
|
+
};
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
export default FormatterBuilderFactory;
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
import Highlight from "../../hidden/senselogic/sitevision/api/search/searcher/component/Highlight";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Adds a field that should be highlighted.
|
|
5
|
+
*
|
|
6
|
+
* <p>
|
|
7
|
+
* <em>Solr note: this is the 'hl.fl' param</em>
|
|
8
|
+
* </p>
|
|
9
|
+
* @param aHighlightedField name of the field, a <code>null</code> or whitespace-only value will be ignored
|
|
10
|
+
* @return this builder
|
|
11
|
+
*/
|
|
12
|
+
export function addHighlightedField(
|
|
13
|
+
aHighlightedField: string
|
|
14
|
+
): HighlightBuilder;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Removes all previously added highlighted fields.
|
|
18
|
+
* @return this builder
|
|
19
|
+
*/
|
|
20
|
+
export function clearHighlightedFields(): HighlightBuilder;
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Sets the number of chars that highlighted fragment should contain.
|
|
24
|
+
*
|
|
25
|
+
* <p>
|
|
26
|
+
* If no char count is specified, the default value of the index config will be used (200).
|
|
27
|
+
* </p>
|
|
28
|
+
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <em>Solr note: this is the 'hl.fragsize' param</em>
|
|
31
|
+
* </p>
|
|
32
|
+
* @param aCharCount the char count
|
|
33
|
+
* @return this builder
|
|
34
|
+
* @throws IllegalArgumentException if <code>aCharCount</code> is zero or negative
|
|
35
|
+
*/
|
|
36
|
+
export function setFragmentCharCount(aCharCount: number): HighlightBuilder;
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Sets the start value for the highlighted section(s) of a fragment.
|
|
40
|
+
*
|
|
41
|
+
* <p>
|
|
42
|
+
* If the pre string and post string are not specified, the default value of the index config will be used
|
|
43
|
+
* ('<mark>' and '</mark>').
|
|
44
|
+
* </p>
|
|
45
|
+
*
|
|
46
|
+
* <p>
|
|
47
|
+
* <em>Solr note: this is the 'hl.simple.pre' param</em>
|
|
48
|
+
* </p>
|
|
49
|
+
* @param aPreString a fragment start
|
|
50
|
+
* @return this builder
|
|
51
|
+
*/
|
|
52
|
+
export function setFragmentPreString(aPreString: string): HighlightBuilder;
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Sets the end value for the highlighted section(s) of a fragment.
|
|
56
|
+
*
|
|
57
|
+
* <p>
|
|
58
|
+
* <strong>Note! </strong> The fragment <em>pre</em> value must match the fragment <em>post</em> string!
|
|
59
|
+
* E.g: if the <em>pre</em> string is "<em>", the <em>post</em> string would typically be "</em>".
|
|
60
|
+
* </p>
|
|
61
|
+
*
|
|
62
|
+
* <p>
|
|
63
|
+
* <em>Solr note: this is the 'hl.simple.post' param</em>
|
|
64
|
+
* </p>
|
|
65
|
+
* @param aPostString a fragment end
|
|
66
|
+
* @return this builder
|
|
67
|
+
*/
|
|
68
|
+
export function setFragmentPostString(aPostString: string): HighlightBuilder;
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Creates a Highlight component instance using currently specified state/behaviour.
|
|
72
|
+
* @return a Highlight component
|
|
73
|
+
* @throws IllegalStateException if no highlighted field is specified, or if pre and post strings doesn't match (e.g. one of them is null)
|
|
74
|
+
*/
|
|
75
|
+
export function build(): Highlight;
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* <p>
|
|
79
|
+
* Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Highlight} component with specific behaviour.
|
|
80
|
+
* </p>
|
|
81
|
+
*
|
|
82
|
+
* <p>
|
|
83
|
+
* HighlightBuilder has one <strong>mandatory attribute</strong>:
|
|
84
|
+
* </p>
|
|
85
|
+
* <ul>
|
|
86
|
+
* <li>
|
|
87
|
+
* <em>highlighted field</em> - The name of the field(s) that should be highlighted. Must be non-null.
|
|
88
|
+
* </li>
|
|
89
|
+
* </ul>
|
|
90
|
+
* <p>
|
|
91
|
+
* HighlightBuilder also has some <strong>optional attributes</strong>:
|
|
92
|
+
* </p>
|
|
93
|
+
* <ul>
|
|
94
|
+
* <li>
|
|
95
|
+
* <em>fragment char count</em> - The size of a highlighted fragment. Default is 200.
|
|
96
|
+
* </li>
|
|
97
|
+
* <li>
|
|
98
|
+
* <em>fragment pre string</em> - The start value of a highlighted section of a fragment. Default is "<mark>".
|
|
99
|
+
* </li>
|
|
100
|
+
* <li>
|
|
101
|
+
* <em>fragment post string</em> - The end value of a highlighted section of a fragment. Default is "</mark>".
|
|
102
|
+
* </li>
|
|
103
|
+
* </ul>
|
|
104
|
+
*
|
|
105
|
+
* <p>
|
|
106
|
+
* Using the HighlightBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
|
|
107
|
+
* would typically use it like this:
|
|
108
|
+
* </p>
|
|
109
|
+
* <ol>
|
|
110
|
+
* <li>Get the HighlightBuilder</li>
|
|
111
|
+
* <li>Add a highlighted field</li>
|
|
112
|
+
* <li>Possibly set a char count</li>
|
|
113
|
+
* <li>Possibly set pre + post</li>
|
|
114
|
+
* <li>Do build</li>
|
|
115
|
+
* </ol>
|
|
116
|
+
* <p>
|
|
117
|
+
* When you have built a <code>Highlight</code> instance, you can re-use the HighlightBuilder to build more instances. Typically like:
|
|
118
|
+
* </p>
|
|
119
|
+
* <ol>
|
|
120
|
+
* <li>Clear the highlighted fields</li>
|
|
121
|
+
* <li>Possibly change char count</li>
|
|
122
|
+
* <li>Possibly change pre + post</li>
|
|
123
|
+
* <li>Do build</li>
|
|
124
|
+
* </ol>
|
|
125
|
+
* <p>
|
|
126
|
+
* <strong>Example of how this strategy could be implemented in Velocity:</strong>
|
|
127
|
+
* </p>
|
|
128
|
+
* <pre><code>
|
|
129
|
+
* <em>## Get the builder</em>
|
|
130
|
+
* #set ($searchFactory = $sitevisionUtils.searchFactory)
|
|
131
|
+
* #set ($highlightBuilder = $searchFactory.highlightBuilder)
|
|
132
|
+
*
|
|
133
|
+
* <em>## Create a Highlight</em>
|
|
134
|
+
* #set ($summaryHighlight = $highlightBuilder.addHighlightedField('summary').build())
|
|
135
|
+
*
|
|
136
|
+
* <em>## Re-use the builder to create another Highlight</em>
|
|
137
|
+
* #set ($nameHighlight = $highlightBuilder.clearHighlightedFields().addHighlightedField('name').build())
|
|
138
|
+
* </code></pre>
|
|
139
|
+
*
|
|
140
|
+
* <p>
|
|
141
|
+
* <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
|
|
142
|
+
* more information about Builders and how to work with them!
|
|
143
|
+
* </p>
|
|
144
|
+
*
|
|
145
|
+
* <p>
|
|
146
|
+
* An instance of the Sitevision class implementing this interface can be obtained via
|
|
147
|
+
* {@link senselogic.sitevision.api.search.SearchFactory#getHighlightBuilder()}.
|
|
148
|
+
* See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
|
|
149
|
+
* </p>Adds a field that should be highlighted.
|
|
150
|
+
*
|
|
151
|
+
* <p>
|
|
152
|
+
* <em>Solr note: this is the 'hl.fl' param</em>
|
|
153
|
+
* </p>Removes all previously added highlighted fields.Sets the number of chars that highlighted fragment should contain.
|
|
154
|
+
*
|
|
155
|
+
* <p>
|
|
156
|
+
* If no char count is specified, the default value of the index config will be used (200).
|
|
157
|
+
* </p>
|
|
158
|
+
*
|
|
159
|
+
* <p>
|
|
160
|
+
* <em>Solr note: this is the 'hl.fragsize' param</em>
|
|
161
|
+
* </p>Sets the start value for the highlighted section(s) of a fragment.
|
|
162
|
+
*
|
|
163
|
+
* <p>
|
|
164
|
+
* If the pre string and post string are not specified, the default value of the index config will be used
|
|
165
|
+
* ('<mark>' and '</mark>').
|
|
166
|
+
* </p>
|
|
167
|
+
*
|
|
168
|
+
* <p>
|
|
169
|
+
* <em>Solr note: this is the 'hl.simple.pre' param</em>
|
|
170
|
+
* </p>Sets the end value for the highlighted section(s) of a fragment.
|
|
171
|
+
*
|
|
172
|
+
* <p>
|
|
173
|
+
* <strong>Note! </strong> The fragment <em>pre</em> value must match the fragment <em>post</em> string!
|
|
174
|
+
* E.g: if the <em>pre</em> string is "<em>", the <em>post</em> string would typically be "</em>".
|
|
175
|
+
* </p>
|
|
176
|
+
*
|
|
177
|
+
* <p>
|
|
178
|
+
* <em>Solr note: this is the 'hl.simple.post' param</em>
|
|
179
|
+
* </p>Creates a Highlight component instance using currently specified state/behaviour.
|
|
180
|
+
* @author Magnus Lövgren
|
|
181
|
+
* @since Sitevision 3.6
|
|
182
|
+
*/
|
|
183
|
+
declare namespace HighlightBuilder {
|
|
184
|
+
export {
|
|
185
|
+
addHighlightedField,
|
|
186
|
+
clearHighlightedFields,
|
|
187
|
+
setFragmentCharCount,
|
|
188
|
+
setFragmentPreString,
|
|
189
|
+
setFragmentPostString,
|
|
190
|
+
build,
|
|
191
|
+
};
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
export default HighlightBuilder;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import Node from "../../hidden/javax/jcr/Node";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Gets the file icon node for a given file extension.
|
|
5
|
+
* @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
|
|
6
|
+
* @return the file icon node for aFileExtension, or <code>null</code> if the extension has no icon mapping
|
|
7
|
+
*/
|
|
8
|
+
export function getFileIcons(aFileExtension: string): Node;
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Gets the small file icon URI for a given file extension
|
|
12
|
+
* @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
|
|
13
|
+
* @return the small file icon URI for aFileExtension, or <code>null</code> if no small icon is specified for the extension
|
|
14
|
+
*/
|
|
15
|
+
export function getSmallFileIconURI(aFileExtension: string): string;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Gets the large file icon URI for a given file extension
|
|
19
|
+
* @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
|
|
20
|
+
* @return the large file icon URI for aFileExtension, or <code>null</code> if no large icon is specified for the extension
|
|
21
|
+
*/
|
|
22
|
+
export function getLargeFileIconURI(aFileExtension: string): string;
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Utility interface for Icons.
|
|
26
|
+
*
|
|
27
|
+
* <p>
|
|
28
|
+
* An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getIconUtil()}.
|
|
29
|
+
* See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
|
|
30
|
+
* </p>Gets the file icon node for a given file extension.Gets the small file icon URI for a given file extensionGets the large file icon URI for a given file extension
|
|
31
|
+
* @author Magnus Lövgren
|
|
32
|
+
*/
|
|
33
|
+
declare namespace IconUtil {
|
|
34
|
+
export { getFileIcons, getSmallFileIconURI, getLargeFileIconURI };
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export default IconUtil;
|