xdev.ui

Class XdevComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

xdev.ui.XComponent

xdev.ui.XdevComponent

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ClientProperties

Direct Known Subclasses:

XdevContainer, XdevPicture, XdevTextPane, XdevWindow, XdevWindowContainer

public abstract class XdevComponent
extends XComponent
implements ClientProperties

This class serves as abstract base for many XDEV GUI components. It provides many common methods for drawing (including gradient and transparency), moving and sizing of XDEV GUI components.

Since:

2.0

Author:

XDEV Software

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected int	alpha Alpha value of this XdevComponent.
protected Color[]	alphaColors Alpha colors of this XdevComponent.
protected int	alphaCondition Alpha condition of this XdevComponent.
protected AlphaFilter	alphaFilter Alpha filter for this XdevComponent.
protected int	alphaTolerance Alpha tolerance of this XdevComponent.
protected Rectangle	clip TODO
protected Image	filteredImage TODO
protected Rectangle	imageBounds TODO
protected boolean	remakeImages TODO
protected XdevStyle	style Style of this XdevComponent.
protected boolean	useAlphaFilter TODO

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 xdev.ui.ClientProperties

DATA_FIELD, FORMULAR_CONDITION_FILTER, FORMULAR_CONDITION_PRECISION, FORMULAR_FILTER_OPERATOR, FORMULAR_SKIP, FORMULAR_VERIFIER, TAG_DATA

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
XdevComponent() Create a new XdevComponent with no layout manager.
XdevComponent(LayoutManager layout) Create a new XdevComponent with the specified layout manager.

Method Summary

Modifier and Type	Method and Description
protected void	checkAlphaUse() TODO
protected Graphics2D	createG2D(Graphics g) TODO
protected void	drawTexture(Graphics g, int x, int y, int w, int h) Draws the texture of this XdevComponent.
void	forcePaint() Forces this XdevComponent to repaint.
int	getAlpha() Returns the alpha value for this XdevComponent.
Color[]	getAlphaColors() Returns the alpha Colors for this XdevComponent.
int	getAlphaCondition() Returns the alpha condition for this XdevComponent.
int	getAlphaTolerance() Returns the alpha tolerance for this XdevComponent.
int	getBackgroundType() Returns the background type as int for this XdevComponent.
Insets	getBorderInsets() Returns the insets of the border.
int	getGradientAlign() Returns the gradient align for this XdevComponent.
Color	getGradientColor1() Returns the gradient Color one for this XdevComponent.
Color	getGradientColor2() Returns the gradient Color two for this XdevComponent.
Dimension	getSizeForFilter() Returns the size for the alpha filter.
XdevImage	getTexture() Returns the texture for this XdevComponent.
int	getTextureOption() Returns the texture option for this XdevComponent.
String	getTexturePath() Returns the texture path for this XdevComponent.
boolean	isOpaque()
protected void	paintBackground(Graphics g, int x, int y, int w, int h) Paints the background of this XdevComponent.
protected boolean	paintComponent()
protected void	paintComponent(Graphics g)
protected abstract void	paintImage(Graphics2D g) TODO
void	setAlpha(int alpha) Sets the alpha value for this XdevComponent.
void	setAlphaColors(Color... alphaColors) Sets the alpha Colors for this XdevComponent.
void	setAlphaCondition(int alphaCondition) Sets the alpha condition for this XdevComponent.
void	setAlphaTolerance(int alphaTolerance) Sets the alpha tolerance for this XdevComponent.
void	setBackgroundType(int backgroundType) Sets the background type as int for this XdevComponent.
void	setBorderTitle(String title) Sets the border title for this XdevComponent.
void	setGradientAlign(int gradientAlign) Sets the gradient align for this XdevComponent.
void	setGradientColor1(Color gradientColor1) Sets the gradient Color one for this XdevComponent.
void	setGradientColor2(Color gradientColor2) Sets the gradient Color two for this XdevComponent.
void	setTexture(XdevImage image) Sets the texture for this XdevComponent.
void	setTextureOption(int textureOption) Sets the texture option for this XdevComponent.
void	setTexturePath(String texturePath) Sets the texture path for this XdevComponent.
String	toString()
void	update(Graphics g)

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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

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, hasFocus, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

alpha

protected int alpha

Alpha value of this XdevComponent. Range 0 - 255.

alphaCondition

protected int alphaCondition

Alpha condition of this XdevComponent.

