ILIAS  trunk Revision v11.0_alpha-1811-gd2d5443e411
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
WithNoUIFactories Class Reference
+ Inheritance diagram for WithNoUIFactories:
+ Collaboration diagram for WithNoUIFactories:

Public Member Functions

 __construct (I\Button\Factory $button_factory, I\Symbol\Factory $symbol_factory, I\Popover\Factory $popover_factory, I\Legacy\Factory $legacy_factory, I\Listing\Factory $listing_factory)
 
 button ()
 

description: purpose: > Buttons trigger interactions that change the system’s or view's status. More...

 
 symbol ()
 

description: purpose: > Symbols are graphical representations of concepts or contexts quickly comprehensible or generally known to the user. More...

 
 popover ()
 

description: purpose: > Popovers can be used when space is scarce i.e. More...

 
 legacy ()
 

description: purpose: > legacy components are used as provisional elements in the UI framework while there are no sophisticated components yet replacing them. More...

 
 listing ()
 

description: purpose: > Listings are used to structure itemised textual information. More...

 
- Public Member Functions inherited from NoUIFactory
 counter ()
 

description: purpose: > Counter inform users about the quantity of items indicated by a glyph. More...

 
 button ()
 

description: purpose: > Buttons trigger interactions that change the system’s or view's status. More...

 
 card ()
 

description: purpose: > A card is a flexible content container for small chunks of structured data. More...

 
 deck (array $cards)
 

description: purpose: > Decks are used to display multiple Cards in a grid. More...

 
 listing ()
 

description: purpose: > Listings are used to structure itemised textual information. More...

 
 image ()
 

description: purpose: The Image component is used to display images of various sources. More...

 
 legacy ()
 

description: purpose: > legacy components are used as provisional elements in the UI framework while there are no sophisticated components yet replacing them. More...

 
 panel ()
 

description: purpose: > Panels are used to group titled content. More...

 
 modal ()
 

description: purpose: The Modal forces users to focus on the task at hand. More...

 
 progress ()
 

description: purpose: > A Progress component is designed to represent the users advancement within a certain process or task. More...

 
 dropzone ()
 

description: purpose: > Dropzones are containers used to drop either files or other HTML elements. More...

 
 popover ()
 

description: purpose: > Popovers can be used when space is scarce i.e. More...

 
 divider ()
 

description: purpose: > A divider marks a thematic change in a sequence of other components. More...

 
 link ()
 

description: purpose: > Links are used navigate to other resources or views of the system by clicking or tapping them. More...

 
 dropdown ()
 

description: purpose: > Dropdowns reveal a list of interactions that change the system’s status or navigate to a different view. More...

 
 item ()
 

description: purpose: > An item displays a unique entity within the system. More...

 
 viewControl ()
 

description: purpose: > View Controls switch between different visualisation of data. More...

 
 breadcrumbs (array $crumbs)
 

description: purpose: > Breadcrumbs is a supplemental navigation scheme. More...

 
 chart ()
 

description: purpose: > Charts are used to graphically represent data in various forms such as maps, graphs or diagrams. More...

 
 input ()
 

description: purpose: > In opposite to components with a purely receptive or at most navigational character, input elements are used to relay user-induced data to the system. More...

 
 table ()
 

description: purpose: > Tables present a set of uniformly structured data. More...

 
 messageBox ()
 

description: purpose: > Message Boxes inform the user about the state of the system or an ongoing user task. More...

 
 layout ()
 

description: purpose: > Layout components are components used for the overall construction of the user interface. More...

 
 mainControls ()
 

description: purpose: > Main Controls are components that are always usable, depending only on overall configuration or roles of the user, not depending on the current content. More...

 
 tree ()
 

description: purpose: > Trees present hierarchically structured data. More...

 
 menu ()
 

description: purpose: > Menus let the user choose from several (navigational) options. More...

 
 symbol ()
 

description: purpose: > Symbols are graphical representations of concepts or contexts quickly comprehensible or generally known to the user. More...

 
 toast ()
 

description: purpose: Toasts are temporary messages from the system published to the user. More...

 
 player ()
 

description: purpose: > The Player component is used to play and control a media source. More...

 
 launcher ()
 

description: purpose: > The Launcher starts an object, a process or a workflow. More...

 
 helpTopics (string ... $topic)
 

description: purpose: > Help Topics can be attached to certain components. More...

 
 entity ()
 

description: purpose: > An Entity displays information about entities within the system, when the purpose is to represent the entity itself. More...

 
 prompt ()
 

description: purpose: > A Prompt requires a user to make some inputs to the system, like making choices, acknowleding an important information or filling out a form. More...

 

Protected Attributes

I Button Factory $button_factory
 
I Symbol Factory $symbol_factory
 
