ImCMS
6.0.0-beta18-docs
  • Overview of ImCMS
  • Setup
  • Tutorial
  • Design
  • API-Documentation
    • Service-beans
      • AccessService
      • CategoryMapper
      • CategoryService
      • CategoryTypeService
      • CommonContentService
      • DelegatingByTypeDocumentService
      • DocumentMenuService
      • DocumentUrlService
      • DocumentValidatingService
      • FileService
      • ImageFileService
      • ImageFolderService
      • ImageHistoryService
      • ImageService
      • IP_AccessRuleService
      • LanguageService
      • LinkValidationService
      • LoopService
      • MailService
      • MenuService
      • PhoneService
      • PropertyService
      • RoleService
      • SearchDocumentService
      • SystemPropertyService
      • TemplateGroupService
      • TemplateService
      • TemporalDataService
      • TextDocumentTemplateService
      • TextHistoryService
      • TextService
      • UserAdminRolesService
      • UserCreationService
      • UserEditorService
      • UserRolesService
      • UserService
      • VersionService
    • Core
  • Content Management
  • Advanced Configuration
  • Image Archive
  • BankId
  • User Documentation
  • Developer Documentation
ImCMS
  • API-Documentation
  • Service-beans
  • MenuService
  • Edit on GitHub

MenuService

Init or get instance MenuService over global Imcms.getServices Imcms.getServices().getMenuService();

List<MenuItemDTO> getMenuItems(int docId, int menuIndex, String language, boolean nested, String typeSort)

List<MenuItemDTO> getSortedMenuItems(MenuDTO menuDTO, String langCode)

List<MenuItemDTO> getVisibleMenuItems(int docId, int menuIndex, String language, boolean nested)

List<MenuItemDTO> getPublicMenuItems(int docId, int menuIndex, String language, boolean nested)

String getVisibleMenuAsHtml(int docId, int menuIndex, String language,
                                   boolean nested, String attributes, String treeKey, String wrap)

String getPublicMenuAsHtml(int docId, int menuIndex, String language,
                                  boolean nested, String attributes, String treeKey, String wrap)

String getVisibleMenuAsHtml(int docId, int menuIndex)

String getPublicMenuAsHtml(int docId, int menuIndex)

MenuDTO saveFrom(MenuDTO menuDTO)

void deleteByVersion(Version version)

void deleteByDocId(Integer docIdToDelete)

Menu removeId(Menu jpa, Version newVersion)

List<Menu> getAll();

Block parameters:

Parameters

Type

Description

menuIndex

int

index no

docId

int

Identify the linked document

nested

boolean

show nested in menu area

attributes

String

treeKey

String

number key for start menu item

wrap

String

list wrap tags for each menu item

Fields MenuDTO

  1. Integer menuIndex;

  2. Integer docId;

  3. List<MenuItemDTO> menuItems;

  4. boolean nested; - possible display menu items like nested

  5. String typeSort; - sort type need to for client side

Previous Next

© Copyright 2015-2022, ImCodePartnerAB. Revision 07c6cb49. Last updated on Nov 01, 2023.

Built with Sphinx using a theme provided by Read the Docs.