Package com.jidesoft.swing
Class SidePaneGroup
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<SidePaneItem>
,Collection<SidePaneItem>
,List<SidePaneItem>
,RandomAccess
,SequencedCollection<SidePaneItem>
A data structure used by
SidePane
to represent a group of SidePaneItem
.
Each group usually has one SidePaneItem
selected.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected EventListenerList
A list of event listeners for this component.Fields inherited from class java.util.AbstractList
modCount
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the specified listener to receive side pane events from this side pane group.boolean
Checks if the component exists in this group.protected void
fireSidePaneEvent
(SidePaneItem sidePaneItem, int id) Fires a side pane event.Get longest title in this group.int
Gets the selected index.Gets the selected item.getSidePaneItem
(Component comp) Checks if the component exists in this group.Returns an array of all theSidePaneListener
s added to thisSidePaneGroup
withaddSidePaneListener
.boolean
removeComponent
(Component comp) Removes the component from this group.void
Removes the specified side pane listener so that it no longer receives side pane events from this side pane group.void
setSelectedIndex
(int index) Sets the selected index.void
setSelectedItem
(SidePaneItem selectedItem) Sets the selected item.Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
Methods inherited from class java.util.AbstractCollection
containsAll, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
Methods inherited from interface java.util.List
containsAll, reversed
-
Field Details
-
listenerList
A list of event listeners for this component.
-
-
Constructor Details
-
SidePaneGroup
public SidePaneGroup()Default constructor.
-
-
Method Details
-
getSelectedItem
Gets the selected item. If there is no one is selected, return the first one. If there is no items at all, return null.- Returns:
- the selected item
-
setSelectedItem
Sets the selected item.- Parameters:
selectedItem
- the item to be selected
-
getSelectedIndex
public int getSelectedIndex()Gets the selected index.- Returns:
- the index of the selected item
-
setSelectedIndex
public void setSelectedIndex(int index) Sets the selected index.- Parameters:
index
- the index of the item to be selected
-
getLongestTitle
Get longest title in this group. This is just a handy method which shouldn't really need to be here.- Returns:
- the longest title
-
removeComponent
Removes the component from this group.- Parameters:
comp
- component to be removed- Returns:
true
if the component is removed
-
exists
Checks if the component exists in this group.- Parameters:
comp
- component to be checked- Returns:
true
if the component exists
-
getSidePaneItem
Checks if the component exists in this group.- Parameters:
comp
- component to be checked- Returns:
true
if the component exists
-
addSidePaneListener
Adds the specified listener to receive side pane events from this side pane group.- Parameters:
l
- the side pane listener
-
removeSidePaneListener
Removes the specified side pane listener so that it no longer receives side pane events from this side pane group.- Parameters:
l
- the dockable frame listener
-
getSidePaneListeners
Returns an array of all theSidePaneListener
s added to thisSidePaneGroup
withaddSidePaneListener
.- Returns:
- all of the
SidePaneListener
s added or an empty array if no listeners have been added - See Also:
-
fireSidePaneEvent
Fires a side pane event.- Parameters:
sidePaneItem
- the event sourceid
- the type of the event being fired; one of the following: If the event type is not one of the above, nothing happens.
-