Package org.eclipse.nebula.cwt.v
Class VControl
- java.lang.Object
-
- org.eclipse.nebula.cwt.v.VControl
-
public abstract class VControl extends java.lang.ObjectA VControl is a class wich wraps an SWT Button to create a widget that acts as much like a native Button as possible while adding the following features:- The appearance of Label when the mouse is not over it and it does not have the focus or selection (if style is SWT.TOGGLE).
- Can fit seemlessly into a larger visual piece - simple set the image to that of its background and adjust the image's offset if necessary.
- Can draw polygons and ovals.
- Can center or otherwise align its visual display (text, image, polygon or oval).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVControl.Type
-
Field Summary
Fields Modifier and Type Field Description private booleanactivatableprivate org.eclipse.swt.graphics.CursoractiveCursor(package private) org.eclipse.swt.graphics.Colorbackground(package private) org.eclipse.swt.graphics.Rectangleboundsstatic booleancarbontrue if the platform is Carbon, false otherwise(package private) org.eclipse.swt.widgets.Compositecomposite(package private) booleancustomToolTip(package private) java.util.Map<java.lang.String,java.lang.Object>dataMap(package private) booleandisposedprivate java.util.Set<java.lang.Integer>eventTypes(package private) org.eclipse.swt.graphics.Colorfill(package private) org.eclipse.swt.graphics.Fontfont(package private) org.eclipse.swt.graphics.Colorforegroundstatic booleangtktrue if the platform is GTK, false otherwise(package private) org.eclipse.swt.graphics.Imageimageprivate org.eclipse.swt.graphics.CursorinactiveCursor(package private) org.eclipse.swt.layout.GridDatalayoutDataprivate org.eclipse.swt.widgets.Listenerlistener(package private) java.util.Map<java.lang.Integer,java.util.List<org.eclipse.swt.widgets.Listener>>listeners(package private) intmarginBottom(package private) intmarginLeft(package private) intmarginRight(package private) intmarginTop(package private) org.eclipse.swt.widgets.Menumenu(package private) IControlPainterpainter(package private) VPanelparent(package private) int[]pointsprivate static int[]Points_Addprivate static int[]Points_Cancelprivate static int[]Points_Downprivate static int[]Points_Leftprivate static int[]Points_OKprivate static int[]Points_Rightprivate static int[]Points_Subtractprivate static int[]Points_Up(package private) booleanscaleImage(package private) booleansquareprivate intstatestatic intSTATE_ACTIVEstatic intSTATE_ENABLEDstatic intSTATE_MOUSE_DOWNstatic intSTATE_SELECTEDprivate intstyle(package private) SvgDocumentsvg(package private) java.lang.Stringtext(package private) java.lang.StringtooltipText(package private) intvisibilitystatic booleanwin32true if the platform is Win32, false otherwise(package private) intxAlign(package private) intyAlign
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description (package private) voidactivate()(package private) voidaddListener(int eventType)voidaddListener(int eventType, org.eclipse.swt.widgets.Listener listener)(package private) voidattachListeners(boolean keyListeners)org.eclipse.swt.graphics.PointcomputeSize(int wHint, int hHint)org.eclipse.swt.graphics.PointcomputeSize(int wHint, int hHint, boolean changed)protected static booleancontainsControl(org.eclipse.swt.widgets.Control control, org.eclipse.swt.widgets.Composite composite)org.eclipse.swt.widgets.MenucreateMenu()(package private) voiddeactivate()(package private) voiddetachListeners(boolean keyListeners)voiddispose()protected voidfilterEvent(org.eclipse.swt.widgets.Event event)org.eclipse.swt.graphics.ColorgetBackground()org.eclipse.swt.graphics.RectanglegetBounds()org.eclipse.swt.graphics.RectanglegetClientArea()org.eclipse.swt.graphics.PointgetClientSize()org.eclipse.swt.widgets.CompositegetComposite()org.eclipse.swt.widgets.ControlgetControl()java.lang.ObjectgetData(java.lang.Enum<?> name)<T> TgetData(java.lang.Enum<?> name, java.lang.Class<T> clazz)java.lang.ObjectgetData(java.lang.String name)<T> TgetData(java.lang.String name, java.lang.Class<T> clazz)org.eclipse.swt.widgets.DisplaygetDisplay()booleangetEnabled()org.eclipse.swt.graphics.FontgetFont()org.eclipse.swt.graphics.ColorgetForeground()org.eclipse.swt.graphics.ImagegetImage()org.eclipse.swt.layout.GridDatagetLayoutData()protected org.eclipse.swt.widgets.Listener[]getListeners(int eventType)org.eclipse.swt.graphics.PointgetLocation()org.eclipse.swt.graphics.RectanglegetMargins()org.eclipse.swt.widgets.MenugetMenu()VPanelgetParent()org.eclipse.swt.widgets.ShellgetShell()org.eclipse.swt.graphics.PointgetSize()intgetState()intgetStyle()java.lang.StringgetText()java.lang.StringgetToolTipText()abstract VControl.TypegetType()intgetVisibility()booleangetVisible()org.eclipse.swt.widgets.CompositegetWidget()(package private) voidhandleEvent(org.eclipse.swt.widgets.Event event)booleanhasState(int state)booleanhasStyle(int style)private booleaninclude(boolean key, int type)booleanisActivatable()booleanisDisposed()booleanisEnabled()booleanisSameWidgetAs(VControl control)booleanisSameWidgetAs(org.eclipse.swt.widgets.Widget widget)booleanisSquare()booleanisVisible()voidmoveAbove(VControl control)voidmoveBelow(VControl control)voidnotifyListeners(int eventType)voidnotifyListeners(int eventType, org.eclipse.swt.widgets.Event event)voidpaintControl(org.eclipse.swt.widgets.Event e)voidredraw()protected booleanredrawOnActivate()protected booleanredrawOnDeactivate()(package private) voidremoveListener(int eventType)voidremoveListener(int eventType, org.eclipse.swt.widgets.Listener listener)voidsetActivatable(boolean activatable)voidsetActiveCursor(org.eclipse.swt.graphics.Cursor cursor)voidsetAlignment(int x, int y)voidsetAlpha(org.eclipse.swt.graphics.GC gc)voidsetAlpha(org.eclipse.swt.graphics.GC gc, int alpha)voidsetBackground(org.eclipse.swt.graphics.Color color)voidsetBounds(int x, int y, int width, int height)voidsetBounds(org.eclipse.swt.graphics.Rectangle bounds)voidsetCursor(org.eclipse.swt.graphics.Cursor cursor)voidsetData(java.lang.Enum<?> name, java.lang.Object value)voidsetData(java.lang.String name, java.lang.Object value)voidsetEnabled(boolean enabled)voidsetFill(org.eclipse.swt.graphics.Color color)booleansetFocus()protected booleansetFocus(boolean focus)voidsetFont(org.eclipse.swt.graphics.Font font)voidsetForeground(org.eclipse.swt.graphics.Color color)voidsetImage(SvgDocument svg)voidsetImage(org.eclipse.swt.graphics.Image image)voidsetInactiveCursor(org.eclipse.swt.graphics.Cursor cursor)voidsetLayoutData(org.eclipse.swt.layout.GridData data)voidsetLocation(int x, int y)voidsetLocation(org.eclipse.swt.graphics.Point location)voidsetMargins(int marginWidth, int marginHeight)voidsetMargins(int left, int right, int top, int bottom)voidsetMargins(org.eclipse.swt.graphics.Rectangle margins)voidsetOval(int rx, int ry)voidsetOval(int rx, int ry, org.eclipse.swt.graphics.Color fillColor)voidsetPainter(IControlPainter painter)voidsetParent(VPanel panel)voidsetPolygon(int[] points)voidsetPolygon(int[] points, org.eclipse.swt.graphics.Color fillColor)voidsetScaleImage(boolean scale)voidsetSize(org.eclipse.swt.graphics.Point size)voidsetSquare(boolean equal)if parameter equal is true, the x and y sizes of this VControl will be forced equal, thus drawing a square buttonprotected booleansetState(int state, boolean set)voidsetStyle(int style)booleansetStyle(int style, boolean set)voidsetText(java.lang.String text)voidsetToolTipText(java.lang.String text)(package private) voidsetVisibility(int visibility)voidsetVisible(boolean visible)voidsetVisible(boolean visible, int duration)voidsetVisible(boolean visible, int duration, java.lang.Runnable callback)org.eclipse.swt.graphics.PointtoControl(int x, int y)org.eclipse.swt.graphics.PointtoControl(org.eclipse.swt.graphics.Point point)org.eclipse.swt.graphics.PointtoDisplay(int x, int y)org.eclipse.swt.graphics.PointtoDisplay(org.eclipse.swt.graphics.Point point)java.lang.StringtoString()voidupdate()
-
-
-
Field Detail
-
carbon
public static final boolean carbon
true if the platform is Carbon, false otherwise
-
gtk
public static final boolean gtk
true if the platform is GTK, false otherwise
-
win32
public static final boolean win32
true if the platform is Win32, false otherwise
-
Points_OK
private static final int[] Points_OK
-
Points_Cancel
private static final int[] Points_Cancel
-
Points_Left
private static final int[] Points_Left
-
Points_Right
private static final int[] Points_Right
-
Points_Up
private static final int[] Points_Up
-
Points_Down
private static final int[] Points_Down
-
Points_Add
private static final int[] Points_Add
-
Points_Subtract
private static final int[] Points_Subtract
-
STATE_ACTIVE
public static final int STATE_ACTIVE
- See Also:
- Constant Field Values
-
STATE_SELECTED
public static final int STATE_SELECTED
- See Also:
- Constant Field Values
-
STATE_ENABLED
public static final int STATE_ENABLED
- See Also:
- Constant Field Values
-
STATE_MOUSE_DOWN
public static final int STATE_MOUSE_DOWN
- See Also:
- Constant Field Values
-
composite
org.eclipse.swt.widgets.Composite composite
-
parent
VPanel parent
-
style
private int style
-
menu
org.eclipse.swt.widgets.Menu menu
-
image
org.eclipse.swt.graphics.Image image
-
svg
SvgDocument svg
-
text
java.lang.String text
-
tooltipText
java.lang.String tooltipText
-
points
int[] points
-
fill
org.eclipse.swt.graphics.Color fill
-
foreground
org.eclipse.swt.graphics.Color foreground
-
background
org.eclipse.swt.graphics.Color background
-
font
org.eclipse.swt.graphics.Font font
-
activeCursor
private org.eclipse.swt.graphics.Cursor activeCursor
-
inactiveCursor
private org.eclipse.swt.graphics.Cursor inactiveCursor
-
layoutData
org.eclipse.swt.layout.GridData layoutData
-
state
private int state
-
bounds
org.eclipse.swt.graphics.Rectangle bounds
-
marginTop
int marginTop
-
marginBottom
int marginBottom
-
marginLeft
int marginLeft
-
marginRight
int marginRight
-
xAlign
int xAlign
-
yAlign
int yAlign
-
disposed
boolean disposed
-
square
boolean square
-
visibility
int visibility
-
scaleImage
boolean scaleImage
-
customToolTip
boolean customToolTip
-
painter
IControlPainter painter
-
dataMap
java.util.Map<java.lang.String,java.lang.Object> dataMap
-
listeners
java.util.Map<java.lang.Integer,java.util.List<org.eclipse.swt.widgets.Listener>> listeners
-
eventTypes
private java.util.Set<java.lang.Integer> eventTypes
-
listener
private org.eclipse.swt.widgets.Listener listener
-
activatable
private boolean activatable
-
-
Constructor Detail
-
VControl
public VControl(VPanel panel, int style)
Javadoc out of date // TODO: update javadoc- Parameters:
panel-style-
-
-
Method Detail
-
containsControl
protected static final boolean containsControl(org.eclipse.swt.widgets.Control control, org.eclipse.swt.widgets.Composite composite)
-
handleEvent
void handleEvent(org.eclipse.swt.widgets.Event event)
-
activate
void activate()
-
addListener
void addListener(int eventType)
-
addListener
public void addListener(int eventType, org.eclipse.swt.widgets.Listener listener)
-
attachListeners
void attachListeners(boolean keyListeners)
-
detachListeners
void detachListeners(boolean keyListeners)
-
computeSize
public org.eclipse.swt.graphics.Point computeSize(int wHint, int hHint)
-
computeSize
public org.eclipse.swt.graphics.Point computeSize(int wHint, int hHint, boolean changed)
-
createMenu
public org.eclipse.swt.widgets.Menu createMenu()
-
deactivate
void deactivate()
-
dispose
public void dispose()
-
getBackground
public org.eclipse.swt.graphics.Color getBackground()
-
getBounds
public org.eclipse.swt.graphics.Rectangle getBounds()
-
getClientArea
public org.eclipse.swt.graphics.Rectangle getClientArea()
-
getClientSize
public org.eclipse.swt.graphics.Point getClientSize()
-
getComposite
public org.eclipse.swt.widgets.Composite getComposite()
-
getControl
public org.eclipse.swt.widgets.Control getControl()
-
getData
public java.lang.Object getData(java.lang.Enum<?> name)
-
getData
public <T> T getData(java.lang.Enum<?> name, java.lang.Class<T> clazz)
-
getData
public java.lang.Object getData(java.lang.String name)
-
getData
public <T> T getData(java.lang.String name, java.lang.Class<T> clazz)
-
getDisplay
public org.eclipse.swt.widgets.Display getDisplay()
-
getEnabled
public boolean getEnabled()
-
getFont
public org.eclipse.swt.graphics.Font getFont()
-
getForeground
public org.eclipse.swt.graphics.Color getForeground()
-
getImage
public org.eclipse.swt.graphics.Image getImage()
-
getLayoutData
public org.eclipse.swt.layout.GridData getLayoutData()
-
getListeners
protected org.eclipse.swt.widgets.Listener[] getListeners(int eventType)
-
getLocation
public org.eclipse.swt.graphics.Point getLocation()
-
getMargins
public org.eclipse.swt.graphics.Rectangle getMargins()
-
getMenu
public org.eclipse.swt.widgets.Menu getMenu()
-
getParent
public VPanel getParent()
-
getShell
public org.eclipse.swt.widgets.Shell getShell()
-
getSize
public org.eclipse.swt.graphics.Point getSize()
-
getState
public int getState()
-
getStyle
public int getStyle()
-
getText
public java.lang.String getText()
- Returns:
- the text string displayed on this VControl
-
getToolTipText
public java.lang.String getToolTipText()
-
getType
public abstract VControl.Type getType()
-
getVisibility
public int getVisibility()
-
getVisible
public boolean getVisible()
-
getWidget
public org.eclipse.swt.widgets.Composite getWidget()
-
filterEvent
protected void filterEvent(org.eclipse.swt.widgets.Event event)
-
hasState
public boolean hasState(int state)
-
hasStyle
public boolean hasStyle(int style)
-
include
private boolean include(boolean key, int type)
-
isActivatable
public boolean isActivatable()
-
isDisposed
public boolean isDisposed()
-
isEnabled
public boolean isEnabled()
-
isSameWidgetAs
public boolean isSameWidgetAs(VControl control)
-
isSameWidgetAs
public boolean isSameWidgetAs(org.eclipse.swt.widgets.Widget widget)
-
isSquare
public boolean isSquare()
- Returns:
- true if this VControl is to be sized as a square
-
isVisible
public boolean isVisible()
-
moveAbove
public void moveAbove(VControl control)
-
moveBelow
public void moveBelow(VControl control)
-
notifyListeners
public void notifyListeners(int eventType)
-
notifyListeners
public void notifyListeners(int eventType, org.eclipse.swt.widgets.Event event)
-
paintControl
public final void paintControl(org.eclipse.swt.widgets.Event e)
-
redraw
public void redraw()
-
redrawOnActivate
protected boolean redrawOnActivate()
-
redrawOnDeactivate
protected boolean redrawOnDeactivate()
-
removeListener
void removeListener(int eventType)
-
removeListener
public void removeListener(int eventType, org.eclipse.swt.widgets.Listener listener)
-
setActivatable
public void setActivatable(boolean activatable)
-
setActiveCursor
public void setActiveCursor(org.eclipse.swt.graphics.Cursor cursor)
-
setAlignment
public void setAlignment(int x, int y)- Parameters:
x-y-
-
setAlpha
public void setAlpha(org.eclipse.swt.graphics.GC gc)
-
setAlpha
public void setAlpha(org.eclipse.swt.graphics.GC gc, int alpha)
-
setBackground
public void setBackground(org.eclipse.swt.graphics.Color color)
-
setBounds
public void setBounds(int x, int y, int width, int height)
-
setBounds
public void setBounds(org.eclipse.swt.graphics.Rectangle bounds)
-
setCursor
public void setCursor(org.eclipse.swt.graphics.Cursor cursor)
-
setData
public void setData(java.lang.Enum<?> name, java.lang.Object value)
-
setData
public void setData(java.lang.String name, java.lang.Object value)
-
setEnabled
public void setEnabled(boolean enabled)
-
setFill
public void setFill(org.eclipse.swt.graphics.Color color)
-
setFocus
public boolean setFocus()
-
setFocus
protected boolean setFocus(boolean focus)
-
setFont
public void setFont(org.eclipse.swt.graphics.Font font)
-
setForeground
public void setForeground(org.eclipse.swt.graphics.Color color)
-
setImage
public void setImage(org.eclipse.swt.graphics.Image image)
-
setImage
public void setImage(SvgDocument svg)
-
setInactiveCursor
public void setInactiveCursor(org.eclipse.swt.graphics.Cursor cursor)
-
setLayoutData
public void setLayoutData(org.eclipse.swt.layout.GridData data)
-
setLocation
public void setLocation(org.eclipse.swt.graphics.Point location)
-
setLocation
public void setLocation(int x, int y)
-
setMargins
public void setMargins(int marginWidth, int marginHeight)- Parameters:
marginWidth-marginHeight-
-
setMargins
public void setMargins(int left, int right, int top, int bottom)- Parameters:
left-right-top-bottom-
-
setMargins
public void setMargins(org.eclipse.swt.graphics.Rectangle margins)
-
setOval
public void setOval(int rx, int ry)
-
setOval
public void setOval(int rx, int ry, org.eclipse.swt.graphics.Color fillColor)
-
setPainter
public void setPainter(IControlPainter painter)
-
setParent
public void setParent(VPanel panel)
-
setPolygon
public void setPolygon(int[] points)
-
setPolygon
public void setPolygon(int[] points, org.eclipse.swt.graphics.Color fillColor)
-
setScaleImage
public void setScaleImage(boolean scale)
-
setSize
public void setSize(org.eclipse.swt.graphics.Point size)
-
setSquare
public void setSquare(boolean equal)
if parameter equal is true, the x and y sizes of this VControl will be forced equal, thus drawing a square button- Parameters:
equal-
-
setState
protected boolean setState(int state, boolean set)
-
setStyle
public void setStyle(int style)
-
setStyle
public boolean setStyle(int style, boolean set)
-
setText
public void setText(java.lang.String text)
- Parameters:
text-
-
setToolTipText
public void setToolTipText(java.lang.String text)
-
setVisibility
void setVisibility(int visibility)
-
setVisible
public void setVisible(boolean visible)
-
setVisible
public void setVisible(boolean visible, int duration)
-
setVisible
public void setVisible(boolean visible, int duration, java.lang.Runnable callback)
-
toControl
public org.eclipse.swt.graphics.Point toControl(org.eclipse.swt.graphics.Point point)
-
toControl
public org.eclipse.swt.graphics.Point toControl(int x, int y)
-
toDisplay
public org.eclipse.swt.graphics.Point toDisplay(org.eclipse.swt.graphics.Point point)
-
toDisplay
public org.eclipse.swt.graphics.Point toDisplay(int x, int y)
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
update
public void update()
-
-