javanotes

Class MakeColorPage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.physpics.tools.ui.blox.Blox

javanotes.MakeColorPage

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class MakeColorPage
extends com.physpics.tools.ui.blox.Blox

From a list of colors and a template create colorrows.php. Inputs: $PICTOOLS/colorlist.csv - one color per line as noted in method parseCSV. This file is manually created from pictools/colorTable.xlsx ./colorPageTemplate.php - the output php file with placeholders as noted in method genPage. Output: colorrows.php - a web page displaying all the colors Clicking a color in the web page displays a popup showing the name and value with options to click; a click puts the text in the cut buffer. The command line is optional. If a first argument is given, it is the location of the colorlist.csv default is PICTOOLS/colorlist.csv If a second argument is given it is the location of the template; if not given the template is ./colorPageTemplate.php If a third argument is given it is the output file name. otherwise output is ./colorrows.php

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MakeColorPage.Bucket A class that bundles together the parameters for output.

Nested classes/interfaces inherited from class com.physpics.tools.ui.blox.Blox

com.physpics.tools.ui.blox.Blox.AccessibleBlox, com.physpics.tools.ui.blox.Blox.BaseAlignNote, com.physpics.tools.ui.blox.Blox.BkgdColorNote, com.physpics.tools.ui.blox.Blox.CrossSizeFull, com.physpics.tools.ui.blox.Blox.DebugNote, com.physpics.tools.ui.blox.Blox.Filler, com.physpics.tools.ui.blox.Blox.GlueNote, com.physpics.tools.ui.blox.Blox.NameNote, com.physpics.tools.ui.blox.Blox.Note, com.physpics.tools.ui.blox.Blox.Scroller, com.physpics.tools.ui.blox.Blox.StrutNote

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

Fields inherited from class com.physpics.tools.ui.blox.Blox

DEFAULT_HEIGHT, DEFAULT_WIDTH, DIM_ZERO, PIXELS_PER_POINT

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
MakeColorPage() Construct a MakeColorPages screen image.

Method Summary

Modifier and Type	Method and Description
void	addColor(java.lang.String rgb, java.lang.String varDigit, java.lang.String name, java.lang.String ref) Add a color to the table.The table will be recreated without this color whenever parseColorStream succeeds.
void	genPage(MakeColorPage.Bucket buck, java.io.File dest, java.io.InputStream tplstr) Create output file by copying the template and inserting color data.
java.io.InputStream	getTplStream() Interpret templateLocator to produce an InputStream reading the template.
static javax.swing.JFrame[]	go(java.lang.String[] args) Create a MakeColorPage window, process arguments, and open the window.
static void	main(java.lang.String[] args) Main program started from command line.
static javax.swing.JFrame[]	openWindows() Initiate the MakeColorPage window.
java.util.ArrayList<PCASortColors.PCAColor>	parseColorStream(java.io.InputStream istr) Parse CSV entries from a given input stream.
PCASortColors.PCAColor[]	prepareColorList(java.lang.String button) Read the colors list and make/sort a copy for the given button.
void	processArgs(java.lang.String[] args) Process command-line-like arguments.
boolean	readColorList() Read the colorlist designated in colorListLocator.
java.util.ArrayList<PCASortColors.PCAColor>	setColorTable(java.util.ArrayList<PCASortColors.PCAColor> tbl) Set the table of colors to be ouput.
PCASortColors.PCAColor[]	sortByButton(java.lang.String button) Apply a sorting method from PCASortColors.

Methods inherited from class com.physpics.tools.ui.blox.Blox

addImpl, addMany, baseAlign, color, componentOrientationFactory, createGlue, createHorizontalBlox, createHorizontalBlox, createHorizontalGlue, createHorizontalStrut, createRigidArea, createVerticalBlox, createVerticalBlox, createVerticalGlue, createVerticalStrut, crossSizeFull, debug, getAccessibleContext, getBaseline, getFrame, glue, name, openWindow, openWindow, openWindow, paintComponent, pixelsToPoints, pointsToPixels, setLayout, setOpaque, setTransparent, strut, wrapFrame

Methods inherited from class javax.swing.JPanel

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

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

MakeColorPage

public MakeColorPage()

Construct a MakeColorPages screen image. Also test the writability of "."

Method Detail

readColorList

public boolean readColorList()

Read the colorlist designated in colorListLocator. Its value can be any of the forms of locator listed in IOUtils.getInputStream(java.lang.Class, java.lang.String), including especially a local file or a web page URL.

The algorithm first checks if the name has not changed and, if so, does not reread the color list. Otherwise it tries to read from the named location. If that fails, the existing table--if any-- is retained. As a last resort, the the colors are read from //physpics.com/pictools/colorlist.csv

