|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
contrib.com.blogofbug.swing.components.GradientPanel
contrib.com.blogofbug.swing.components.JCarosel
public class JCarosel
A carousel component which lays out components around a carousel, moving each to the front as it is clicked on. Double clicking will fire the action associated with the compnent if it has one, or give it the focus if it does not. Note this will be changed to only allow RichComponents in the future.
Nested Class Summary |
---|
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 | |
---|---|
protected int |
DEFAULT_CONTENT_WIDTH
The prefered width of the components in the container, everything will be scaled to this width for neutral scaling (1.0) |
static java.lang.String |
FRONT_COMPONENT_CHANGE
The property that is set when a new component comes to the front. |
protected java.awt.Component |
lastWheeledTo
The last component the wheel selected. |
protected CaroselLayout |
layout
The layout being used for the carousel |
protected int |
spinStartDelay
Delay in milliseconds from the first click to the start of the spin, this gives implementors using a double click anywhere to fire an event a chance for their users to get the double click message before the component spins around. |
Fields inherited from class contrib.com.blogofbug.swing.components.GradientPanel |
---|
cache, end, gp, start |
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, 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 |
---|
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 | |
---|---|
JCarosel()
Creates a new instance of JCarosel |
|
JCarosel(int contentWidth)
Creates a new Carousel specifying the prefered width up front |
Method Summary | |
---|---|
java.awt.Component |
add(java.awt.Component component)
Adds a component to the carousel |
java.awt.Component |
add(java.awt.Image image,
java.lang.String text)
Adds an image to the carousel |
java.awt.Component |
add(java.lang.String imageURL)
Adds a new image to the carousel |
java.awt.Component |
add(java.lang.String imageURL,
int width,
int height)
Deprecated. This function will be removed, use add(String imageURL) instead. |
java.awt.Component |
add(java.lang.String imageURL,
java.lang.String textLabel)
Adds a new image to the carousel |
java.awt.Component |
add(java.lang.String imageURL,
java.lang.String text,
int width,
int height)
Deprecated. This function will be removed, use setNeutralWidth() on JCarousel instead. |
void |
bringToFront(java.awt.Component component)
Brings the specified component to the front of the carousel |
void |
finalizeLayoutImmediately()
Moves everything to their final positions |
java.awt.Component |
getFrontmost()
Which component is at the front |
int |
getSpinStartDelay()
Returns the spin start delay |
java.awt.Component |
insertAt(int i,
java.lang.String imageURL,
int width,
int height)
Inserts a new object at a specific location |
java.awt.Component |
insertAt(int i,
java.lang.String imageURL,
java.lang.String text,
int width,
int height)
Inserts a new object at a specific location |
void |
insertComponentAt(int i,
java.awt.Component comp)
Inserts a component at the specified index |
void |
mouseClicked(java.awt.event.MouseEvent mouseEvent)
Bring the "clicked" component to the front. |
void |
mouseEntered(java.awt.event.MouseEvent mouseEvent)
Not interested |
void |
mouseExited(java.awt.event.MouseEvent mouseEvent)
Not interested |
void |
mousePressed(java.awt.event.MouseEvent mouseEvent)
Not interested |
void |
mouseReleased(java.awt.event.MouseEvent mouseEvent)
Not interested |
void |
mouseWheelMoved(java.awt.event.MouseWheelEvent mouseWheelEvent)
When event received will spin the carousel to select the next object. |
void |
remove(java.awt.Component component)
Removes the component from the carousel |
void |
setContentWidth(int contentWidth)
Sets the prefered width of the components inside the carousel, this is the neutral width that will change as the component is scaled, but at 9 and 6 o'clock where the scale is one they will be this width. |
void |
setDepthBasedAlpha(boolean useDepthBased)
If set to true the carousel will fade out components as they move away from the front of the carousel (6 o'clock) |
void |
setLayout(CaroselLayout layout)
Specifies which type of CarouselLayout to be used to lay the component out around the carousel Any looping layout can be used. |
void |
setSpinStartDelay(int spinStartDelay)
Sets the delay between clicking on a component in the carousel, and the spin starting to move that component to the front. |
Methods inherited from class contrib.com.blogofbug.swing.components.GradientPanel |
---|
componentHidden, componentMoved, componentResized, componentShown, paintComponent, setBackground, setBackground |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, 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, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, 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, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, 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, transferFocusUpCycle |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FRONT_COMPONENT_CHANGE
protected CaroselLayout layout
protected java.awt.Component lastWheeledTo
protected int DEFAULT_CONTENT_WIDTH
protected int spinStartDelay
Constructor Detail |
---|
public JCarosel()
public JCarosel(int contentWidth)
contentWidth
- The prefered width of component at neutral scale (3 or 9
o'clock)Method Detail |
---|
public void setContentWidth(int contentWidth)
contentWidth
- The prefered width.public void setDepthBasedAlpha(boolean useDepthBased)
useDepthBased
- True to fade components as they move to the back, false to not
do itpublic void setLayout(CaroselLayout layout)
layout
- The carousel layout to usepublic java.awt.Component add(java.awt.Component component)
add
in class java.awt.Container
component
- The component to add to the carousel
public java.awt.Component add(java.awt.Image image, java.lang.String text)
image
- The image to addtext
- The text label
public void remove(java.awt.Component component)
remove
in class java.awt.Container
component
- The component to removepublic java.awt.Component add(java.lang.String imageURL, int width, int height)
imageURL
- The URLwidth
- The desired rendering widthheight
- The desired rendering height
public java.awt.Component add(java.lang.String imageURL, java.lang.String text, int width, int height)
imageURL
- The image URLtext
- The text labelwidth
- The widthheight
- The height
public void bringToFront(java.awt.Component component)
component
- The component to bring to the frontpublic java.awt.Component getFrontmost()
public void mouseClicked(java.awt.event.MouseEvent mouseEvent)
mouseClicked
in interface java.awt.event.MouseListener
mouseEvent
- Brings the component clicked on by the mouse to the frontpublic void setSpinStartDelay(int spinStartDelay)
spinStartDelay
- public int getSpinStartDelay()
public void insertComponentAt(int i, java.awt.Component comp)
i
- The indexcomp
- The componentpublic java.awt.Component insertAt(int i, java.lang.String imageURL, int width, int height)
i
- The position on the carouselimageURL
- The URL of the imagewidth
- The width of the imageheight
- The height of the image
public java.awt.Component insertAt(int i, java.lang.String imageURL, java.lang.String text, int width, int height)
i
- The position on the carouselimageURL
- The URL of the imagetext
- The text labelwidth
- The prefered width of the imageheight
- The prefered height of the image
public void finalizeLayoutImmediately()
public void mousePressed(java.awt.event.MouseEvent mouseEvent)
mousePressed
in interface java.awt.event.MouseListener
mouseEvent
- Ignoredpublic void mouseReleased(java.awt.event.MouseEvent mouseEvent)
mouseReleased
in interface java.awt.event.MouseListener
mouseEvent
- Ignoredpublic void mouseEntered(java.awt.event.MouseEvent mouseEvent)
mouseEntered
in interface java.awt.event.MouseListener
mouseEvent
- Ignoredpublic void mouseExited(java.awt.event.MouseEvent mouseEvent)
mouseExited
in interface java.awt.event.MouseListener
mouseEvent
- Ignoredpublic void mouseWheelMoved(java.awt.event.MouseWheelEvent mouseWheelEvent)
mouseWheelMoved
in interface java.awt.event.MouseWheelListener
mouseWheelEvent
- The event objectpublic java.awt.Component add(java.lang.String imageURL)
imageURL
- The image
public java.awt.Component add(java.lang.String imageURL, java.lang.String textLabel)
imageURL
- The imagetextLabel
- The label
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |