oracle.javatools.ui.segmented

Class SegmentedControl<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.javatools.ui.segmented.SegmentedControl<T>

Type Parameters:

T - The type of the underlying Object represented by a Segment.

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public final class SegmentedControl<T>
extends javax.swing.JPanel
implements java.awt.ItemSelectable

An control made up of segments, where each segment is a push button.

This control is commonly used in toolbars to represent a group of closely related button choices, such as left/center/right text alignment, day/week/year views of a calendar.

By default the SegmentedControl is empty, for it to be usable Segments have to be created and added to it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SegmentedControl.InfoTipTemplate<T> Extends oracle.javatools.ui.infotip.templates.Template so that the InfoTip content gets updated to match the current segment under mouse hover.
static class	SegmentedControl.SelectionType The selection type used by a SegmentedControl.

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
SegmentedControl() Create a SegmentedControl that only allows one segment selected at any one time.
SegmentedControl(SegmentedControl.SelectionType selectionType) Create a SegmentedControl.

Method Summary

Modifier and Type	Method and Description
void	addItemListener(java.awt.event.ItemListener itemListener) Listen for selection changes.
void	addSegment(Segment<T> segment) Add a segment to the control.
void	addSegment(Segment<T> segment, int index) Insert segment at the specified index.
java.awt.Dimension	getMaximumSize()
java.awt.Dimension	getMinimumSize()
java.util.List<SegmentButton<T>>	getSegmentButtons()
T	getSelected() Get the first selected Segment.
Segment<T>[]	getSelectedObjects()
SegmentedControl.SelectionType	getSelectionType()
SegmentedControlUI	getUI()
java.lang.String	getUIClassID()
boolean	hasFocus()
boolean	isMaximumSizeSet()
boolean	isMinimumSizeSet()
boolean	isSelected(Segment<T> segment)
boolean	isSelected(T segmentObject)
void	removeAllSegments() Remove all Segments from this control.
void	removeItemListener(java.awt.event.ItemListener itemListener) Stop listening for selection changes.
void	removeSegment(Segment<T> segment) Remove the specified segment from this control.
void	setEnabled(boolean enabled) Enable or disable the whole SegmentedControl.
void	setInfoTip(SegmentedControl.InfoTipTemplate<T> template, InfoTipStyles style, oracle.ide.hover.HoverFlavor flavor, InfoTipOrientation orientation) Set an InfoTip for the SegmentedControl.
void	setSelected(Segment<T> segment) Select a Segment.
void	setSelected(T userObject) Select Segments containing the given object.
void	setUI(javax.swing.plaf.PanelUI ui)
void	updateUI()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, paramString

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SegmentedControl

public SegmentedControl()

Create a SegmentedControl that only allows one segment selected at any one time.

SegmentedControl

public SegmentedControl(SegmentedControl.SelectionType selectionType)

Create a SegmentedControl.

Parameters:

selectionType - the selection type for the control.

Method Detail

getMaximumSize

public java.awt.Dimension getMaximumSize()

Overrides:

getMaximumSize in class javax.swing.JComponent

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

isMinimumSizeSet

public boolean isMinimumSizeSet()

Overrides:

isMinimumSizeSet in class java.awt.Component

isMaximumSizeSet

public boolean isMaximumSizeSet()

Overrides:

isMaximumSizeSet in class java.awt.Component

getSelectionType

public SegmentedControl.SelectionType getSelectionType()

addSegment

public void addSegment(Segment<T> segment)

Add a segment to the control. A segment is added to the right of any existing segments.

Parameters:

segment -

addSegment

public void addSegment(Segment<T> segment,
                       int index)

Insert segment at the specified index.

Parameters:

segment - the Segment to be added

index - the position at which to insert the component, or -1 to append the component to the end

setSelected

public void setSelected(Segment<T> segment)

Select a Segment.

Parameters:

segment -

setSelected

public void setSelected(T userObject)

Select Segments containing the given object.

Parameters:

userObject -

See Also:

Segment.getUserObject()

addItemListener

public void addItemListener(java.awt.event.ItemListener itemListener)

Listen for selection changes.

Specified by:

addItemListener in interface java.awt.ItemSelectable

Parameters:

itemListener -

removeItemListener

public void removeItemListener(java.awt.event.ItemListener itemListener)

Stop listening for selection changes.

Specified by:

removeItemListener in interface java.awt.ItemSelectable

Parameters:

itemListener -

setUI

public void setUI(javax.swing.plaf.PanelUI ui)

Overrides:

setUI in class javax.swing.JPanel

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.JPanel

getUI

public SegmentedControlUI getUI()

Overrides:

getUI in class javax.swing.JPanel

getUIClassID

public java.lang.String getUIClassID()

Overrides:

getUIClassID in class javax.swing.JPanel

hasFocus

public boolean hasFocus()

Overrides:

hasFocus in class java.awt.Component

getSegmentButtons

public java.util.List<SegmentButton<T>> getSegmentButtons()

Returns:

a list of SegmentButtons in this control.

removeSegment

public void removeSegment(Segment<T> segment)

Remove the specified segment from this control. If a selected segment is removed in the single selection mode, the selection is moved to the first segment.

Parameters:

segment -

removeAllSegments

public void removeAllSegments()

Remove all Segments from this control.

getSelected

public T getSelected()

Get the first selected Segment.

Returns:

The first selected segment or null if no segment is selected.

getSelectedObjects

public Segment<T>[] getSelectedObjects()

Specified by:

getSelectedObjects in interface java.awt.ItemSelectable

Returns:

an array of selected Segments.

isSelected

public boolean isSelected(Segment<T> segment)

Parameters:

segment -

Returns:

true if the segment is currently selected

isSelected

public boolean isSelected(T segmentObject)

Parameters:

segmentObject -

Returns:

true if the segment is currently selected

setEnabled

public void setEnabled(boolean enabled)

Enable or disable the whole SegmentedControl.

Overrides:

setEnabled in class javax.swing.JComponent

Parameters:

enabled -

setInfoTip

public void setInfoTip(SegmentedControl.InfoTipTemplate<T> template,
                       InfoTipStyles style,
                       oracle.ide.hover.HoverFlavor flavor,
                       InfoTipOrientation orientation)

Set an InfoTip for the SegmentedControl. The content displayed in the InfoTip hover is created and updated by InfoTipTemplate.

Parameters:

template - InfoTipTemplate containing the content to be shown in the InfoTip.