Returns:

true if successfully read a colorlist. If the list is not that named in colorListLocator, a message will have been displayed in the Messages window.

addColor

public void addColor(java.lang.String rgb,
                     java.lang.String varDigit,
                     java.lang.String name,
                     java.lang.String ref)

Add a color to the table.The table will be recreated without this color whenever parseColorStream succeeds.

Parameters:

rgb - String in form #rrggbb, where r,g,and b are hexdigits

varDigit - A digit cjharacter to distinguish thi color from others of thje same name

name - The human-readable name

ref - The URL of a page defining the color.

setColorTable

public java.util.ArrayList<PCASortColors.PCAColor> setColorTable(java.util.ArrayList<PCASortColors.PCAColor> tbl)

Set the table of colors to be ouput.

Parameters:

tbl - New list of colors

Returns:

the old table

parseColorStream

public java.util.ArrayList<PCASortColors.PCAColor> parseColorStream(java.io.InputStream istr)

Parse CSV entries from a given input stream. If you have your own list of colors, they need to be defined in a CSV (comma-separated-values) file like physpics.com/pictools/colorlist.csv. The first line is a list of the fields:

                 RGB,NAME,VARIANT,SOURCE,LINK

Subsequent lines each have five fields separated by commas:

• rgb - hash mark followed by six hexadecimal digits
• name - non-ASCII characters must be written as entities, like "é"
• variant - a single digit to distinguish from other colors of the same name (optional)
• source - a name in parentheses, like "(CSS)" hinting at the origin of the name(optional)
• link - link to a website defining the color (optional). Non-ASCII characters must be %-encoded.

Comment lines begin with "!" and may appear anywhere beyond the initial field name line.

Parameters:

istr - the input stream to be read.

Returns:

an array of colors

getTplStream

public java.io.InputStream getTplStream()

Interpret templateLocator to produce an InputStream reading the template. If the templateLocator value cannot be read, The default Template is read from http://physpics.com/Java/tutorials/javanotes/colorPageTemplate.php

Returns:

An InputStream that will read from a template.

prepareColorList

public PCASortColors.PCAColor[] prepareColorList(java.lang.String button)

Read the colors list and make/sort a copy for the given button. The colorlist is not reread, if possible.

 Possible sources of colorlist:
          use current if colorListLocator equals existinglistlocation
          as located with colorListLocator
          most recent successfull colorlist
          fallback list from the website
 

Parameters:

button - which button to sort for. One of: byHue, byLightness, byGrayScale, byPCA, byHueAndPCA, byHueAndLightness, byHueAndGrayScale, byHueAndSaturation, byHueAndSplitLightness, blocks

Returns:

An array of colors; or null for failure

sortByButton

public PCASortColors.PCAColor[] sortByButton(java.lang.String button)

Apply a sorting method from PCASortColors.

Parameters:

button - one of the names accepted by the switch statement below: byHue, byLightness, byGrayScale, byPCA, byHueAndPCA, byHueAndLightness, byHueAndGrayScale, byHueAndSaturation, byHueAndSplitLightness, blocks

Returns:

a copy of colorTable sorted according to the button parameter

genPage

public void genPage(MakeColorPage.Bucket buck,
                    java.io.File dest,
                    java.io.InputStream tplstr)

Create output file by copying the template and inserting color data.

 Lines displaying colors chromatically are inserted in template between
             
            
 Lines in alphabetic order are inserted in templateLocator between
             
            
 

Parameters:

buck - a standard set of parameters passed to methods that write output pages

dest - where to write the output.

tplstr - from whence to read the template

processArgs

public void processArgs(java.lang.String[] args)

Process command-line-like arguments. The arguments can establish values for the window's text fields colorList, template, outputFile.

Parameters:

args - If present, arg[0] is a locator for a CSV list of colors as described in parseCSV. Default is website/pictools/colorlist.csv If present, arg[1] is a locator for the name of the template as described in genpage. Default: ./colorPageTemplate.php. fallback is website/Java/tutorials/javanotes/colorpageTemplate.php If present, arg[2] is the outputstem. Default is "colorrows". filename is ./stem-buttonname.php

openWindows

public static javax.swing.JFrame[] openWindows()

Initiate the MakeColorPage window. Called from Run Demo.

Returns:

A list of the windows opened.

go

public static javax.swing.JFrame[] go(java.lang.String[] args)

Create a MakeColorPage window, process arguments, and open the window. Called from the main method or from openWindows.

Parameters:

args - as described for method processArgs.

Returns:

an array of the opened windows.

main

public static void main(java.lang.String[] args)

Main program started from command line.

Parameters:

args - the command line arguments. processed in the go method