Class ModelWidget

    • Field Detail

      • module

        public static final String module
      • enableBoundaryCommentsParam

        public static final String enableBoundaryCommentsParam
        The parameter name used to control widget boundary comments. Currently set to "widgetVerbose".
        See Also:
        Constant Field Values
    • Constructor Detail

      • ModelWidget

        protected ModelWidget​(String name)
        Derived classes must call this constructor.
        Parameters:
        name - The widget name
      • ModelWidget

        protected ModelWidget​(Element widgetElement)
        Derived classes must call this constructor.
        Parameters:
        widgetElement - The XML Element for the widget
    • Method Detail

      • getName

        public String getName()
        Returns the widget's name.
        Returns:
        Widget's name
      • getSystemId

        public String getSystemId()
        Returns the url as a string, from where this widget was defined.
        Returns:
        url
      • getStartColumn

        public int getStartColumn()
        Returns the column where this widget was defined, in it's containing xml file.
        Returns:
        start column
      • getStartLine

        public int getStartLine()
        Returns the line where this widget was defined, in it's containing xml file.
        Returns:
        start line
      • getBoundaryCommentName

        public String getBoundaryCommentName()
        Returns the widget's name to be used in boundary comments. The default action is to return the widget's name. Derived classes can override this method to return a customized name.
        Returns:
        Name to be used in boundary comments
      • widgetBoundaryCommentsEnabled

        public static boolean widgetBoundaryCommentsEnabled​(Map<String,​? extends Object> context)
        Returns true if widget boundary comments are enabled. Widget boundary comments are enabled by setting widget.verbose=true in the widget.properties file. The true setting can be overridden in web.xml or in the screen rendering context. If widget.verbose is set to false in the widget.properties file, then that setting will override all other settings and disable all widget boundary comments.
        Parameters:
        context - Optional context Map