Migrate configuration from 4.x to 4.7

Version 4.7 brings a lot of visual modification that involves configuration changes in beans, but also properties in arender.properties as well as CSS. This page aims to show how to properly adapt the old configurations to the new one.

The Toppanel

New organisation of the Toppanel

The Toppanel is organized into several sections to organize the different buttons. Here are the different sections listed in their default order:

• File And annotation : Contains all buttons related to download, print and annotations
• File (Contained in the first section) : Contains all buttons related to download and print
• Annotation (Contained in the first section) : Contains all buttons related to annotations
• Modification : Contains rotations, brightness and contrasts buttons
• Navigation : Contains all buttons related to the document navigation
• Zoom : Contains all buttons related to the zoom.
• MultiView tools : Contains all buttons related to multiview
• Plugin : Contains all buttons for Plume and HTML plugins
• Right : Contains all buttons needed to be to the right like the ellipsis

This organization can be modified as in previous versions. Here is a list of the different properties used to manipulate the arrangement of the different elements of the Toppanel:

• topPanel.widgets.beanNames
• topPanel.upload.buttons.beanNames
• topPanel.download.buttons.beanNames
• topPanel.section.file.buttons.beanNames
• topPanel.section.file.annotation.buttons.beanNames
• topPanel.section.modification.buttons.beanNames
• topPanel.ellipsis.buttons.beanNames
• topPanel.section.plugin.buttons.beanNames
• topPanel.search.buttons.beanNames
• topPanel.navigation.buttons.beanNames
• topPanel.zoom.buttons.beanNames
• topPanel.rotation.buttons.beanNames
• topPanel.annotation.buttons.beanNames
• topPanel.imageProcessing.buttons.vertical.beanNames
• topPanel.section.right.buttons.beanNames

Special cases

The File and Annotation section is a section that will simply serve as a container for the File and Annotation sections in order to have them side by side.

The Right section is the section which will always be the furthest to the right and which will contain the Ellipsis button (Burger menu).

Buttons, activable buttons and sub-menu items

The annotation buttons

The annotation buttons are located directly in the toppanel in the Annotation section. The repeat mode can be activated with a double-click if the property associated with the annotation is activated. It is still possible to have the repeat mode on a button with a single click.

To have this behavior, you must replace the buttonHandler property. Annotations with a repeat function will have bean references for normal mode and repeat mode.

Here is an example of a buttonHandler property that activates repeat mode when the button is clicked:

<property name="buttonHandler">
	<ref bean="highlightCircleCreationRepeatableAction" />
</property>

Example of a standard annotation button

<bean id="addHighlightCircleAnnotationButton"
    class="com.arondor.viewer.client.toppanel.presenter.ActivableButtonPresenter">
    <constructor-arg value="addHighlightCircleAnnotationButton" />
    <property name="name" value="Circle" />
    <property name="supportDoubleClick" value="${topPanel.annotationMenu.circle.repeat}" />
    <property name="enabled" value="${topPanel.annotationMenu.circle}" />
    <property name="className" value="standardButton icon-add-circle toppanelButton" />
    <property name="buttonGroup" value="topPanel" />
    <property name="buttonTitle">
        <ref bean="labels#addCircleAnnotation" />
    </property>
    <property name="visibilityForTopPanel">
        <ref bean="topPanelVisibilityMode" />
    </property>
    <property name="doubleClickButtonHandler">
        <ref bean="highlightCircleCreationRepeatableAction" />
    </property>
    <property name="inactiveButtonHandler">
        <ref bean="quitAnnotationCreationAction" />
    </property>
    <property name="buttonHandler">
        <ref bean="highlightCircleCreationAction" />
    </property>
</bean>

Example of annotation button activating repeat mode with one-click

 <bean id="addHighlightCircleAnnotationRepeatButton"
    class="com.arondor.viewer.client.toppanel.presenter.ActivableButtonPresenter">
    <constructor-arg value="addHighlightCircleAnnotationRepeatButton" />
    <property name="enabled" value="${topPanel.annotationMenu.circle.repeat}" />
    <property name="active" value="false" />
    <property name="className" value="standardButton icon-add-circle toppanelButton" />
    <property name="buttonGroup" value="topPanel" />
    <property name="buttonTitle">
        <ref bean="labels#addCircleAnnotation" />
    </property>
    <property name="visibilityForTopPanel">
        <ref bean="topPanelVisibilityMode" />
    </property>
    <property name="buttonHandler">
        <ref bean="highlightCircleCreationRepeatableAction" />
    </property>
</bean>

Activate a button with a keyboard shortcut

Buttons can have a keyboard shortcut to activate the action that is usually done on click. The different types of shortcut available are of the form:

• {Specific key} + {Key}
• {Specific key} + {Specific key} + {Key}
• {Specific key} + {Specific key} + {Specific key} + {Key}

Where {Key} corresponding to a alphabetic or numeric key on the keyboard and {Specific key} can be ALT, SHIFT, or CTRL.

For buttons (Using the ButtonPresenter class) and activable buttons (Using the ActivableButtonPresenter class), add the following property in the desired bean:

<property name="shortcut">
    <bean
        class="com.arondor.viewer.client.documentcontent.shortcuts.KeyboardShortCut"
        scope="prototype">
        <property name="ctrl" value="true" />
        <property name="key" value="KEY_TO_USE" />
        <property name="enabled" value="IS_ENABLED" />
    </bean>
</property>

Property to add in the shortcut bean to activate the CTRL key:

<property name="ctrl" value="true" />

Property to add in the shortcut bean to activate the SHIFT key:

<property name="shift" value="true" />

Property to add in the shortcut bean to activate the ALT key:

<property name="alt" value="true" />

Conversion between button and sub-menu item:

The buttons found in the submenus and the buttons found in the toppanel now use different classes. This will also result in differences in the definition of the bean.

Example of button, activable button and sub-menu item

The following examples show a fully constructed bean for the three shapes mentioned. The action that is triggered by each is the printing of the document.

Sub menu item

<bean id="printButton"
    class="com.arondor.viewer.client.widgets.DropdownMenuItem">
    <constructor-arg value="printButton"/>
    <property name="enabled" value="#{ !${isMobile} and ${topPanel.print}}"/>
    <property name="className" value="standardButton icon-print toppanelButton" />
    <property name="buttonTitle">
        <ref bean="labels#printDocument" />
    </property>
    <property name="shortCut" value="CTRL + ${shortCut.print.key}" />
    <property name="buttonHandler">
        <bean
            class="com.arondor.viewer.client.toppanel.behavior.document.DocumentPrintHandler">
            <constructor-arg>
                <bean
                    class="com.arondor.viewer.client.events.print.ShowPrintDialogBoxEvent" />
            </constructor-arg>
        </bean>
    </property>
</bean>

Button

<bean id="printButton"
    class="com.arondor.viewer.client.toppanel.presenter.ButtonPresenter">
    <constructor-arg value="printButton"/>
    <property name="enabled" value="#{ !${isMobile} and ${topPanel.print}}"/>
    <property name="className" value="standardButton icon-print toppanelButton" />
    <property name="buttonTitle">
        <ref bean="labels#printDocument" />
    </property>
    <property name="buttonHandler">
        <bean
            class="com.arondor.viewer.client.toppanel.behavior.document.DocumentPrintHandler">
            <constructor-arg>
                <bean
                    class="com.arondor.viewer.client.events.print.ShowPrintDialogBoxEvent" />
            </constructor-arg>
        </bean>
    </property>
</bean>

Activable button

<bean id="printButton"
    class="com.arondor.viewer.client.widgets.ActivableButtonPresenter">
    <constructor-arg value="printButton"/>
    <property name="enabled" value="#{ !${isMobile} and ${topPanel.print}}"/>
    <property name="className" value="standardButton icon-print toppanelButton" />
    <property name="buttonTitle">
        <ref bean="labels#printDocument" />
    </property>
    <property name="buttonHandler">
        <bean
            class="com.arondor.viewer.client.toppanel.behavior.document.DocumentPrintHandler">
            <constructor-arg>
                <bean
                    class="com.arondor.viewer.client.events.print.ShowPrintDialogBoxEvent" />
            </constructor-arg>
        </bean>
    </property>
</bean>

We see that the beans are similar here. But activable buttons (Using the ActivableButtonPresenter class) can accept the following properties:

• name
• buttonGroup
• inactiveButtonHandler
• supportShortCut
• shortcut

For buttons (Using the ButtonPresenter class) only the following properties can be added:

• name
• supportShortCut
• shortcut

The previous properties cannot be used by submenu items (Using the DropdownMenuItem class).

