WelcomeScreen

Namespace: PP.Ui;

Inheritance hierarchy

PP.Object

PP.Ui.Control

PP.Ui.DropPanel

PP.Ui.Window

WelcomeScreen

Description

The WelcomeScreen class implements a welcome screen displayed after web application login.

Comments

Example of creating a welcome screen.

Syntax

PP.initClass(PP.Ui.WelcomeScreen, PP.Ui.Window, "PP.Ui.WelcomeScreen");

Methods

	Property name	Brief description
	addAction	The addAction method adds an element to the list of actions in the welcome screen.
	addActions	The addAction method adds elements to the list of actions in the welcome screen.
	addLastDocument	The addLastDocument method adds an element to the list of last opened objects in the welcome screen.
	addLastDocuments	The addLastDocuments method adds element to the list of last opened objects in the welcome screen.
	addToolItem	The addToolItem method adds an element to the list of tools in the welcome screen.
	addToolItems	The addToolItems method adds elements to the list of tools in the welcome screen.
	getMaxActions	The getMaxActions method returns maximum number of actions in the list in the welcome screen.
	getMaxDocuments	The getMaxDocuments method returns maximum number of documents in the list of last documents in the welcome screen.
	showCenter	The showCenter method renders welcome screen in the page center.

Events

	Event name	Brief description
	ActionSelected	The ActionSelected event occurs after selecting the action in the welcome screen.
	DocumentSelected	The DocumentSelected event occurs after selecting the last document in the welcome screen.
	Exit	The Exit event occurs on exiting the welcome screen.
	ToolChanged	The ToolChanged event occurs after changing a tool in the welcome screen.
	ToolSelected	The ToolSelected event occurs after repeated selecting the tool in the welcome screen.

Properties inherited from the class Window

	Property name	Brief description
	Caption	The Caption property sets a window title.
	CaptionIcon	The CaptionIcon property determines the path to window title image.
	DragContentView	The DragContentView property determines whether window is displayed on moving.
	EnableMove	The EnableMove property determines whether window can be moved.

Methods inherited from the class Window

	Method name	Brief description
	expand	The expand method expands the window.
	getCloseButton	The getCloseButton method returns the button that closes the window.
	getExpandButton	The getExpandButton method returns the button that expands the window.
	getIsExpanded	The getIsExpanded method returns whether the window is expanded.
	showDialog	The showDialog method displays a dialog box.

Events inherited from the class Window

	Event name	Brief description
	Expanded	The Expanded event occurs after window expanding.
	Expanding	The Expanding event occurs on window expanding.
	Moved	The Moved event occurs after window moving.
	Moving	The Moving event occurs on window moving.

Properties inherited from the class DropPanel

	Property name	Brief description
	EnableResize	The EnableResize property determines whether the component can be resized.
	EnableResizeBottom	The EnableResizeBottom property determines whether the component height can be changed by dragging its bottom border with the mouse cursor.
	EnableResizeLeft	The EnableResizeLeft property determines whether the component width can be changed by dragging its left border with the mouse cursor.
	EnableResizeRight	The EnableResizeRight property determines whether the component width can be changed by dragging its right border with the mouse cursor.
	EnableResizeTop	The EnableResizeTop property determines whether the component height can be changed by dragging its top border with the mouse cursor.
	EnableRestoreFocus	The EnableRestoreFocus property determines whether focus can be restored on closing the panel.
	MaxDropDownHeight	The MinDropDownHeight property sets minimum height for a drop-down panel.
	MaxDropDownWidth	The MaxDropDownWidth property sets maximum width for a drop-down panel.
	MinDropDownHeight	The MinDropDownHeight property sets minimum height for a drop-down panel.
	MinDropDownWidth	The MinDropDownWidth property sets minimum width for a drop-down panel.

Methods inherited from the class DropPanel

	Method name	Brief description
	getDroppedDown	The getDroppedDown returns whether the panel is expanded.
	isVisibleArea	The isVisibleArea method determines whether the visible area includes the drop-down part.
	setPosition	The setPosition method sets the position of the drop-down panel.
	show	The show method expands the panel.

Events inherited from the class DropPanel

	Event name	Brief description
	Closed	The Closed event occurs after closing the component.
	FrameDown	The FrameDown event occurs on clicking outside the panel.
	Opened	The Opened event occurs after opening the component.
	Opening	The Opening event occurs before opening the component.
	OutOfPanelDown	The OutOfPanelDown event occurs on click outside the panel area if the panel is displayed without the support frame.
	SizeChanged	The SizeChanged event occurs after resizing the component.
	SizeChanging	The SizeChanging event occurs before resizing the component.

Properties inherited from the class Control

	Property name	Brief description
	Anchors	The Anchors property determines position of the component placed within container.
	Animation	The Animation property determines component animation parameters.
	Bottom	The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
	Content	The Content property determines component contents.
	ContextMenu	The ContextMenu property determines a component's context menu.
	Data	The Data property is used to store any custom data.
	Enabled	The Enabled property determines whether a component can be used.
	Height	The Height property determines component height.
	IsRTL	The IsRTL property determines whether component elements are aligned to the right.
	IsVisible	The IsVisible property determines whether a component is displayed.
	Left	The Left property determines a left margin if a component is placed inside GridPanel.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property determines a parent DOM node.
	ResourceKey	The ResourceKey property determines a component resource key.
	Right	The Right property determines a right margin if a component is placed inside LayoutPanel.
	Rotate	The Rotate property determines a component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether a tooltip of the component can be displayed.
	Style	The Style property determines a component style.
	TabIndex	The TabIndex property determines the order of the control element passing inside the container.
	Tag	The Tag property determines a JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property determines a top margin if a component is placed inside GridPanel.
	Value	The Value property determines a component value.
	Width	The Width property determines component width.

Methods inherited from the class Control

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether a component can be dragged on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method sets up component displaying only on mouseover.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the mouse button.
	DragEnd	The DragEnd event occurs when dragging the component finishes.
	DragStart	The DragStart event occurs when dragging the component starts.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of the component.
	SizeChanged	The SizeChanged event occurs after the component is resized.
	SizeChanging	The SizeChanging event occurs during component resize.

Properties inherited from the Object class

	Property name	Brief description
	Id	The Id property determines a repository object identifier.

Methods   inherited from the Object class

	Method name	Brief description
	clone	The clone method creates an object copy.
	dispose	The dispose method deletes the component.
	getHashCode	The getHashCode method returns hash code of repository object.
	getId	The getId method returns repository object identifier.
	getSettings	The getSettings method returns repository object settings.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.
	isEqual	The isEqual method determines whether the specified object is equal to the current repository object.
	isLive	The isLive method determines validity of repository object.
	removeAllEvents	The removeAllEvents method removes all object event handlers by the specified context.
	setId	The setId method determines a repository object identifier.
	setSettings	The setSettings method determines repository object settings.
	defineProps	The defineProps method creates get and set methods from name array for the specified class.
	keys	The keys method returns array of methods and properties names for the specified object.

See also:

PP.Ui

Copy page URL

Back to top

To report a found bug, please, select the text with the bug and click Report a Bug or CTRL+ENTER.

Help system 10.5 of 04/10/2024, © FORESIGHT