ClipboardCopier.java

/*
Copyright 2011-2016 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.google.security.zynamics.zylib.gui.zygraph.helpers;

import com.google.common.base.Preconditions;
import com.google.security.zynamics.zylib.general.ClipboardHelpers;
import com.google.security.zynamics.zylib.gui.zygraph.realizers.ZyLabelContent;
import com.google.security.zynamics.zylib.gui.zygraph.realizers.ZyLineContent;
import com.google.security.zynamics.zylib.yfileswrap.gui.zygraph.nodes.ZyGraphNode;
import com.google.security.zynamics.zylib.yfileswrap.gui.zygraph.realizers.IZyNodeRealizer;

/**
 * Provides methods that can be used to copy parts of a graph to the clip board.
 */
public final class ClipboardCopier {
  /**
   * Copies the text content of a node to the clip board.
   * 
   * @param node The node to copy to the clip board.
   */
  public static void copyToClipboard(final ZyGraphNode<?> node) {
    Preconditions.checkNotNull(node, "Error: Node argument can not be null");
    final IZyNodeRealizer realizer = node.getRealizer();
    final ZyLabelContent content = realizer.getNodeContent();

    if (content.isSelectable()) {
      final ZyLabelContent zyContent = content;

      final StringBuilder textBuilder = new StringBuilder();

      for (final ZyLineContent zyLineContent : zyContent) {
        textBuilder.append(zyLineContent.getText());
        textBuilder.append("\n"); //$NON-NLS-1$
      }

      ClipboardHelpers.copyToClipboard(textBuilder.toString());
    }
  }

  /**
   * Copies the text of a line of a node to the clip board.
   * 
   * @param node The node that contains the line.
   * @param line Index of the line to copy to the clip board.
   */
  public static void copyToClipboard(final ZyGraphNode<?> node, final int line) {
    Preconditions.checkNotNull(node, "Error: Node argument can not be null");
    final IZyNodeRealizer realizer = node.getRealizer();
    final ZyLabelContent content = realizer.getNodeContent();
    Preconditions.checkArgument((line >= 0) && (line < content.getLineCount()),
        "Error: Line argument is out of bounds");

    if (content.isSelectable()) {
      final ZyLabelContent zyContent = content;

      ClipboardHelpers.copyToClipboard(zyContent.getLineContent(line).getText());
    }
  }
}