Package snap.viewx

Class ColorDock

java.lang.Object

snap.props.PropObject

snap.view.View

snap.viewx.ColorDock

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

public class ColorDock
extends View

A View that handle a whole grid of color swatches, including drag and drop support.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ColorDock.Swatch	A class to represent a color swatch.

Field Summary

Fields inherited from class snap.view.View

_align, _borderRadius, _effect, _font, _margin, _padding, _repaintRect, _showing, _spacing, _vertical, Action, Align_Prop, Border_Prop, BorderRadius_Prop, Clip_Prop, Cursor_Prop, DEFAULT_ALIGN, DEFAULT_MARGIN, DEFAULT_PADDING, DEFAULT_SPACING, Disabled_Prop, DragEvents, Effect_Prop, Fill_Prop, Focusable_Prop, Focused_Prop, FocusWhenPressed_Prop, Font_Prop, GrowHeight_Prop, GrowWidth_Prop, Height_Prop, KeyEvents, KeyPress, KeyRelease, KeyType, LeanX_Prop, LeanY_Prop, Margin_Prop, MaxHeight_Prop, MaxWidth_Prop, MinHeight_Prop, MinWidth_Prop, MouseDrag, MouseEnter, MouseEvents, MouseExit, MouseMove, MousePress, MouseRelease, Name_Prop, Opacity_Prop, Padding_Prop, Paintable_Prop, Parent_Prop, Pickable_Prop, PrefHeight_Prop, PrefWidth_Prop, Rotate_Prop, ScaleX_Prop, ScaleY_Prop, Scroll, Showing_Prop, Spacing_Prop, Text_Prop, ToolTip_Prop, TransX_Prop, TransY_Prop, Vertical_Prop, Visible_Prop, Width_Prop, X_Prop, Y_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
ColorDock()	Creates a new color dock.

Method Summary

Modifier and Type	Method	Description
protected void	colorDropped(ViewEvent anEvent)	Called when color is dropped on dock.
protected void	colorWellDidFireAction(ViewEvent anEvent)	Called when color well fires action event.
int	getColCount()	Returns the number of columns in this color dock.
Color	getColor()	Returns the color of the selected swatch.
Color	getColor(int anIndex)	Returns the color at the given swatch index.
Color	getColor(int aRow, int aCol)	Returns the color at given row & column.
Border	getDefaultBorder()	Override to return dock border.
int	getRowCount()	Returns the number of rows in this color dock.
int	getSelIndex()	Returns the selected swatch index.
ColorDock.Swatch	getSelSwatch()	Returns the selected swatch.
ColorDock.Swatch	getSwatch(int anIndex)	Returns the swatch at given index.
ColorDock.Swatch	getSwatch(int aRow, int aCol)	Returns the swatch at given row+col.
ColorDock.Swatch	getSwatchAt(double aX, double aY)	Returns the swatch at given point.
ColorDock.Swatch	getSwatchAt(Point aPoint)	Returns the swatch at given point.
int	getSwatchCount()	Returns the total number of visible swatches.
boolean	isPersistent()	Returns whether this doc writes itself out to preferences.
boolean	isSelectable()	Returns whether or not the dock can be selected.
boolean	isSelected()	Returns whether color dock is selected.
protected void	paintFront(Painter aPntr)	Paints this color dock component.
protected void	processEvent(ViewEvent anEvent)	Handle events.
protected void	readFromPrefs(String aName)	Read color well color from preferences.
void	resetColors()	Resets the colors in colordock to white.
protected void	saveToPrefs(String aName, int anIndex)	Update an individual color at {row,column} in the preferences
void	setColor(int aRow, int aCol, Color aColor)	Sets the color at the given row & column.
void	setColor(Color aColor)	Sets the color of the selected swatch.
void	setColor(Color aColor, int anIndex)	Sets the color at the given swatch index.
void	setColors(List<? extends Color> theColors)	Sets the colors.
void	setPersistent(boolean aFlag)	Sets whether this dock writes itself out to preferences.
void	setSelectable(boolean aValue)	Sets whether or not the dock can be selected.
void	setSelected(boolean aValue)	Sets whether color dock is selected.
void	setSelSwatch(ColorDock.Swatch aSwatch)	Sets the selected swatch.
protected void	setShowing(boolean aValue)	Override to set Selected to false when hidden.
protected void	startColorDrag(ViewEvent anEvent)	Called when color is dropped on dock.

Methods inherited from class snap.view.View

