Home >> All

•	uic.anttask.* (1)	•	uic.layout.* (8)	•	uic.model.* (11)	•	uic.output.* (69)
•	uic.pjava.* (16)	•	uic.tests.* (1)	•	uic.themeconfig.* (8)	•	uic.themes.* (24)
•	uic.widgets.* (43)

• ui: Javadoc index of package ui.


Package Samples:

• uic.output.swing: Package that contains classes for the convertion from the QtDesigner files to usable user interfaces.  
• uic.output.builder: Package that contains classes for the convertion from the QtDesigner files to usable user interfaces.  
• uic.widgets.event: Swing Widgets for your programming pleasure!  
• uic.model
• uic.pjava.theme
• uic.pjava
• uic.pjava.widgets.table
• uic.pjava.widgets
• uic.pjava.widgets.tabbedpane
• uic.tests
• uic.layout
• uic.output
• uic.output.pjava
• uic.themes
• uic.anttask
• uic.widgets
• uic.themeconfig

Classes:

• UICompiler: The class that allows you to compile ui files into java files from ant. Since this class will only be usefull from ant, this javadoc will only discuss ant options. Before asking questions; always refer to the ant manual first. Before you start ant; make sure this class (in the form of the uic.jar) is in the classpath of ant. Read that again; ant needs uic.jar in its classpath! In ant you need 2 parts; the first is to define the uicompile task in this form: <path id="uicompiler.classpath"> <pathelement path="jars/uic.jar"/> <pathelement path="${jdomjar}/> </path> <taskdef name="uicompiler" ...
• Translate: Translate is a class that you can use to translate the texts on a GUI. To make a gui change for a different language all you need to do is change the texts on widgets like labels and buttons. If you use UICompiler to build your GUIs the strings will automatically use this class to find out if the current locale needs different strings on screen. So; how does that work; First, find out what translating means by checking the introduction to internationalisation here [java.sun.com] Your GUI has strings that are hardcoded in the java file that shows them; this is a standard approuch that most application ...
• Translate: Translate is a class that you can use to translate the texts on a GUI. To make a gui change for a different language all you need to do is change the texts on widgets like labels and buttons. If you use UICompiler to build your GUIs the strings will automatically use this class to find out if the current locale needs different strings on screen. So; how does that work; First, find out what translating means by checking the introduction to internationalisation here [java.sun.com] Your GUI has strings that are hardcoded in the java file that shows them; this is a standard approuch that most application ...
• ActionFactory: ActionFactory builds actions and keeps them referenced so you can easily enable/disable them. Creating the menu and toolbar parts of a new Gui exitst from two steps; first you have to register all the actions your application supports, and next you have to provide an rc file that contains the structure of the GUI. Registering actions can be done with addAction or addSpecialAction. // in constructor of class extending JFrame actionFactory = new ActionFactory(); actionFactory.addSpecialAction("file_new", this, "fileNewSlot"); actionFactory.addAction("context_new", this, "insertContextSlot", i18n("new ...
• UICWizard: The UICWizard class provides a framework for wizard dialogs. A wizard is a special type of input dialog that consists of a sequence of dialog pages. A wizard's purpose is to walk the user through a process step by step. Wizards are useful for complex or infrequently occurring tasks that people may find difficult to learn or do. UICWizard provides page titles 55 and displays Next, Back, Finish, Cancel buttons, depending on the current position in the page sequence. Extend or simply populate the wizard by adding pages using addPage 55 and insertPage 55 . You can adjust the page sequence by setting ...
• StandardDialog: A replacement for all your usages of JDialog. This class provides a dialog for your panel, including a set of buttons and all the things you would normally manually configure in JDialog. Below two examples of a standard dialog with a selection of buttons OK/Apply/Cancel dialog OK/Cancel with Defaults Simple usage: FontSelection content = new FontSelection(selected); StandardDialog diag = new StandardDialog(parent, "Select font", StandardDialog.OK_CANCEL); diag.setComponent(content); if(diag.show() == StandardDialog.BUTTON_OK) { return content.getFont(); } return selected; The StandardDialog also ...
• UICFocusTraversalPolicy: A focus traversalPolicy for predefined traversal. The concept of focustraversal means that changing the focus (which widget receives keyboard input) using the TAB key follows a defined order of widgets. This class allows you to set the order to a list where each member is added using the addComponent(Component c) method. Notice that this class uses a Swing concept introduced in Java version 1.4 which means this class will not compile with older versions of Java. Common usage: myJPanel.setFocusCycleRoot(true); // if the component is not a normal root // then we need to do this in order to make sure ...
• NaturalLayout: NaturalLayout is a layout manager that arranges components in rows and columns like a spreadsheet. NaturalLayout allows each row or column to be a different size. A row or column can be given an absolute size in pixels, or it can grow and shrink according to the widgets that are contained. Using spreadsheet terminology, a cell is the intersection of a row and column. Cells have finite, non-negative sizes measured in pixels. The dimensions of a cell depend solely upon the dimensions of its row and column. A component occupies a rectangular group of one or more cells. If the component occupies more ...
• ToolBarContainer: This ToolBarContainer is a Container that allows a number of Toolbars to be present at a certain side of the screen. The Swing Tutorials describe ways to add only one Toolbar per side of the screen, and its quite hard to actually add a toolbar correctly, this class is suppost to make it easy. The simplest way of using the container is like this: JFrame myFrame = new JFrame(); ToolBarContainer top = new ToolBarContainer(myFrame, SwingConstants.TOP); JToolBar fileTools = new JToolBar("File"); // add some buttons to the fileTools toolbar. top.add(fileTools); Note that at any time you can still add ...
• TableRowSorter: A sorter for TableModels. The sorter has a model (conforming to TableModel) and itself implements TableModel. TableRowSorter does not store or copy the data in the TableModel, instead it maintains an array of integers which it keeps the same size as the number of rows in its model. When the model changes it notifies the sorter that something has changed eg. "rowsAdded" so that its internal array of integers can be reallocated. As requests are made of the sorter (like getValueAt(row, col) it redirects them to its model via the mapping array. That way the TableRowSorter appears to hold another copy ...
• UICTable: A replacement for the JTable to make the programmers life a lot easier. This table uses various settings by default that makes your table look quite finished without any tweaking. On top of that the table provides tooltips per row and provides getters for the various models a table uses, which tend te get quite confusing in the original JTable. Specific changes; Use columns that are sized to fit Disable features you probably never used, but got confused when you accedently did. Made the table rows indent and coloring consistent and overall nice. Add a table sorter by default Add a keylistener by ...
• WorkerThread: This is a helper class for the Actions framework. The basic job of this class is to queue and execute jobs added to it via the action framework. The long explenation is (still very short) that in Swing you need to seperate long running actions that started due to button pressed into a separate thread to limit freezing GUIs. We do this automatically in the ActionFactory by means of placing the jobs that need to be done in a queue to be executed as soon as possible. The placing itself does not take time, allowing the repainting to continue on its way. This class is the one that queues the jobs and ...
• ScrollWheelHelper: Helper class to allow various themes to use the scrollWheel in a backward compatible manner. ScrollWheel support has been added in Java in release 1.4, so in order to keep our theme backwards compatible we provide an extra class to do the event handling for us and deliver the result as a method call back to us. The common way to use this is: try { new ScrollWheelHelper(c, this, "mouseWheelSlot"); } catch(Throwable t) { } public void mouseWheelSlot(int rotation, int units) { The try catch is used to fail silently when the technology to do scrollwheels is not available. For instance when we use JRE ...
• Constraints: In finding a place in the grid of the NaturalLayout you can add a Constraints object add adding the widget to the parent. JPanel parent = new JPanel(new NaturalLayout(10, 10)); parent.add(myChildWidget, new Constraint("0,0"); The different constructors in this class will give you more hints to the options you have. The most convenient method of adding a widget is using the constructor that takes a formatted String. You can even leave away the invocation of a new Constraints object so your add could look like: parent.add(myChildWidget, "1,0, 2,0");
• TranslationInterface: Any translations framework that implements this interface can work with the generated classes from UIC. All classes generated by the UICompiler framework will automatically have i18n (aka internationalisation) included. The default translator will be good enough for almost all users, but to allow other translations frameworks to be used with minimal effort, the UICompiler translator classes use this interface. Implement this interface on your preferred translator and you are free to return that in the extending class. All you need to do is reimplement the translate() method call.
• SplashScreen: A Splash screen that will show a picture and possibly a progressbar. The splash screen is written for speed; on my 800 mHz machine it takes less then a second for this splas to be visible. Positioning of the splash is in the center of the current screen (choosing the active monitor on a multi screen setup). The image can be any format the respective JRE supports using ImageIO, using the latter immidiately also means this splashscreen only works with JRE 1.4 and later. Use the Splash superclass which needs an Image, but is usable on JRE 1.2 and later.
• MainWindow: MainWindow is the application window for any application you will create. In the Single Document Interface (which surpasses the Mutiple Document Interface) way of working every MainWindow equals one document. To create a new application you can instanciate a new MainWindow class and put your content in it followed by a call to show() Details like window positioning and size can be ignored, the MainWindow takes care of that. Notice that closing (the last) main window will exit java automatically.
• HSVSelector: This widget provides a color selection panel. This panel draws a HSV (aka HSB) style color selection area and allows the user to click for selection. A 'propertyChange' event is fired when the user made a selection. You can subscribe to all propertychange signals and use the HSVSelector.SIGNALNAME to filter only the relevant ones. Notice that all colors provided in the API are in default Color objects, which tend to be RGB.
• OutputterInterface: Each outputer has to implement this interface to be pluggable into UIC. An Outputter is the one that interprets the structure build according to the plugins after reading the input file. The Outputter decides what do to with the output; so far a Instanciator and JavaFileWriter have been created. The outputter has to make sure he does not alter the contents of the builder in his run, another outputter may be run afterwards.
• UICAction: This action class contains all the information to provide high quality widgets and an action. The idea behind an action is that one object wraps a certain functionality. Like a print action. Creating an action and using it with the ActionFactory creates widgets like buttons or menu entries. When your users click the button or select the menu item the action will be informed and a method of your choosing will be invoked.
• ExtraWindow: This class represent a so-called Extra Window. An extra window is a top-level window that contains information you could normally use a non-modal dialog for. The difference with this one is that the ExtraWindow has a distinct look and is therefor falls into a catagory of its own. Other features include the window manager function that allow you to save the former position, logical scaling and positioning is automatically done.
• UICRestrictedDocument: A document which you can set on things like a JTextField or JTextArea which limits input the specified chars. Example which only takes integers as the argument; all others will be rejected: tfMxSize = new UICTextField(); tfMxSize.setDocument(new UICRestrictedDocument(UICRestrictedDocument.CHARSET_INTEGERS));
• Splash: A Splash screen that will show a picture and possibly a progressbar. The splash screen is written for speed; on my 800 mHz machine it takes less then a second for this splas to be visible. Positioning of the splash is in the center of the current screen (choosing the active monitor on a multi screen setup).

Home | Contact Us | Privacy Policy | Terms of Service