I Popover Factory $popover_factory
 
I Legacy Factory $legacy_factory
 
I Listing Factory $listing_factory
 

Detailed Description

Definition at line 28 of file StandardFilterTest.php.

Constructor & Destructor Documentation

◆ __construct()

WithNoUIFactories::__construct ( I\Button\Factory  $button_factory,
I\Symbol\Factory  $symbol_factory,
I\Popover\Factory  $popover_factory,
I\Legacy\Factory  $legacy_factory,
I\Listing\Factory  $listing_factory 
)

Definition at line 36 of file StandardFilterTest.php.

References $button_factory, $legacy_factory, $listing_factory, $popover_factory, and $symbol_factory.

42  {
43  $this->button_factory = $button_factory;
44  $this->symbol_factory = $symbol_factory;
45  $this->popover_factory = $popover_factory;
46  $this->legacy_factory = $legacy_factory;
47  $this->listing_factory = $listing_factory;
48  }
I Listing Factory $listing_factory
I Symbol Factory $symbol_factory
I Popover Factory $popover_factory
I Button Factory $button_factory
I Legacy Factory $legacy_factory

Member Function Documentation

◆ button()

WithNoUIFactories::button ( )


description: purpose: > Buttons trigger interactions that change the system’s or view's status.

Acceptable changes to the current view are those that do not result in a complete replacement of the overall screen (e.g. modals). composition: > Button is a clickable, graphically obtrusive control element. It can bear text and/or a Glyph. effect: > On-click, the action indicated by the button is carried out. A stateful button will indicate its state with the engaged state. rivals: links: > Links are used to trigger Interactions that do not change the systems status. They are usually contained inside a Navigational Collection. background: > Wording rules have been inspired by the iOS Human Interface Guidelines (UI-Elements->Controls->System Button) Style rules have been inspired from the GNOME Human Interface Guidelines->Buttons. Concerning aria-roles, see: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/button_role rules: usage: 1: > Buttons MUST NOT be used inside a Textual Paragraph. interaction: 2: > If an action is temporarily not available, Buttons MUST be disabled by setting as type 'disabled'. 3: > A button MUST NOT be used for navigational purpose. style: 1: > If Text is used inside a Button, the Button MUST be at least six characters wide. 2: > The Button MUST be designed in a way it is perceived as important and active, but not clickable, if the Button is engaged. wording: 1: > The caption of a Button SHOULD contain no more than two words. 2: > The wording of the button SHOULD describe the action the button performs by using a verb or a verb phrase. 3: > Every word except articles, coordinating conjunctions and prepositions of four or fewer letters MUST be capitalized. 4: > For standard events such as saving or canceling the existing standard terms MUST be used if possible: Save, Cancel, Delete, Cut, Copy. 5: > There are cases where a non-standard label such as “Send Mail” for saving and sending the input of a specific form might deviate from the standard. These cases MUST however specifically justified. accessibility: 1: > DOM elements of type "button" MUST be used to properly identify an element as a Button if there is no good reason to do otherwise. 2: > Button DOM elements MUST either be of type "button", of type "a" accompanied with the aria-role “Button” or input along with the type attribute “button” or "submit". 3: > If the Button is carrying the focus (e.g. by tabbing) and is visible it MUST always be visibly marked (e.g. by some sort of highlighting). 4: > All Buttons visible in a view MUST be accessible by keyboard by using the ‘Tab’-Key. 5: > The engaged state MUST be reflected in the "aria-pressed" -, respectively the "aria-checked"-attribute if active. If the Button is not engaged (which is the default), the aria-attribute can be omitted. composition: 1: >

If a button has a help topic, it should be rendered as a tool tip.

Returns

Implements ILIAS\UI\Implementation\FactoryInternal.

Definition at line 50 of file StandardFilterTest.php.

References $button_factory.

Referenced by StandardFilterTest\testRenderActivatedCollapsed(), StandardFilterTest\testRenderActivatedExpanded(), StandardFilterTest\testRenderDeactivatedCollapsed(), and StandardFilterTest\testRenderDeactivatedExpanded().

50  : I\Button\Factory
51  {
52  return $this->button_factory;
53  }
I Button Factory $button_factory
+ Here is the caller graph for this function:

◆ legacy()

WithNoUIFactories::legacy ( )


description: purpose: > legacy components are used as provisional elements in the UI framework while there are no sophisticated components yet replacing them.

composition: > Legacy component regularly contain rendered HTML.

rules: usage: 1: > Legacy components MUST only be used to ensure backwards compatibility with existing UI elements in ILIAS or to implement temporal and provisional

dependencies.

Returns

Implements ILIAS\UI\Implementation\FactoryInternal.

Definition at line 65 of file StandardFilterTest.php.

