|
|
| collapse () |
| | Collapse this sidebar to STATUS_COLLAPSED status.
|
| |
|
| collapseTotally () |
| | Collapse this sidebar to STATUS_COLLAPSED_TOTALLY status.
|
| |
|
| expand (width=this.expandWidth) |
| | Expand this sidebar to the width that memorized before collapsed and triggeres a COMOPNENT_EVENTS.EXPAND event.
|
| |
| | isCollapsed () |
| | Detect whether this sidebar is collapsed, a collapsed sidebar means that the value of status attribute should be STATUS_COLLAPSED or STATUS_COLLAPSED_TOTALLY. More...
|
| |
| | append (child) |
| | Inserts a component before the first child of this container component. More...
|
| |
| | childAt (index) |
| | Get the specific child component at the given zero-based index. Returns undefined if the index is out of range. More...
|
| |
| | children () |
| | Get all children of this container component. More...
|
| |
| | doInsertAll (children, index) |
| | Insert components array into this container component at the specified index. More...
|
| |
|
| empty () |
| | Remove all children of this component.
|
| |
| | first () |
| | Get the first child fom this container component, if there is no children, null will returned. More...
|
| |
| | indexOf (child) |
| | Get the index of an child component. More...
|
| |
| | insert (child, index) |
| | Inserts a component. More...
|
| |
| | insertAll (children, index) |
| | Inserts a set of components to the specified index. More...
|
| |
| | last () |
| | Get the last child from this container component. More...
|
| |
| | prepend (child) |
| | Inserts a component after the last child of thie container component. More...
|
| |
| | removeChild (child) |
| | Remove a child from this component and trigger UIExtension.UIConsts.COMPONENT_EVENTS.REMOVED event;. More...
|
| |
| | size () |
| | The number of children in this container component. More...
|
| |
| | active () |
| | Actives the component, and set isActive property to true, this method triggers UIExtension.UIConsts.COMPONENT_EVENTS.ACTIVE event. More...
|
| |
| | addDestroyHook (...hooks) |
| | Add a function to destroyHooks list, which will be called during destroy. More...
|
| |
| | after (component) |
| | Inserts this component after the specified component. More...
|
| |
| | before (component) |
| | Insert this component before the specified component. More...
|
| |
| | deactive () |
| | Deactives the component, and set isActive property to false, this method triggers UIExtension.UIConsts.COMPONENT_EVENTS.DEACTIVE event. More...
|
| |
| | destroy () |
| | Destroy the component and remove from its parent. this method triggers UIExtension.UIConsts.COMPONENT_EVENTS.DESTROYED event. More...
|
| |
| | disable () |
| | To disable the component, and set disabled property to true, this method triggers UIExtension.UIConsts.COMPONENT_EVENTS.DISABLE event. More...
|
| |
| | enable () |
| | Enables component, and set disabled property to false, this method triggers UIExtension.UIConsts.COMPONENT_EVENTS.ENABLE event. More...
|
| |
| | findClosestComponent (callback) |
| | Find the closest component that pass the test implemented by the provided callback. More...
|
| |
| | getComponentByName (name) |
| | This method returns an Component object representing the component whose name property matches the specified string. If there are more than one components matched, only the first one is taken. More...
|
| |
| | getPDFUI () |
| | Get PDFUI instance, PDFUI instance is passing into a component after constructed. So that an undefined value will be returned in constructoring lifecycle. More...
|
| |
| | getRoot () |
| | Get root component of this component tree. More...
|
| |
| | hide () |
| | Hide component and set isVisible property to false, this method UIExtension.UIConsts.COMPONENT_EVENTS.HIDDEN event. More...
|
| |
| | index () |
| | Get the index of this component in parent. More...
|
| |
| | localize (localizer=this.localizer) |
| | Localize message with the value of the data-i18n attribute above the DOM element of component recursively. More...
|
| |
| | nextSiblings () |
| | This method returns the component immediately following this component's parent children list, or returns null if this component is the last in that list. More...
|
| |
| | off (eventName, listener) |
| | Unregister event handler of a geven event type, if no handler function specified, all handler of this given event type will be removed. More...
|
| |
| | on (eventName, listener) |
| | Registers an event handler to a specific event type on the component. More...
|
| |
| | once (eventName, listener) |
| | Registers an event handler to a specific event type on the component, but difference from Component#on, this event handler will be triggered only once. More...
|
| |
| | previousSiblings () |
| | This method returns the component immediately preceding this component's parent children list, or returns null if this component is the first in that list. More...
|
| |
| | remove () |
| | Remove component from its parent, and triggers UIExtension.UIConsts.COMPONENT_EVENTS.REMOVED event. More...
|
| |
|
| removeElement () |
| | Remove element from DOM tree.
|
| |
| | show () |
| | Shows up component, and set isVisible property to true, this method triggers UIExtension.UIConsts.COMPONENT_EVENTS.SHOWN event. More...
|
| |
| | trigger (eventName,...data) |
| | Calls each of the listeners registered for a given event type. More...
|
| |
|
| static | getName () |
| | This method returns a string identifies as the name of a component type that you can use this string as the tag name in the template. Each component must override this static method so that the template can get this component class. More...
|
| |
| | doInsert (child, index) |
| | Insert component into this container component at the specified index. More...
|
| |
| | getContainerElement () |
| |
|
| rerenderChildren () |
| | Rerender all children of this container component, it's called after children removed or added,.
|
| |
| | createDOMElement () |
| | This method creates a HTMLElement as the root element for this component. More...
|
| |
|
| doActive () |
| | This method is called after the component is activated. It is used to update the rendering effect after the component is activated. It is usefull to override this method to customize the rendering.
|
| |
|
| doDeactive () |
| | This method is called after the component is deactivated. It is used to update the rendering effect after the component is deactivated. It is usefull to override this method to customize the rendering.
|
| |
|
| doDestroy () |
| | This method is called to destroy the component, You should override this method for your custom component to write your customize destroy logic.
|
| |
|
| doDisable (reason='') |
| | This method is called after the component is disabled. It is used to update the rendering effect after the component is disabled. It is usefull to override this method to customize the rendering.
|
| |
|
| doEnable (reason='') |
| | This method is called after the component is enabled. It is used to update the rendering effect after the component is enabled. It is usefull to override this method to customize the rendering.
|
| |
|
| doHidden () |
| | This method is called to hide the DOM element of this component. It is usefull to override this method to customize the hidding logic.
|
| |
|
| doShown () |
| | This method is called to show the DOM element of this component. It is usefull to override this method to customize the showing logic.
|
| |
| | mounted () |
| | Lifecycle method: mounted. The mounted method is called after the element of component is appended into the DOM tree. More...
|
| |
| | postlink () |
| | Lifecycle method: postlink. The postlink method is called after all of the children are parsed. More...
|
| |
| | prelink () |
| | Lifecycle method: prelink. The prelink method is called after component is rendered. More...
|
| |
| | render () |
| | Lifecycle method: render. The render method is always been called to create DOM element of the component, it's called after createDOMElement called and before calling prelink. More...
|
| |
Defines sidebar component, It offers the following features:
Defines sidebar panel component. Each tab of sidebar is called sidebar-panel, this is a container component with an icon and title. It must be the child of a sidebar component. For more details on usage please visit this page /examples/UIExtension/tutorials/widgets/sidebar.html
- Dock on the left of the content.
- 3 status: collapse, collapse-tottaly and expand.
- Support for resizing by mouse dragging. For more details on usage please visit this page /examples/UIExtension/tutorials/widgets/sidebar.html