See Also:

AlphaFilter

alphaTolerance

protected int alphaTolerance

Alpha tolerance of this XdevComponent.

alphaColors

protected Color[] alphaColors

Alpha colors of this XdevComponent. A array of Colors that will be affected by alpha effects on this XdevComponent.

style

protected XdevStyle style

Style of this XdevComponent.

See Also:

XdevStyle

useAlphaFilter

protected boolean useAlphaFilter

TODO

remakeImages

protected boolean remakeImages

TODO

alphaFilter

protected AlphaFilter alphaFilter

Alpha filter for this XdevComponent.

See Also:

AlphaFilter

filteredImage

protected Image filteredImage

TODO

imageBounds

protected Rectangle imageBounds

TODO

clip

protected Rectangle clip

TODO

Constructor Detail

XdevComponent

public XdevComponent()

Create a new XdevComponent with no layout manager.

Alias for XdevComponent(null)

See Also:

XdevComponent(LayoutManager)

XdevComponent

public XdevComponent(LayoutManager layout)

Create a new XdevComponent with the specified layout manager.

Parameters:

layout - the LayoutManager to use

Method Detail

forcePaint

public void forcePaint()

Forces this XdevComponent to repaint.

See Also:

Component.repaint()

checkAlphaUse

protected void checkAlphaUse()

TODO

getSizeForFilter

public Dimension getSizeForFilter()

Returns the size for the alpha filter.

Returns:

the size for the alpha filter.

See Also:

Dimension

getBorderInsets

public Insets getBorderInsets()

Returns the insets of the border.

Returns:

the insets of the border.

See Also:

Insets

setBorderTitle

public void setBorderTitle(String title)

Sets the border title for this XdevComponent.

Hint: Works only if the component has a TitledBorder. You can set a TitledBorder for this component via XDEV IDE or manually with JComponent.setBorder(Border).

Parameters:

title - String to be displayed in title of the border.

See Also:

JComponent.setBorder(Border)

update

public void update(Graphics g)

Overrides:

update in class JComponent

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class JComponent

paintComponent

protected boolean paintComponent()

Since:

3.2

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

paintImage

protected abstract void paintImage(Graphics2D g)

TODO

Parameters:

g -

createG2D

protected Graphics2D createG2D(Graphics g)

TODO

Parameters:

g -

Returns:

paintBackground

protected void paintBackground(Graphics g,
                               int x,
                               int y,
                               int w,
                               int h)

Paints the background of this XdevComponent.

Parameters:

g - Graphics to paint on

x - the X coordinate for the upper-left corner of the background.

y - the Y coordinate for the upper-left corner of the background.

w - the width for the background.

h - the height for the background.

See Also:

JComponent.setBackground(Color), setBackgroundType(int)

drawTexture

protected void drawTexture(Graphics g,
                           int x,
                           int y,
                           int w,
                           int h)

Draws the texture of this XdevComponent.

Parameters:

g - Graphics to paint on

x - the X coordinate for the upper-left corner of the texture.

y - the Y coordinate for the upper-left corner of the texture.

w - the width for the texture.

h - the height for the texture.

See Also:

setTexture(XdevImage)

getAlpha

public int getAlpha()

Returns the alpha value for this XdevComponent.

Returns:

the alpha value for this XdevComponent.

setAlpha

public void setAlpha(int alpha)

Sets the alpha value for this XdevComponent.

Parameters:

alpha - the alpha value for this XdevComponent, 0 (translucent) to 255 (opaque).

getAlphaCondition

public int getAlphaCondition()

Returns the alpha condition for this XdevComponent.

Returns:

the alpha condition for this XdevComponent.

See Also:

AlphaFilter

setAlphaCondition

public void setAlphaCondition(int alphaCondition)

Sets the alpha condition for this XdevComponent.

Parameters:

alphaCondition - the alpha condition for this XdevComponent.

See Also:

AlphaFilter

getAlphaTolerance

public int getAlphaTolerance()

Returns the alpha tolerance for this XdevComponent.

Returns:

the alpha tolerance for this XdevComponent.

setAlphaTolerance

public void setAlphaTolerance(int alphaTolerance)

Sets the alpha tolerance for this XdevComponent.

Parameters:

alphaTolerance - the alpha tolerance for this XdevComponent, 0 - 255

getAlphaColors

public Color[] getAlphaColors()

Returns the alpha Colors for this XdevComponent.

Returns:

the alpha Colors for this XdevComponent.

See Also:

AlphaFilter

setAlphaColors

public void setAlphaColors(Color... alphaColors)

Sets the alpha Colors for this XdevComponent.

Parameters:

alphaColors - the alpha Colors for this XdevComponent.

See Also:

AlphaFilter

getBackgroundType

public int getBackgroundType()

Returns the background type as int for this XdevComponent.

Returns:

the background type as int for this XdevComponent.

See Also:

XdevStyle

setBackgroundType

public void setBackgroundType(int backgroundType)

Sets the background type as int for this XdevComponent.

Parameters:

backgroundType - the background type as int for this XdevComponent.

See Also:

XdevStyle.NONE, XdevStyle.COLOR, XdevStyle.GRADIENT, XdevStyle.SYSTEM

getGradientColor1

public Color getGradientColor1()

Returns the gradient Color one for this XdevComponent.

Returns:

the gradient Color one for this XdevComponent.

See Also:

XdevStyle.GRADIENT

setGradientColor1

public void setGradientColor1(Color gradientColor1)

Sets the gradient Color one for this XdevComponent.

Gradient colors are only applied if the background type of this XdevComponent is set to XdevStyle.GRADIENT. You can set the background type via XDEV IDE or manually with setBackgroundType(int).

Parameters:

gradientColor1 - the gradient Color one for this XdevComponent.

See Also:

XdevStyle.GRADIENT

getGradientColor2

public Color getGradientColor2()

Returns the gradient Color two for this XdevComponent.

Returns:

the gradient Color two for this XdevComponent.

See Also:

XdevStyle.GRADIENT

setGradientColor2

public void setGradientColor2(Color gradientColor2)

Sets the gradient Color two for this XdevComponent.

Gradient colors are only applied if the background type of this XdevComponent is set to XdevStyle.GRADIENT. You can set the background type via XDEV IDE or manually with setBackgroundType(int).

Parameters:

gradientColor2 - the gradient Color two for this XdevComponent.

See Also:

XdevStyle.GRADIENT

getGradientAlign

public int getGradientAlign()

Returns the gradient align for this XdevComponent.

Returns:

the gradient align for this XdevComponent.

See Also:

setBackgroundType(int), XdevStyle.LEFF_RIGHT, XdevStyle.TOP_BOTTOM, XdevStyle.TOPLEFT_BOTTOMRIGHT, XdevStyle.TOPRIGHT_BOTTOMLEFT, XdevStyle.RECTANGULAR, XdevStyle.RADIAL

setGradientAlign

public void setGradientAlign(int gradientAlign)

Sets the gradient align for this XdevComponent.

Gradient align is only applied if the background type of this XdevComponent is set to XdevStyle.GRADIENT. You can set the background type via XDEV IDE or manually with setBackgroundType(int).

Parameters:

gradientAlign - the gradient align for this XdevComponent.

See Also:

setBackgroundType(int), XdevStyle.LEFF_RIGHT, XdevStyle.TOP_BOTTOM, XdevStyle.TOPLEFT_BOTTOMRIGHT, XdevStyle.TOPRIGHT_BOTTOMLEFT, XdevStyle.RECTANGULAR, XdevStyle.RADIAL

getTexturePath

public String getTexturePath()

Returns the texture path for this XdevComponent.

Returns:

the texture path for this XdevComponent.

setTexturePath

public void setTexturePath(String texturePath)

Sets the texture path for this XdevComponent.

Parameters:

texturePath - the texture path for this XdevComponent.

getTexture

public XdevImage getTexture()

Returns the texture for this XdevComponent.

Returns:

the texture for this XdevComponent.

See Also:

XdevImage

setTexture

public void setTexture(XdevImage image)

Sets the texture for this XdevComponent.

Parameters:

image - the texture for this XdevComponent.

See Also:

XdevImage

getTextureOption

public int getTextureOption()

Returns the texture option for this XdevComponent.

Returns:

the texture option for this XdevComponent as int.

See Also:

XdevStyle.CENTER, XdevStyle.STRECHED, XdevStyle.TILED

setTextureOption

public void setTextureOption(int textureOption)

Sets the texture option for this XdevComponent.

Parameters:

textureOption - the texture option for this XdevComponent.

See Also:

XdevStyle.CENTER, XdevStyle.STRECHED, XdevStyle.TILED

toString

public String toString()

Overrides:

toString in class Component