com.sibvisions.rad.ui.swing.ext
Class JVxIcon

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.sibvisions.rad.ui.swing.ext.JVxIcon

All Implemented Interfaces:

JVxConstants, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

Direct Known Subclasses:

JVxIconRenderer

public class JVxIcon
extends javax.swing.JComponent
implements JVxConstants

The JVxIcon is a simple component with an image. The image can be aligned or stretched.

See Also:

Serialized Form

Nested Class Summary

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

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 com.sibvisions.rad.ui.swing.ext.JVxConstants

STRETCH

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

JVxIcon()
Creates a new instance of JVxIcon without an image.

JVxIcon(java.awt.Image pImage)
Creates a new instance of JVxIcon based on an Image.

Method Summary

int	getHorizontalAlignment() Gets the horizontal alignment of the icon.
java.awt.Dimension	getPreferredSize() Gets the preferred size of the icon dependent of the configured alignments.
int	getVerticalAlignment() Gets the vertical alignment of the icon.
boolean	isPreserveAspectRatio() If the aspect ratio of the image should be preserved if it is stretched in any direction.
void	paintComponent(java.awt.Graphics pGraphics)
void	setHorizontalAlignment(int pAlignment) Sets the horizontal alignment of the icon.
void	setImage(java.awt.Image pImage) Sets the image for the icon.
void	setPreserveAspectRatio(boolean pPreserveAspectRatio) Sets if the aspect ratio of the image should be preserved if it is stretched in any direction.
void	setVerticalAlignment(int pAlignment) Sets the vertical alignment of the icon.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, 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

Constructor Detail

JVxIcon

public JVxIcon()

Creates a new instance of JVxIcon without an image.

JVxIcon

public JVxIcon(java.awt.Image pImage)

Creates a new instance of JVxIcon based on an Image.

Parameters:

pImage - the image

Method Detail

paintComponent

public void paintComponent(java.awt.Graphics pGraphics)

Overrides:

paintComponent in class javax.swing.JComponent

getPreferredSize

public java.awt.Dimension getPreferredSize()

Gets the preferred size of the icon dependent of the configured alignments. If an alignment is JVxConstants.STRETCH then the size of the component will be used. Otherwise the size of the image will be used.

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

the preferred size of the image

setImage

public void setImage(java.awt.Image pImage)

Sets the image for the icon.

Parameters:

pImage - the image

setHorizontalAlignment

public void setHorizontalAlignment(int pAlignment)

Sets the horizontal alignment of the icon.

Parameters:

pAlignment - the alignment

See Also:

JVxConstants

getHorizontalAlignment

public int getHorizontalAlignment()

Gets the horizontal alignment of the icon.

Returns:

the alignment

See Also:

JVxConstants

setVerticalAlignment

public void setVerticalAlignment(int pAlignment)

Sets the vertical alignment of the icon.

Parameters:

pAlignment - the alignment

See Also:

JVxConstants

getVerticalAlignment

public int getVerticalAlignment()

Gets the vertical alignment of the icon.

Returns:

the alignment

See Also:

JVxConstants

isPreserveAspectRatio

public boolean isPreserveAspectRatio()

If the aspect ratio of the image should be preserved if it is stretched in any direction.

Returns:

true if the aspect ratio of the image is preserved when stretched.

setPreserveAspectRatio

public void setPreserveAspectRatio(boolean pPreserveAspectRatio)

Sets if the aspect ratio of the image should be preserved if it is stretched in any direction.

Parameters:

pPreserveAspectRatio - true if the aspect ratio of the image is preserved when stretched.