Class AbstractHeaderFooterTransform

    • Field Detail


        public static final java.lang.String HEADER_LEFT_PANEL
        Identifier for the left header panel
        See Also:
        Constant Field Values

        public static final java.lang.String HEADER_CENTER_PANEL
        Identifier for the center header panel
        See Also:
        Constant Field Values

        public static final java.lang.String HEADER_RIGHT_PANEL
        Identifier for the right header panel
        See Also:
        Constant Field Values

        public static final java.lang.String FOOTER_LEFT_PANEL
        Identifier for the left footer panel
        See Also:
        Constant Field Values

        public static final java.lang.String FOOTER_CENTER_PANEL
        Identifier for the center footer panel
        See Also:
        Constant Field Values

        public static final java.lang.String FOOTER_RIGHT_PANEL
        Identifier for the right footer panel
        See Also:
        Constant Field Values

        public static final java.lang.String EXCEL_HEADER_PANEL
        Identifier for the Excel header panel
        See Also:
        Constant Field Values

        public static final java.lang.String EXCEL_FOOTER_PANEL
        Identifier for the Excel footer panel
        See Also:
        Constant Field Values

        public static final java.lang.String PDF_REPORT_HEADER_PANEL
        Identifier for the pdf report header panel
        See Also:
        Constant Field Values
      • prevGroupName

        protected FormalParameter prevGroupName
        Specifies the name of the previous group preferences. We will go to this group if the button \"Cancel\" is clicked on the form.
        Allowed Values:
        The available preferences groups are specified in the preferencesGroups file.
    • Constructor Detail

      • AbstractHeaderFooterTransform

        public AbstractHeaderFooterTransform()
        Default empty constructor.
        Initialize formal parameters.
    • Method Detail

      • getHeaderFooterPropertyValue

        protected java.lang.String getHeaderFooterPropertyValue​(java.lang.String prefName,
                                                                java.lang.String propSetName,
                                                                java.lang.String propName)
      • renderHeaderFooterTextArea

        protected void renderHeaderFooterTextArea​(MarkupOutput out,
                                                  java.lang.String prefName,
                                                  java.lang.String value)
      • renderHeaderFooterTextArea

        protected void renderHeaderFooterTextArea​(MarkupOutput out,
                                                  java.lang.String prefName,
                                                  java.lang.String value,
                                                  boolean defaultSelection)
      • checkPropertiesPresent

        protected boolean checkPropertiesPresent​(java.lang.String propSetName)
      • renderMacroPulldown

        public void renderMacroPulldown​(MarkupOutput out)
        Renders a pulldown (select box) with the list of macros supported on the editor
        out - the markup output where to render the pulldown
      • getMacros

        protected java.util.List getMacros()
      • canHaveFilterDetailsMacro

        public boolean canHaveFilterDetailsMacro()
        Returns true if the macro to add filter-details is available.
      • renderCancelButton

        public void renderCancelButton​(MarkupOutput out)
        This method generates the "Cancel" button to go back to the previous dialog discarding changes.
        renderCancelButton in class AbstractAppTransform
        out - output for this transform
      • getPopulateTextEvent

        public WebEvent getPopulateTextEvent()
        Returns the event used to populate the editor with the preferences values
        a WebEvent used to populate the editor's values.
      • getApplyEvent

        public WebEvent getApplyEvent()
        Returns the event used to apply the editor's changes
        a WebEvent used to apply the editor's changes
      • renderSelectGroupHiddenInputs

        protected void renderSelectGroupHiddenInputs​(MarkupOutput out)
        This method generates hidden inputs for the select group event, used to go back to the preferences page.
      • getSelectGroupEvent

        public WebEvent getSelectGroupEvent()
        This is the event used to return to the preferences page after editing headers and footers.
      • getTitle

        public java.lang.String getTitle()
        getTitle in class AbstractOptionsTransform
        String value representing the title of this preferences dialog