Putting the research directly in the toppanel

The search button corresponds to the bean with the id searchSection. This bean must then be deleted from the list of beans to be instantiated.

Location of the use of the id:

topPanel.section.right.buttons.beanNames=documentBuilderButton,fullscreenButton,searchSection,moreButton

Removing the id by redefining the property:

topPanel.section.right.buttons.beanNames=documentBuilderButton,fullscreenButton,moreButton

Then, you will have to redefine a property with the bean id searchBox:

topPanel.section.right.buttons.beanNames=searchBox,documentBuilderButton,fullscreenButton,moreButton

Class name changes

If you are using 4.7.0 or 4.7.1, then some classes have changed package. Please replace them.

Bean changes

The bean with the id annotationMenu has changed class. The new class is com.arondor.viewer.client.toppanel.presenter.SimpleButtonSetPresenter.

The arrow head or tail selection buttons have been changed. Their class is now com.arondor.viewer.client.widgets.DropdownMenuItem

The imageResource property can no longer be used in bean definitions.

Bean deletion (4.7.0 and 4.7.1)

List of bean ids removed for version 4.7.0 and 4.7.1:

• documentMenu
• imageProcessingVerticalSubMenu
• addHighlightRectangleAnnotationRepeatButton
• addHighlightCircleAnnotationRepeatButton
• addArrowAnnotationRepeatButton
• addHighlightTextAnnotationRepeatButton
• addUnderlineTextAnnotationRepeatButton
• addStrikethroughTextAnnotationRepeatButton
• addPolygonAnnotationRepeatButton
• addPolylineAnnotationRepeatButton
• addFreehandAnnotationRepeatButton
• logo

CSS modifications

Icon font

The toppanel icons have been changed. Icons are made with custom font.

Added color variables

The background, icon and hover colors in the toppanel can be changed between light color and dark color with a property:

preference.color.mode=DARK

The DARK value will be for the dark color by default, the LIGHT value will be for the light color and the CUSTOM value allows to use custom colors redefined in a css for the css class named .custom-theme . By default, the CUSTOM value will match the colors defined for the DARK value.

DARK

--bg-top-panel-general-items: #4E4E4E

--bg-top-panel-specific-items: #313131

--bg-button-hover-specific-items: #505050

--bg-button-hover-general-items: #313131

--bg-input: #585858

--bg-zoom-button: #464646

--bg-zoom-button-hover: #787878

--bg-dropdown-menu: #434343

--bg-item-hover-dropdown-menu: #505050

--color-button: #ADADAD

--color-button-hover: #F1F1F1

--color-button-active: #04AEEF

--color-button-disabled: #ADADAD4C

--color-section-title-dropdown-menu: #878787

--color-item-shortcut-dropdown-menu: #878787

--color-item-shortcut-hover-dropdown-menu: #F1F1F1

--color-separator: #707070

--bg-scrollbar: #f2f2f2

--bg-scrollbar-thumb: #b3b3b3

--bg-scrollbar-thumb-hover: #999999

--bg-scrollbar-thumb-active: #6d6d6d

LIGHT

--bg-top-panel-general-items: #D3D3D3

--bg-top-panel-specific-items: #F6F6F6

--bg-button-hover-specific-items: #DADADA

--bg-button-hover-general-items: #F6F6F6

--bg-input: #EAEAEA

--bg-zoom-button: #DFDFDF

--bg-zoom-button-hover: #BDBDBD

--bg-dropdown-menu: #F6F6F6

--bg-item-hover-dropdown-menu: #DADADA

--color-button: #707070

--color-button-hover: #1F1F1F

--color-button-active: #04AEEF

--color-button-disabled: #7070704C

--color-section-title-dropdown-menu: #D0D0D0

--color-item-shortcut-dropdown-menu: #C1C1C1

--color-item-shortcut-hover-dropdown-menu: #868686

--color-separator: #D3D3D3

--bg-scrollbar: #f2f2f2

--bg-scrollbar-thumb: #b3b3b3

--bg-scrollbar-thumb-hover: #999999

--bg-scrollbar-thumb-active: #6d6d6d

List of css modifications

Plume Plugin :

HTML Plugin :

Annotations :

Contextual menu :

Toppanel :

List of CSS removed

• topPanelSubMenu:BEFORE
• topPanelActivableButton
• topPanelActivatedButton