org.dominokit.domino.ui.utils

Interface IsCollapsible<T>

Type Parameters:

T - the type of the component implementing this interface

All Known Implementing Classes:

AbstractMenu, AbstractMenuItem, AbstractSelect, AbstractSuggestBox, AbstractTagsInput, AbstractValueBox, Accordion, AccordionPanel, AdvancedPagination, Alert, AlertLink, AutoHScrollPanel, AutoScrollPanel, AutoVScrollPanel, Badge, BaseButton, BaseDominoElement, BaseIcon, BaseLoader, BaseModal, BasePagination, BasicFormElement, BigDecimalBox, BlockHeader, Blockquote, BounceLoader, BouncePulseLoader, Breadcrumb, BreadcrumbItem, Button, ButtonsGroup, ButtonsToolbar, Card, Carousel, CheckBox, Chip, ChipsGroup, Collapsible, Column, ConfirmationDialog, Content, CustomMenuItem, DataTable, DateBox, DatePicker, DominoElement, DoubleBox, DropdownAction, DropdownActionsGroup, DropdownButton, DropDownMenu, EmailBox, EmptyState, FacebookLoader, FileImage, FileItem, FileUpload, FillItem, FlexItem, FlexLayout, FloatBox, Footer, GridLayout, HeaderAction, HScrollPanel, HSpinSelect, HSplitPanel, Icon, InfoBox, InputTimeBox, InputValueBox, IntegerBox, IosLoader, JustifiedGroup, Label, LabeledIcon, Layout, LayoutActionItem, ListGroup, ListItem, LongBox, MdiIcon, MediaObject, Menu, MenuHeader, MenuItem, MessageDialog, ModalDialog, MultiSelect, NavigationBar, NoneLoader, Notification, NumberBox, OrbitLoader, Overlay, Pager, Paragraph, Popover, Preloader, Progress, ProgressBar, ProgressBarLoader, PulseLoader, Radio, RadioGroup, RotatePlaneLoader, RotationLoader, RoundBounceLoader, Row, Row_12, Row_16, Row_18, Row_24, Row_32, ScrollingPagination, ScrollPanel, ScrollTop, Search, SearchBox, Section, Select, SelectOption, SelectOptionGroup, ShortBox, SimplePagination, Slide, Slider, SpinItem, SplitButton, SplitPanel, Step, Step, Stepper, Stepper, StretchLoader, Strong, SuggestBox, SwitchButton, Tab, TableRow, TabsPanel, TagsInput, TelephoneBox, TextArea, TextBox, Thumbnail, TimeBox, TimerLoader, Tooltip, TopBarAction, Tree, TreeItem, UrlIcon, ValueBox, VerticalTab, VerticalTabsPanel, VScrollPanel, VSpinSelect, VSplitPanel, VTabsContainer, WavesElement, Win8LinearLoader, Win8Loader, Window

public interface IsCollapsible<T>

A component that can be shown/hidden should implement this interface

See Also:

Collapsible

Method Summary

Modifier and Type	Method and Description
T	hide() Hides the component
boolean	isCollapsed()
default boolean	isExpanded()
boolean	isHidden() Deprecated. use isCollapsed()
T	show() Show the component
T	toggleDisplay() if the component is visible then hide it, otherwise show it
T	toggleDisplay(boolean state) Show/hides the component based on the provided flag

Method Detail

show

T show()

Show the component

Returns:

same component instance

hide

T hide()

Hides the component

Returns:

same component instance

toggleDisplay

T toggleDisplay()

if the component is visible then hide it, otherwise show it

Returns:

same component instance

toggleDisplay

T toggleDisplay(boolean state)

Show/hides the component based on the provided flag

Parameters:

state - boolean, if true show the component, if false hide it

Returns:

same component instance

isHidden

@Deprecated
boolean isHidden()

Deprecated. use isCollapsed()

Returns:

boolean, true if the component is hidden

isCollapsed

boolean isCollapsed()

Returns:

boolean, true if the component is collapsed

isExpanded

default boolean isExpanded()

Returns:

boolean, true if the component is expanded