References $legacy_factory.

65  : I\Legacy\Factory
66  {
67  return $this->legacy_factory;
68  }
I Legacy Factory $legacy_factory

◆ listing()

WithNoUIFactories::listing ( )


description: purpose: > Listings are used to structure itemised textual information.

composition: > Listings may contain ordered, unordered, or labeled items. effect: > Listings hold only textual information. They may contain Links but no Buttons. rules: composition:

1: Listings MUST NOT contain Buttons.

Returns

Implements ILIAS\UI\Implementation\FactoryInternal.

Definition at line 70 of file StandardFilterTest.php.

References $listing_factory.

70  : I\Listing\Factory
71  {
73  }
I Listing Factory $listing_factory

◆ popover()

WithNoUIFactories::popover ( )


description: purpose: > Popovers can be used when space is scarce i.e.

within List GUI items, table cells or menus in the Header section. They offer either secondary information on object like a preview or rating to be displayed or entered. They display information about ongoing processes composition: > Popovers consist of a layer displayed above all other content. The content of the Popover depends on the functionality it performs. A Popover MAY display a title above its content. All Popovers contain a pointer pointing from the Popover to the Triggerer of the Popover. effect: > Popovers are shown by clicking a Triggerer component such as a Button or Glyph. The position of the Popover is calculated automatically be default. However, it is possible to specify if the popover appears horizontal (left, right) or vertical (top, bottom) relative to its Triggerer component. Popovers disappear by clicking anywhere outside the Popover or by pressing the ESC key. rivals: > Modals: > Modals hide all other content while Popovers do not prevent interaction with other parts of the current context. rules: usage: 1: > Popovers MUST NOT contain horizontal scrollbars. 2: > Popovers MAY contain vertical scrollbars. The content component is responsible to define its own height and show vertical scrollbars. 3: > If Popovers are used to present secondary information of an object, they SHOULD display a title representing the object. interaction: 1: > A Popover MUST only be displayed if the Trigger component is clicked. This behaviour is different from Tooltips that appear on hovering. Popovers disappear by clicking anywhere outside the Popover or by pressing the ESC key. style: 1: Popovers MUST always relate to the Trigger component by a little pointer. accessibility: 1: > There MUST be a way to open the Popover by only using the keyboard. 2: > The focus MUST be inside the Popover, once it is open if it contains at least one interactive item. Otherwise the focus MUST remain on the Triggerer component. 3: > The focus MUST NOT leave the Popover for as long as it is open. 4: > There MUST be a way to reach every control in the Popover by only using the keyboard. 5: > The Popover MUST be closable by pressing the ESC key. 6: > Once the Popover is closed, the focus MUST return to the element triggering the opening of the Popover or the element being clicked if the Popover was

closed on click.

Returns

Implements ILIAS\UI\Implementation\FactoryInternal.

Definition at line 60 of file StandardFilterTest.php.

References $popover_factory.

60  : I\Popover\Factory
61  {
63  }
I Popover Factory $popover_factory

◆ symbol()

WithNoUIFactories::symbol ( )


description: purpose: > Symbols are graphical representations of concepts or contexts quickly comprehensible or generally known to the user.

composition: Symbols contain a graphical along with textual representation describing, what the graphic is depicting. rules: accessibility: 1: Symbols MUST have labels which then might be used to display some alternative text (e.g. as alt attribute). 2: The label of the Symbol MUST NOT be displayed, if the Symbol has a purely decorative function (as e.g. in

primary buttons).

Returns

Implements ILIAS\UI\Implementation\FactoryInternal.

Definition at line 55 of file StandardFilterTest.php.

References $symbol_factory.

55  : I\Symbol\Factory
56  {
57  return $this->symbol_factory;
58  }
I Symbol Factory $symbol_factory

Field Documentation

◆ $button_factory

I Button Factory WithNoUIFactories::$button_factory
protected

Definition at line 30 of file StandardFilterTest.php.

Referenced by __construct(), and button().

◆ $legacy_factory

I Legacy Factory WithNoUIFactories::$legacy_factory
protected

Definition at line 33 of file StandardFilterTest.php.

Referenced by __construct(), and legacy().

◆ $listing_factory

I Listing Factory WithNoUIFactories::$listing_factory
protected

Definition at line 34 of file StandardFilterTest.php.

Referenced by __construct(), and listing().

◆ $popover_factory

I Popover Factory WithNoUIFactories::$popover_factory
protected

Definition at line 32 of file StandardFilterTest.php.

Referenced by __construct(), and popover().

◆ $symbol_factory

I Symbol Factory WithNoUIFactories::$symbol_factory
protected

Definition at line 31 of file StandardFilterTest.php.

Referenced by __construct(), and symbol().


The documentation for this class was generated from the following file: