weka.gui.beans.TextViewer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weka-stable Show documentation
Show all versions of weka-stable Show documentation
The Waikato Environment for Knowledge Analysis (WEKA), a machine
learning workbench. This is the stable version. Apart from bugfixes, this version
does not receive any other updates.
/*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see m_headlessEvents;
/**
* Output area for a piece of text
*/
private transient JTextArea m_outText = null;// = new JTextArea(20, 80);
/**
* List of text revieved so far
*/
protected transient ResultHistoryPanel m_history;
/**
* True if this bean's appearance is the design mode appearance
*/
protected boolean m_design;
/**
* BeanContex that this bean might be contained within
*/
protected transient BeanContext m_beanContext = null;
/**
* BeanContextChild support
*/
protected BeanContextChildSupport m_bcSupport = new BeanContextChildSupport(
this);
/**
* Objects listening for text events
*/
private final Vector m_textListeners =
new Vector();
public TextViewer() {
java.awt.GraphicsEnvironment.getLocalGraphicsEnvironment();
if (!GraphicsEnvironment.isHeadless()) {
appearanceFinal();
} else {
m_headlessEvents = new ArrayList();
}
}
protected void appearanceDesign() {
setUpResultHistory();
removeAll();
if (m_visual == null) {
m_visual =
new BeanVisual("TextViewer", BeanVisual.ICON_PATH + "DefaultText.gif",
BeanVisual.ICON_PATH + "DefaultText_animated.gif");
}
setLayout(new BorderLayout());
add(m_visual, BorderLayout.CENTER);
}
protected void appearanceFinal() {
removeAll();
setLayout(new BorderLayout());
setUpFinal();
}
protected void setUpFinal() {
setUpResultHistory();
JPanel holder = new JPanel();
holder.setLayout(new BorderLayout());
JScrollPane js = new JScrollPane(m_outText);
js.setBorder(BorderFactory.createTitledBorder("Text"));
holder.add(js, BorderLayout.CENTER);
holder.add(m_history, BorderLayout.WEST);
add(holder, BorderLayout.CENTER);
}
/**
* Global info for this bean
*
* @return a String value
*/
public String globalInfo() {
return "General purpose text display.";
}
private void setUpResultHistory() {
java.awt.GraphicsEnvironment.getLocalGraphicsEnvironment();
if (!GraphicsEnvironment.isHeadless()) {
if (m_outText == null) {
m_outText = new JTextArea(20, 80);
m_history = new ResultHistoryPanel(m_outText);
}
m_outText.setEditable(false);
m_outText.setFont(new Font("Monospaced", Font.PLAIN, 12));
m_outText.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
m_history.setBorder(BorderFactory.createTitledBorder("Result list"));
m_history.setHandleRightClicks(false);
m_history.getList().addMouseListener(new MouseAdapter() {
@Override
public void mouseClicked(MouseEvent e) {
if (((e.getModifiers() & InputEvent.BUTTON1_MASK) != InputEvent.BUTTON1_MASK)
|| e.isAltDown()) {
int index = m_history.getList().locationToIndex(e.getPoint());
if (index != -1) {
String name = m_history.getNameAtIndex(index);
visualize(name, e.getX(), e.getY());
} else {
visualize(null, e.getX(), e.getY());
}
}
}
});
}
}
/**
* Handles constructing a popup menu with visualization options.
*
* @param name the name of the result history list entry clicked on by the
* user
* @param x the x coordinate for popping up the menu
* @param y the y coordinate for popping up the menu
*/
protected void visualize(String name, int x, int y) {
final JPanel panel = this;
final String selectedName = name;
JPopupMenu resultListMenu = new JPopupMenu();
JMenuItem visMainBuffer = new JMenuItem("View in main window");
if (selectedName != null) {
visMainBuffer.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
m_history.setSingle(selectedName);
}
});
} else {
visMainBuffer.setEnabled(false);
}
resultListMenu.add(visMainBuffer);
JMenuItem visSepBuffer = new JMenuItem("View in separate window");
if (selectedName != null) {
visSepBuffer.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
m_history.openFrame(selectedName);
}
});
} else {
visSepBuffer.setEnabled(false);
}
resultListMenu.add(visSepBuffer);
JMenuItem saveOutput = new JMenuItem("Save result buffer");
if (selectedName != null) {
saveOutput.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
SaveBuffer m_SaveOut = new SaveBuffer(null, panel);
StringBuffer sb = m_history.getNamedBuffer(selectedName);
if (sb != null) {
m_SaveOut.save(sb);
}
}
});
} else {
saveOutput.setEnabled(false);
}
resultListMenu.add(saveOutput);
JMenuItem deleteOutput = new JMenuItem("Delete result buffer");
if (selectedName != null) {
deleteOutput.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
m_history.removeResult(selectedName);
}
});
} else {
deleteOutput.setEnabled(false);
}
resultListMenu.add(deleteOutput);
resultListMenu.show(m_history.getList(), x, y);
}
/**
* Accept a data set for displaying as text
*
* @param e a DataSetEvent value
*/
@Override
public synchronized void acceptDataSet(DataSetEvent e) {
TextEvent nt =
new TextEvent(e.getSource(), e.getDataSet().toString(), e.getDataSet()
.relationName());
acceptText(nt);
}
/**
* Accept a training set for displaying as text
*
* @param e a TrainingSetEvent value
*/
@Override
public synchronized void acceptTrainingSet(TrainingSetEvent e) {
TextEvent nt =
new TextEvent(e.getSource(), e.getTrainingSet().toString(), e
.getTrainingSet().relationName());
acceptText(nt);
}
/**
* Accept a test set for displaying as text
*
* @param e a TestSetEvent value
*/
@Override
public synchronized void acceptTestSet(TestSetEvent e) {
TextEvent nt =
new TextEvent(e.getSource(), e.getTestSet().toString(), e.getTestSet()
.relationName());
acceptText(nt);
}
/**
* Accept some text
*
* @param e a TextEvent value
*/
@Override
public synchronized void acceptText(TextEvent e) {
if (m_outText == null) {
setUpResultHistory();
}
StringBuffer result = new StringBuffer();
result.append(e.getText());
// m_resultsString.append(e.getText());
// m_outText.setText(m_resultsString.toString());
String name = (new SimpleDateFormat("HH:mm:ss - ")).format(new Date());
name += e.getTextTitle();
if (m_outText != null) {
// see if there is an entry with this name already in the list -
// could happen if two items with the same name arrive at the same second
int mod = 2;
String nameOrig = new String(name);
while (m_history.getNamedBuffer(name) != null) {
name = new String(nameOrig + "" + mod);
mod++;
}
m_history.addResult(name, result);
m_history.setSingle(name);
}
if (m_headlessEvents != null) {
m_headlessEvents.add(e);
}
// pass on the event to any listeners
notifyTextListeners(e);
}
/**
* Get the list of events processed in headless mode. May return null or an
* empty list if not running in headless mode or no events were processed
*
* @return a list of EventObjects or null.
*/
@Override
public List retrieveHeadlessEvents() {
return m_headlessEvents;
}
/**
* Process a list of events that have been collected earlier. Has no affect if
* the component is running in headless mode.
*
* @param headless a list of EventObjects to process.
*/
@Override
public void processHeadlessEvents(List headless) {
// only process if we're not headless
if (!java.awt.GraphicsEnvironment.isHeadless()) {
for (EventObject e : headless) {
if (e instanceof TextEvent) {
acceptText((TextEvent) e);
}
}
}
}
/**
* Describe setVisual method here.
*
* @param newVisual a BeanVisual value
*/
@Override
public void setVisual(BeanVisual newVisual) {
m_visual = newVisual;
}
/**
* Get the visual appearance of this bean
*/
@Override
public BeanVisual getVisual() {
return m_visual;
}
/**
* Use the default visual appearance for this bean
*/
@Override
public void useDefaultVisual() {
m_visual.loadIcons(BeanVisual.ICON_PATH + "DefaultText.gif",
BeanVisual.ICON_PATH + "DefaultText_animated.gif");
}
/**
* Popup a component to display the selected text
*/
public void showResults() {
if (m_resultsFrame == null) {
if (m_outText == null) {
setUpResultHistory();
}
m_resultsFrame = new JFrame("Text Viewer");
m_resultsFrame.getContentPane().setLayout(new BorderLayout());
final JScrollPane js = new JScrollPane(m_outText);
js.setBorder(BorderFactory.createTitledBorder("Text"));
JSplitPane p2 =
new JSplitPane(JSplitPane.HORIZONTAL_SPLIT, m_history, js);
m_resultsFrame.getContentPane().add(p2, BorderLayout.CENTER);
// m_resultsFrame.getContentPane().add(js, BorderLayout.CENTER);
// m_resultsFrame.getContentPane().add(m_history, BorderLayout.WEST);
m_resultsFrame.addWindowListener(new java.awt.event.WindowAdapter() {
@Override
public void windowClosing(java.awt.event.WindowEvent e) {
m_resultsFrame.dispose();
m_resultsFrame = null;
}
});
m_resultsFrame.pack();
m_resultsFrame.setVisible(true);
} else {
m_resultsFrame.toFront();
}
}
/**
* Get a list of user requests
*
* @return an Enumeration value
*/
@Override
public Enumeration enumerateRequests() {
Vector newVector = new Vector(0);
newVector.addElement("Show results");
newVector.addElement("?Clear results");
return newVector.elements();
}
/**
* Perform the named request
*
* @param request a String value
* @exception IllegalArgumentException if an error occurs
*/
@Override
public void performRequest(String request) {
if (request.compareTo("Show results") == 0) {
showResults();
} else if (request.compareTo("Clear results") == 0) {
m_outText.setText("");
m_history.clearResults();
} else {
throw new IllegalArgumentException(request
+ " not supported (TextViewer)");
}
}
/**
* Add a property change listener to this bean
*
* @param name the name of the property of interest
* @param pcl a PropertyChangeListener value
*/
@Override
public void addPropertyChangeListener(String name, PropertyChangeListener pcl) {
m_bcSupport.addPropertyChangeListener(name, pcl);
}
/**
* Remove a property change listener from this bean
*
* @param name the name of the property of interest
* @param pcl a PropertyChangeListener value
*/
@Override
public void removePropertyChangeListener(String name,
PropertyChangeListener pcl) {
m_bcSupport.removePropertyChangeListener(name, pcl);
}
/**
* Add a vetoable change listener to this bean
*
* @param name the name of the property of interest
* @param vcl a VetoableChangeListener value
*/
@Override
public void addVetoableChangeListener(String name, VetoableChangeListener vcl) {
m_bcSupport.addVetoableChangeListener(name, vcl);
}
/**
* Remove a vetoable change listener from this bean
*
* @param name the name of the property of interest
* @param vcl a VetoableChangeListener value
*/
@Override
public void removeVetoableChangeListener(String name,
VetoableChangeListener vcl) {
m_bcSupport.removeVetoableChangeListener(name, vcl);
}
/**
* Set a bean context for this bean
*
* @param bc a BeanContext value
*/
@Override
public void setBeanContext(BeanContext bc) {
m_beanContext = bc;
m_design = m_beanContext.isDesignTime();
if (m_design) {
appearanceDesign();
} else {
java.awt.GraphicsEnvironment.getLocalGraphicsEnvironment();
if (!GraphicsEnvironment.isHeadless()) {
appearanceFinal();
}
}
}
/**
* Notify all text listeners of a text event
*
* @param ge a TextEvent value
*/
@SuppressWarnings("unchecked")
private void notifyTextListeners(TextEvent ge) {
Vector l;
synchronized (this) {
l = (Vector) m_textListeners.clone();
}
if (l.size() > 0) {
for (int i = 0; i < l.size(); i++) {
l.elementAt(i).acceptText(ge);
}
}
}
/**
* Return the bean context (if any) that this bean is embedded in
*
* @return a BeanContext value
*/
@Override
public BeanContext getBeanContext() {
return m_beanContext;
}
/**
* Stop any processing that the bean might be doing.
*/
@Override
public void stop() {
}
/**
* Returns true if. at this time, the bean is busy with some (i.e. perhaps a
* worker thread is performing some calculation).
*
* @return true if the bean is busy.
*/
@Override
public boolean isBusy() {
return false;
}
/**
* Set a logger
*
* @param logger a Logger value
*/
@Override
public void setLog(Logger logger) {
}
/**
* Set a custom (descriptive) name for this bean
*
* @param name the name to use
*/
@Override
public void setCustomName(String name) {
m_visual.setText(name);
}
/**
* Get the custom (descriptive) name for this bean (if one has been set)
*
* @return the custom name (or the default name)
*/
@Override
public String getCustomName() {
return m_visual.getText();
}
/**
* Returns true if, at this time, the object will accept a connection via the
* supplied EventSetDescriptor
*
* @param esd the EventSetDescriptor
* @return true if the object will accept a connection
*/
@Override
public boolean connectionAllowed(EventSetDescriptor esd) {
return connectionAllowed(esd.getName());
}
/**
* Returns true if, at this time, the object will accept a connection via the
* named event
*
* @param eventName the name of the event
* @return true if the object will accept a connection
*/
@Override
public boolean connectionAllowed(String eventName) {
return true;
}
/**
* Notify this object that it has been registered as a listener with a source
* for recieving events described by the named event This object is
* responsible for recording this fact.
*
* @param eventName the event
* @param source the source with which this object has been registered as a
* listener
*/
@Override
public void connectionNotification(String eventName, Object source) {
}
/**
* Notify this object that it has been deregistered as a listener with a
* source for named event. This object is responsible for recording this fact.
*
* @param eventName the event
* @param source the source with which this object has been registered as a
* listener
*/
@Override
public void disconnectionNotification(String eventName, Object source) {
}
/**
* Returns true, if at the current time, the named event could be generated.
* Assumes that the supplied event name is an event that could be generated by
* this bean
*
* @param eventName the name of the event in question
* @return true if the named event could be generated at this point in time
*/
@Override
public boolean eventGeneratable(String eventName) {
if (eventName.equals("text")) {
return true;
}
return false;
}
/**
* Add a text listener
*
* @param cl a TextListener value
*/
public synchronized void addTextListener(TextListener cl) {
m_textListeners.addElement(cl);
}
/**
* Remove a text listener
*
* @param cl a TextListener value
*/
public synchronized void removeTextListener(TextListener cl) {
m_textListeners.remove(cl);
}
public static void main(String[] args) {
try {
final javax.swing.JFrame jf = new javax.swing.JFrame();
jf.getContentPane().setLayout(new java.awt.BorderLayout());
final TextViewer tv = new TextViewer();
tv.acceptText(new TextEvent(tv, "Here is some test text from the main "
+ "method of this class.", "The Title"));
jf.getContentPane().add(tv, java.awt.BorderLayout.CENTER);
jf.addWindowListener(new java.awt.event.WindowAdapter() {
@Override
public void windowClosing(java.awt.event.WindowEvent e) {
jf.dispose();
System.exit(0);
}
});
jf.setSize(800, 600);
jf.setVisible(true);
} catch (Exception ex) {
ex.printStackTrace();
}
}
}