Screen

It can be used to specify the components appearing on the screen. The screen can be divided vertically or horizontally, or it can consist of only one component.

/Screen

Root element. Mandatory

Examples

Divided

<?xml version="1.0" encoding="iso-8859-2"?>

<Screen xmlns="http://effector.hu/schema/ns/Screen">
    <Caption>Dashboard</Caption>
    <Splits>
        <Split id="1" orientation="Vertical" splitterDistance="50%">
            <Component1 type="Split">2</Component1>
            <Component2 type="Split">3</Component2>
        </Split>
        <Split id="2" orientation="Horizontal" splitterDistance="33%">
            <Component1 type="Component" id="1">ComponentCF1</Component1>
            <Component2 type="Split">4</Component2>
        </Split>
        <Split id="3" orientation="Horizontal" splitterDistance="33%">
            <Component1 type="Component" id="4">ComponentCF4</Component1>
            <Component2 type="Split">5</Component2>
        </Split>
        <Split id="4" orientation="Horizontal" splitterDistance="50%">
<Component1 type="Component" id="2">ComponentCF2</Component1>
            <Component2 type="Component" id="3">ComponentCF3</Component2>
        </Split>
        <Split id="5" orientation="Horizontal" splitterDistance="50%">
            <Component1 type="Component" id="5">ComponentCF5</Component1>
            <Component2 type="Component" id="6">ComponentCF6</Component2>
        </Split>
    </Splits>
    <Rights>
        <View type="SQL" return="Boolean" default="false"><![CDATA[
            SELECT dbo.[ofn_FSYS_LHC_GetMenuVisibility] ('MMExample', 'ScreenDashboard', '[##Session.UserID##]')
        ]]></View>
    </Rights>
</Screen>

With one component:

<?xml version="1.0" encoding="ISO-8859-2"?>
<Screen xmlns="http://effector.hu/schema/ns/Screen">
    <Caption>Calendar</Caption>    
    <Component>ComponentCalendar</Component>
    <Rights>
        <View type="SQL" return="Boolean" default="false"><![CDATA[
            SELECT dbo.[ofn_FSYS_LHC_GetMenuVisibility] ('MMExample', 'ScreenCalendar', '[##Session.UserID##]')
            ]]></View>
    </Rights>
</Screen>

/Screen/Caption (String)

Optional. The label of the screen that appears in the menu.

/Screen/Width (String)

Optional. The width of the screen in case of a pop-up screen in pixels (400) or in percentage (60%)

/Screen/Height (Integer)

Optional. In case of a pop-up screen, the height of the screen in pixels (600) or in percentage (50%)

/Screen/CssClass (String)

Optional. The CSS classname that is valid for the whole screen. A screens display can be overwritten with it.

/Screen/TemplateURL (String)

Optional. The path of the Angular template that belongs to the screen.

/Screen/Component (String)

Used in case of a one-component screen. Its value is the name of the XML file defining the component, without the dot or extension.

/Screen/Splits

Collection. In case of multiple component/split screens. Contains the definitions of the divisions.

/Screen/Splits/Split

An element of the collection. In case of multiple component/split screens. Defines the definition of one division.

Attributes:

  • id (Integer) - Mandatory. The unique identifier of the split. Unique in the whole XML.
  • orientation (Enum) - Mandatory. The direction of the split. Its possible values are: Horizontal or Vertical.
  • splitterDistance - Mandatory. The distance of the splitter in pixels (number only) or in percentage (number and % sign)
  • disableDrag (Boolean) - Optional. Logical attribute; the dragging of the split between panels can be disabled with it. Default: false.

/Screen/Splits/Split/Component1 (String)

The first component of the split or a new split. Specifying its value is mandatory: the identifier of another split or the name of an XML file without the dot or extension.

Attributes:

  • id(Integer)- Only mandatory in case of a @type=Component. The unique identifier of the component. Unique in the whole XML.

  • type (Enum) - Mandatory. The type of the split's first half. Its possible values: Component, Split.

/Form/Splits/Split/Component2 (String)

The second component of the split or a new split. Specifying its value is mandatory, the identifier of another split or the name of an XML file without the dot or extension.

  • id(Integer)- Only mandatory in case of a @type=Component. The unique identifier of the component. Unique in the whole XML.

  • type (Enum) - Mandatory. The type of the split's second half. Its possible values: Component, `Split'.

/Screen/Connections

Optional. Collection. Defines the connections between the screen`s components.

/Screen/Connections/Connection

An element of the collection. A node describing a connection. Its value is the identifier of the “to where” end of the connection.

Attributes

  • fromComponent (Integer) - Mandatory. The identifier of the “from where” end of the connection.
  • toComponent (Integer) - Mandatory. The identifier of the “to where” end of the connection.
  • isButtonVisible (Boolean) - Optional. The visibility of the arrow showing the direction of the connection can be set with it. Default: true.

Example

<Connection fromComponent="1" toComponent="2" isButtonVisible="false"/>

/Screen/Rights

Optional. Collection. The collection of the rules that can be specified for the screen.

/Screen/Rights/View (RuleValueType)

Optional. This setting serves to disable screens on user-right level.

A complete xml configuration example

Example

<?xml version="1.0" encoding="iso-8859-2"?> <Screen xmlns="http://effector.hu/schema/ns/Screen"> <Caption></Caption> <Width></Width> <Height></Height> <CssClass></CssClass> <TemplateURL></TemplateURL> <!-- There is only this much in case of a single-component screen --> <Component></Component> <!-- This is in case of a split screen or it can be a connections tag --> <Splits> <Split id="" orientation="" splitterDistance="" disableDrag=""> <Component1 type="" id="1"></Component1> <Component2 type="" id="2"></Component2> </Split> <!-- optionally definitions of further Splits--> </Splits> <!-- This is in case of a split screen or it can be a connections tag --> <Connections> <Connection fromComponent="1" toComponent="2"/> </Connections> <Rights> <View type="" return="" default=""></View> </Rights> </Screen>

  • Last update: 19 weeks 3 days ago
  • Effector