/** * Stops this controller. This controller has to remove any resources * it uses and has not to be useful any further.<br> * This method should no be called by clients */ @FrameworkOnly public abstract void kill(); }
/** * Gets the control which is responsible for this dockable. Clients * should not use this method unless they know exactly what they are doing. * @return the control */ @FrameworkOnly public CControlAccess getControlAccess();
/** * Gets the unique identifier that has been assigned to this {@link CDockable} by the {@link CControl}. Every * dockable has a unique identifier, but it may not be the same identifier as set by this client. * @return the unique identifier, it is set once this dockable is added to a {@link CControl} */ @FrameworkOnly protected String getDockableUniqueId(){ return uniqueId; }
/** * Gets the Combiner for <code>station</code>.<br> * This method should not be used directly, instead an {@link UIValue} of type {@link StationCombinerValue} should * be installed at the local {@link ThemeManager} to retrieve the value. * @param station the station whose combiner is searched * @return a combiner for <code>station</code> */ @FrameworkOnly public Combiner getCombiner( DockStation station );
/** * A combination of {@link SharingDropDownItemAction} and {@link CommonDecoratableDockAction}, this interface * does not add any new methods or fields.<br> * {@link DockAction}s used by the {@link CDropDownItem} must implement this interface. * @author Benjamin Sigg */ @FrameworkOnly public interface CommonDropDownItem extends SharingDropDownItemAction, CommonDecoratableDockAction{ }
/** * Tells whether all children of this area are considered to be normalized. Clients should not * override this method.<br> * Note that if this method returns <code>false</code>, then the default {@link CSplitDockStationHandle} returned * by {@link #getModeManagerHandle()} will fail, clients <b>must</b> provide a custom implementation of * {@link CSplitDockStationHandle} if they override this method. * @return whether the children are normalized per default */ @FrameworkOnly protected boolean isNormalizingArea(){ return true; }
/** * Access to the object that represents <code>this</code> as {@link CNormalModeArea} and as * {@link CMaximizedModeArea}. * @return a representation of <code>this</code> as area */ @FrameworkOnly protected CSplitDockStationHandle getModeManagerHandle(){ return modeManagerHandle; }
/** * Informs this station by which perspective it is used. * @param perspective the perspective that uses this station or <code>null</code> */ @FrameworkOnly public void setPerspective( CPerspective perspective );
/** * Gets the control which is responsible for this dockable. Clients * should not use this method unless they know exactly what they are doing. * @return the control */ @FrameworkOnly public CControlAccess getControlAccess();
/** * Sets the group to which this button belongs. * @param group the group */ @FrameworkOnly void setGroup( CRadioGroup group ) { this.group = group; } }
/** * A combination of {@link SharingSelectableDockAction} and {@link CommonDockAction}, does not add * any new methods or fields.<br> * This is the interface a {@link DockAction} must implement if used by {@link CSelectableAction}. * @author Benjamin Sigg */ @FrameworkOnly public interface CommonSelectableAction extends CommonDropDownItem, SharingSelectableDockAction{ }
/** * Gets the {@link Span}s that are currently used by this {@link Leaf}. This method should not be called * by clients. * @return the spans, can be <code>null</code> */ @FrameworkOnly public Span[] getSpans(){ return spans; }
/** * Called if a {@link Span} of this node changed its size */ @FrameworkOnly public abstract void onSpanResize(); }
/** * Stops this FocusController. This controller will remove all * its listeners and become ready for the garbage collector.<br> * This method should not be called by clients. */ @FrameworkOnly public void kill(); }
/** * Gets the unique identifier that has been assigned to this {@link CDockable} by the {@link CControl}. Every * dockable has a unique identifier, but it may not be the same identifier as set by this client. * @return the unique identifier, it is set once this dockable is added to a {@link CControl} */ @FrameworkOnly protected String getDockableUniqueId(){ return uniqueId; }
/** * A combination of {@link SharingDropDownItemAction} and {@link CommonDecoratableDockAction}, this interface * does not add any new methods or fields.<br> * {@link DockAction}s used by the {@link CDropDownItem} must implement this interface. * @author Benjamin Sigg */ @FrameworkOnly public interface CommonDropDownItem extends SharingDropDownItemAction, CommonDecoratableDockAction{ }
/** * The combination of a {@link CommonDockAction} and a {@link SharingStandardDockAction}, does not introduce * any new methods or fields.<br> * This is the interface any {@link DockAction} that is used by a {@link CDecorateableAction} must implement. * @author Benjamin Sigg */ @FrameworkOnly public interface CommonDecoratableDockAction extends CommonDockAction, SharingStandardDockAction{ }
/** * Stops this controller. This controller has to remove any resources * it uses and has not to be useful any further.<br> * This method should no be called by clients */ @FrameworkOnly public abstract void kill(); }
/** * Gets the {@link Span}s that are currently used by this {@link Leaf}. This method should not be called * by clients. * @return the spans, can be <code>null</code> */ @FrameworkOnly public Span[] getSpans(){ return spans; }
/** * Gets a selector for {@link Dockable}s. This method should not be invoked directly, instead * the property key {@link #DOCKABLE_SELECTION} should be used. * @param controller the controller for which the selector will be used * @return the selector */ @FrameworkOnly public DockableSelection getDockableSelection( DockController controller ); }