Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 280 lines (241 sloc) 18.366 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
<html>
  <head>
    <title>miglayout - clojure-contrib v1.2 API documentation</title>
    <link href="static/favicon.png" rel="icon" />
    <link href="static/favicon.png" rel="shortcut icon" />
    <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
    <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
    <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
    <style>.menuWrapper{height: 36px;}</style>
    <!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
  </head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
  <body>
    <div id="AllContentContainer">
      <div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1>
      </div>
      <div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
  <div class="WikiCustomNav WikiElement wiki">
    <span class="toc-header"><span id="project-name">clojure-contrib</span> <span id="version">v1.2</span> API</span><br />
    <ul>
      <li><a class="wiki_link" href="index.html">Overview</a></li>
      <li><a class="wiki_link" href="api-index.html">API Index</a></li>
    </ul>
    <span class="toc-header">Namespaces</span>
    <ul id="left-sidebar-list">
      <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="io-api.html" class="wiki_link">io</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-api.html" class="wiki_link">seq</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-api.html" class="wiki_link">shell</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
    </ul>
    <div class="BranchTOC">
      <span class="toc-header">Other Versions</span>
      <ul id="left-sidebar-branch-list">
        <li><a href="branch-master/index.html" class="wiki_link">v1.3 (in development)</a></li><li><a href="branch-1.1.x/index.html" class="wiki_link">v1.1 (stable)</a></li>
      </ul>
    </div>
    <a href="http://clojure.org" class="wiki_link">Clojure Home</a>
  </div>
</div>
</div>
      <div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
              <div id="content_view" class="wiki wikiPage">
                <div id="right-sidebar"><div id="toc">
  <h1 class="nopad">Table of Contents</h1>
  <div style="margin-left: 1em;" class="toc-section">
    <a href="#toc0">Overview</a>
    <div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout/components">components</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout/miglayout">miglayout</a>
    </div>
    <br />
  </div><div style="margin-left: 1em;" class="toc-section">
    <a href="#miglayout.internal">miglayout.internal</a>
    <div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/add-components">add-components</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/component?">component?</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/constraint?">constraint?</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/do-layout">do-layout</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/format-constraint">format-constraint</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/format-constraints">format-constraints</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/get-components">get-components</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/parse-component-constraint">parse-component-constraint</a>
    </div><div style="margin-left: 1em;" class="toc-entry">
      <a href="#clojure.contrib.miglayout.internal/parse-item-constraints">parse-item-constraints</a>
    </div>
    <br />
  </div>
</div>
</div>
                <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">miglayout</span>
  - <span id="header-project">clojure-contrib</span> <span id="header-version">v1.2</span> (<span id="header-status">stable</span>)
  </h1>
<span id="author-line">by <span id="author-name">Stephen C. Gilardi</span><br /></span>
<br />Full namespace name: <span id="long-name">clojure.contrib.miglayout</span>
<p></p>
<h2>Overview</h2>
<pre id="namespace-docstr">Clojure support for the MiGLayout layout manager
<a href="http://www.miglayout.com/">http://www.miglayout.com/</a>

Example:

  (use '[clojure.contrib.miglayout.test :as mlt :only ()])
  (dotimes [i 5] (mlt/run-test i))</pre>


<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.miglayout/components">components</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (components container)
</pre>
  <pre id="var-docstr">Returns a map from id (a keyword) to component for all components with
an id constraint set</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout.clj#L75" id="var-source">Source</a>
</div><div id="var-entry">
  <br />
  <hr />
  <h2 id="clojure.contrib.miglayout/miglayout">miglayout</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (miglayout container &amp; args)
</pre>
  <pre id="var-docstr">Adds java.awt.Components to a javax.swing.JComponent with constraints
formatted for the MiGLayout layout manager.

Arguments: container [item constraint*]*

  - container: the container for the specified components, its layout
    manager will be set to a new instance of MigLayout

  - an inline series of items and constraints--each item may be followed
    by zero or more constraints.

Item:

  - An item is either a Component or one of the keywords :layout
   :column or :row. Constraints for a keyword item affect the entire
    layout.

Constraint: string, keyword, vector, map, or set

  - A string specifies one or more constraints each with zero or more
    arguments.
  - A keyword specifies a single constraint without arguments
  - A vector specifies a single constraint with one or more arguments
  - A map specifies one or more constraints as keys, each mapped to a
    single argument
  - A set groups two or more constraints, each a string, keyword,
    vector, map, or set

Any items marked with an "id" constraint will be included in a map from
id to component attached to the container. The map can be retrieved using
clojure.contrib.miglayout/components.</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout.clj#L37" id="var-source">Source</a>
</div>
<h2 id="namespace-name">miglayout.internal</h2>
<pre id="namespace-docstr"></pre>


<br />
<div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/add-components">add-components</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (add-components container components)
</pre>
  <pre id="var-docstr">Adds components with constraints to a container</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L94" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/component?">component?</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (component? x)
</pre>
  <pre id="var-docstr">Returns true if x is a java.awt.Component</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L59" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/constraint?">constraint?</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (constraint? x)
</pre>
  <pre id="var-docstr">Returns true if x is not a keyword-item or component</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L64" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/do-layout">do-layout</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (do-layout container layout column row components)
</pre>
  <pre id="var-docstr">Attaches a MigLayout layout manager to container and adds components
with constraints</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L114" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/format-constraint">format-constraint</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (format-constraint c)
</pre>
  <pre id="var-docstr">Returns a vector of vectors representing one or more constraints
separated by commas. Constraints may be specified in Clojure using
strings, keywords, vectors, maps, and/or sets.</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L32" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/format-constraints">format-constraints</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (format-constraints &amp; constraints)
</pre>
  <pre id="var-docstr">Returns a string representing all the constraints for one keyword-item
or component formatted for miglayout.</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L47" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/get-components">get-components</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (get-components container)
</pre>
  <pre id="var-docstr">Returns a map from id to component for all components with an id</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L109" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/parse-component-constraint">parse-component-constraint</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (parse-component-constraint constraint)
</pre>
  <pre id="var-docstr">Parses a component constraint string returning a CC object</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L88" id="var-source">Source</a>
</div><div id="var-entry">
  <hr />
  <h2 id="clojure.contrib.miglayout.internal/parse-item-constraints">parse-item-constraints</h2>
  <span id="var-type">function</span><br />
  <pre id="var-usage">Usage: (parse-item-constraints &amp; args)
</pre>
  <pre id="var-docstr">Iterates over args and builds a map containing values associated with
:keywords and :components. The value for :keywords is a map from keyword
items to constraints strings. The value for :components is a vector of
vectors each associating a component with its constraints string.</pre>
  
  
  <a href="https://github.com/clojure/clojure-contrib/blob/b8d2743d3a89e13fc9deb2844ca2167b34aaa9b6/src/main/clojure/clojure/contrib/miglayout/internal.clj#L71" id="var-source">Source</a>
</div>


</div>
              </div>
            </div>
          </div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2010 by Rich Hickey and the various contributors</div>
</div>
      </div>
      <div id="DesignedBy">Logo &amp; site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
      Clojure auto-documentation system by Tom Faulhaber.</div>
    </div>
    <!-- /AllContentContainer -->
  </body>

</html>
Something went wrong with that request. Please try again.