addBinding, addEventFilter, addEventHandler, clone, contains, contains, contains, disableEvents, dispatchEventToView, enableEvents, fireActionEvent, fromXML, getAlign, getAlignX, getAlignY, getAnim, getAnimCleared, getAnimTimeDeep, getBestHeight, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBorder, getBorderRadius, getBounds, getBoundsLocal, getBoundsParent, getBoundsShape, getBoundsShapeParent, getClip, getClipAll, getClipAllBounds, getClipBounds, getClippedRect, getCursor, getDefaultFill, getDefaultFont, getEffect, getEnv, getEventAdapter, getFill, getFillColor, getFocusNext, getFocusPrev, getFont, getHeight, getHost, getInsetsAll, getLean, getLeanX, getLeanY, getLocalToParent, getLocalToParent, getMargin, getMaxHeight, getMaxSize, getMaxWidth, getMaxX, getMaxY, getMidX, getMidY, getMinHeight, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, getName, getOpacity, getOpacityAll, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefHeightImpl, getPrefSize, getPrefWidth, getPrefWidth, getPrefWidthImpl, getProp, getPropDefault, getProps, getPropValue, getRealClassName, getRepaintRect, getRepaintRectExpanded, getRootView, getRotate, getScale, getScaleX, getScaleY, getSize, getSpacing, getText, getToolTip, getToolTip, getTransX, getTransY, getUpdater, getValuePropName, getVisRect, getWidth, getWindow, getX, getXY, getY, indexInHost, indexInParent, initProps, intersects, isActionable, isAncestor, isClipToBounds, isDisabled, isEnabled, isFocusable, isFocused, isFocusKeysEnabled, isFocusPainted, isFocusWhenPressed, isFontSet, isGrowHeight, isGrowWidth, isGuest, isHorizontal, isLocalToParentSimple, isManaged, isManagedVisible, isMaxHeightSet, isMaxWidthSet, isMinHeightSet, isMinWidthSet, isMouseDown, isMouseOver, isNeedsRepaint, isPaintable, isPickable, isPickableVisible, isPrefHeightSet, isPrefWidthSet, isShowing, isToolTipEnabled, isVertical, isVisible, localToParent, localToParent, localToParent, localToParent, localToScreen, paintAll, paintBack, parentFontChanged, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEventFilters, processEventHandlers, relayout, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, setBounds, setBounds, setBoundsLocal, setClip, setClipToBounds, setCursor, setDisabled, setEffect, setEnabled, setFill, setFocusable, setFocused, setFocusKeysEnabled, setFocusPainted, setFocusWhenPressed, setFont, setGrowHeight, setGrowWidth, setHeight, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setOwner, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setPropValue, setRealClassName, setRotate, setScale, setScaleX, setScaleY, setSize, setSize, setSizeLocal, setSizeToPrefSize, setSpacing, setText, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, themeChanged, toStringProps, toXML

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, isPropDefault, processPropChange, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ColorDock

public ColorDock()

Creates a new color dock.

Method Details

getColor

public Color getColor()

Returns the color of the selected swatch.

setColor

public void setColor(Color aColor)

Sets the color of the selected swatch.

getColor

public Color getColor(int anIndex)

Returns the color at the given swatch index.

setColor

public void setColor(Color aColor,
 int anIndex)

Sets the color at the given swatch index.

setColors

public void setColors(List<? extends Color> theColors)

Sets the colors.

getColor

public Color getColor(int aRow,
 int aCol)

Returns the color at given row & column.

setColor

public void setColor(int aRow,
 int aCol,
 Color aColor)

Sets the color at the given row & column.

isPersistent

public boolean isPersistent()

Returns whether this doc writes itself out to preferences.

setPersistent

public void setPersistent(boolean aFlag)

Sets whether this dock writes itself out to preferences.

getSwatch

public ColorDock.Swatch getSwatch(int anIndex)

Returns the swatch at given index.

getSwatch

public ColorDock.Swatch getSwatch(int aRow,
 int aCol)

Returns the swatch at given row+col.

getSwatchAt

public ColorDock.Swatch getSwatchAt(Point aPoint)

Returns the swatch at given point.

getSwatchAt

public ColorDock.Swatch getSwatchAt(double aX,
 double aY)

Returns the swatch at given point.

getRowCount

public int getRowCount()

Returns the number of rows in this color dock.

getColCount

public int getColCount()

Returns the number of columns in this color dock.

getSwatchCount

public int getSwatchCount()

Returns the total number of visible swatches.

getSelSwatch

public ColorDock.Swatch getSelSwatch()

Returns the selected swatch.

setSelSwatch

public void setSelSwatch(ColorDock.Swatch aSwatch)

Sets the selected swatch.

getSelIndex

public int getSelIndex()

Returns the selected swatch index.

resetColors

public void resetColors()

Resets the colors in colordock to white.

isSelected

public boolean isSelected()

Returns whether color dock is selected.

setSelected

public void setSelected(boolean aValue)

Sets whether color dock is selected.

isSelectable

public boolean isSelectable()

Returns whether or not the dock can be selected.

setSelectable

public void setSelectable(boolean aValue)

Sets whether or not the dock can be selected.

paintFront

protected void paintFront(Painter aPntr)

Paints this color dock component.

Overrides:

paintFront in class View

processEvent

protected void processEvent(ViewEvent anEvent)

Handle events.

Overrides:

processEvent in class View

colorDropped

protected void colorDropped(ViewEvent anEvent)

Called when color is dropped on dock.

startColorDrag

protected void startColorDrag(ViewEvent anEvent)

Called when color is dropped on dock.

colorWellDidFireAction

protected void colorWellDidFireAction(ViewEvent anEvent)

Called when color well fires action event.

saveToPrefs

protected void saveToPrefs(String aName,
 int anIndex)

Update an individual color at {row,column} in the preferences

readFromPrefs

protected void readFromPrefs(String aName)

Read color well color from preferences.

setShowing

protected void setShowing(boolean aValue)

Override to set Selected to false when hidden.

Overrides:

setShowing in class View

getDefaultBorder

public Border getDefaultBorder()

Override to return dock border.

Overrides:

getDefaultBorder in class View