Package com.ebasetech.xi.api.controls

Interface TitlePanelControl

All Superinterfaces:
ContainerControl, Control, Element, EventOwner, LayoutControl, MarginStyleProperties, MessageContainer, MessageProperties, java.io.Serializable, WebFormEventOwner
public interface TitlePanelControl
extends LayoutControl, MarginStyleProperties
A Titled Panel Control is a container control with a title bar and border, where the title bar can contain a text and/or an image. The control has options to display rounded, square or slashed corners.

Further documentation.

  • Method Details

    • getWidth

      java.lang.String getWidth()
      Titled Panel Control width. See setWidth(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setWidth

      void setWidth​(java.lang.String width)
      Sets the width of the Titled Panel Control.

      Supported values:

      ValueDescription
      A specific valueAs per the CSS width property e.g. 300px
      ChildThe minimum value: this results in the Titled Panel Control being just as wide as it needs to be to accommodate its children.

      The width setting will be ignored if the parent container layout specifies a horizontal cell alignment of fill (this applies to Horizontal Box, Vertical Box and Column layouts).

      Warning: when a specific value is set, any padding, border or margins will be in addition to the specified value and can cause the Titled Panel Control to "break out" of its parent space.

      Examples: 

       controls.TITLEPANEL1.width = "300px";
 controls.TITLEPANEL1.width = "50%";
 controls.TITLEPANEL1.setWidth("Child");
      Since:
      V4.4

    • getTitlePanelBorderColor

      java.lang.String getTitlePanelBorderColor()
      Returns the color applied to the border surrounding the control, including the corners. See setTitlePanelBorderColor(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setTitlePanelBorderColor

      void setTitlePanelBorderColor​(java.lang.String titlePanelBorderColor)
      Sets the color applied to the border surrounding the control, including the corners. Any valid value for the CSS color property can be used. Setting this property to null removes any existing value. Note that any inherited value from a parent control may still apply.

      Examples: 

       controls.TITLEPANEL1.titlePanelBorderColor = "#808080";
 controls.TITLEPANEL1.titlePanelBorderColor("green");
      Since:
      V4.4

    • getTitlebarCornerType

      java.lang.String getTitlebarCornerType()
      The style of corner applied to the top left and top right corners. See setTitlebarCornerType(String) for details of supported values when setting this property.
      Since:
      V4.4
      See Also:
      getPanelCornerType()

    • setTitlebarCornerType

      void setTitlebarCornerType​(java.lang.String titlebarCornerType)
      Sets the style of corner applied to the top left and top right corners.

      Supported values:

      ValueDescription
      RoundedCorners are drawn with a rounded image
      SquareCorners are square
      SlashCorners are a straight diagonal line

      Examples: 

       controls.TITLEPANEL1.titlebarCornerType = "Rounded";
 controls.TITLEPANEL1.titlebarCornerType("Square");
      Since:
      V4.4
      See Also:
      setPanelCornerType(String)

    • getTitlebarColor

      java.lang.String getTitlebarColor()
      The background color for the title bar. See setTitlebarColor(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setTitlebarColor

      void setTitlebarColor​(java.lang.String titlebarColor)
      Sets the background color for the title bar. Any valid value for the CSS color property can be used.

      Examples: 

       controls.TITLEPANEL1.titlebarColor = "#808080";
      Since:
      V4.4

    • getTextImageGap

      java.lang.String getTextImageGap()
      The gap between the title text and any optional image. See setTextImageGap(String) for details of supported values when setting this property.

      Further documentation.

      Since:
      V4.4

    • setTextImageGap

      void setTextImageGap​(java.lang.String textImageGap)
      Sets the gap between the title text and any optional image. Any valid value for the CSS font-size property can be used.

      Further documentation.

      Examples: 

       controls.TITLEPANEL1.textImageGap = "30px";
      Since:
      V4.4

    • getImagePosition

      java.lang.String getImagePosition()
      The position of the optional image relative to the text. See setImagePosition(String) for details of supported values when setting this property.

      Further documentation.

      Since:
      V4.4

    • setImagePosition

      void setImagePosition​(java.lang.String imagePosition)
      Sets the position of the optional image relative to the text.

      Supported values:

      ValueDescription
      LeftImage is positioned to the left of the text
      RightImage is positioned to the right of the text
      NoneNo image will be displayed

      Further documentation.

      Examples: 

       controls.TITLEPANEL1.imagePosition = "Left";
      Since:
      V4.4

    • getTitleBarStyle

      TitleBarProperties getTitleBarStyle()
      Styling properties for the title bar.

      Further documentation.

      Since:
      V4.4

    • getImageProperties

      ImageStyleProperties getImageProperties()
      Styling properties for the optional image in the title bar.

      Further documentation.

      Since:
      V4.4

    • getPanelCornerType

      java.lang.String getPanelCornerType()
      The style of corner applied to the bottom left and bottom right corners. See setPanelCornerType(String) for details of supported values when setting this property.
      Since:
      V4.4
      See Also:
      getTitlebarCornerType()

    • setPanelCornerType

      void setPanelCornerType​(java.lang.String panelCornerType)
      Sets the style of corner applied to the bottom left and bottom right corners.

      Supported values:

      ValueDescription
      RoundedCorners are drawn with a rounded image
      SquareCorners are square
      SlashCorners are a straight diagonal line

      Examples: 

       controls.TITLEPANEL1.panelCornerType = "Rounded";
 controls.TITLEPANEL1.panelCornerType("Square");
      Since:
      V4.4
      See Also:
      setTitlebarCornerType(String)

    • getPanelColor

      java.lang.String getPanelColor()
      The background color for the content area. See setPanelColor(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setPanelColor

      void setPanelColor​(java.lang.String panelColor)
      Sets the background color for the content area. Any valid value for the CSS color property can be used.

      Examples: 

       controls.TITLEPANEL1.panelColor = "#808080";
      Since:
      V4.4

    • getContentHeight

      java.lang.String getContentHeight()
      Height of the content area. See setContentHeight(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setContentHeight

      void setContentHeight​(java.lang.String contentHeight)
      Sets the content area height.

      Any valid value for the CSS height property can be specified e.g. 300px

      Since:
      V4.4

    • getContentPadding

      PaddingStyleProperties getContentPadding()
      Padding properties for the content area - the space between the content area and its border.
      Since:
      V4.4

    • getContentText

      TextStyleProperties getContentText()
      Text properties for the content area.
      Since:
      V4.4

    • getText

      Text getText()
      Returns the Text object for the title bar text.
      Since:
      V4.4

    • getTextClass

      java.lang.String getTextClass()
      Returns the list of CSS classes applied to the title bar text.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setTextClass(String)

    • setTextClass

      void setTextClass​(java.lang.String textClass)
      Sets one or more CSS classes to be applied to the title bar text. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4

    • getTextStyle

      java.lang.String getTextStyle()
      Returns the inline CSS style applied to the title bar text.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setTextStyle(String)

    • setTextStyle

      void setTextStyle​(java.lang.String textStyle)
      Sets the inline CSS style to be applied to the title bar text. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4

    • getImageURL

      java.lang.String getImageURL()
      Returns the URL of the title bar image. The URL can be either relative or absolute.

      Further documentation.

      Since:
      V4.4

    • setImageURL

      void setImageURL​(java.lang.String imageURL)
      Sets the URL of the title bar image. The URL can be either relative or absolute. When absolute, is should start with the protocol e.g. http://www.google.com.

      Further documentation.

      Since:
      V4.4

    • getImageMouseOverText

      Text getImageMouseOverText()
      Returns the Text object for the title bar image mouse over text.
      Since:
      V4.4

    • getImageAltText

      Text getImageAltText()
      Returns the Text object for the title bar image alternatetext.
      Since:
      V4.4

    • getImageClass

      java.lang.String getImageClass()
      Returns the list of CSS classes applied to the title bar image.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setImageClass(String)

    • setImageClass

      void setImageClass​(java.lang.String imageClass)
      Sets one or more CSS classes to be applied to the title bar image. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4

    • getImageStyle

      java.lang.String getImageStyle()
      Returns the inline CSS style applied to the title bar image.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setImageStyle(String)

    • setImageStyle

      void setImageStyle​(java.lang.String imageStyle)
      Sets the inline CSS style to be applied to the title bar image. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4

    • getPanelClass

      java.lang.String getPanelClass()
      Returns the list of CSS classes applied to the content area.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setPanelClass(String)

    • setPanelClass

      void setPanelClass​(java.lang.String panelClass)
      Sets one or more CSS classes to be applied to the content area. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4

    • getPanelStyle

      java.lang.String getPanelStyle()
      Returns the inline CSS style applied to the content area.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setPanelStyle(String)

    • setPanelStyle

      void setPanelStyle​(java.lang.String panelStyle)
      Sets the inline CSS style to be applied to the content area. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4

    • getTitlebarClass

      java.lang.String getTitlebarClass()
      Returns the list of CSS classes applied to the entire title bar.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setTitlebarClass(String)

    • setTitlebarClass

      void setTitlebarClass​(java.lang.String titlebarClass)
      Sets one or more CSS classes to be applied to the entire title bar. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

      These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4

    • getTitlebarStyle

      java.lang.String getTitlebarStyle()
      Returns the inline CSS style applied to the entire title bar.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4
      See Also:
      setTitlebarStyle(String)

    • setTitlebarStyle

      void setTitlebarStyle​(java.lang.String titlebarStyle)
      Sets the inline CSS style to be applied to the entire title bar. Style is entered as for the HTML style parameter.

      This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.

      Since:
      V4.4